Create a new webhook for messages

Creates a new webhook that triggers on events from messages.

POST /v1/webhooks/messages

Create a new webhook for messages

cURL

curl --request POST \
  --url https://dev-public-api.openphone.dev/v1/webhooks/messages \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [],
  "url": "https://example.com",
  "label": "my webhook label",
  "resourceIds": [
    "PN1234"
  ],
  "status": "enabled",
  "userId": "US123abc"
}
'

201

{
  "data": {
    "id": "WHabcd1234",
    "userId": "US123abc",
    "orgId": "OR1223abc",
    "label": "my webhook label",
    "status": "enabled",
    "url": "https://example.com/",
    "key": "example-key",
    "createdAt": "2022-01-01T00:00:00Z",
    "updatedAt": "2022-01-01T00:00:00Z",
    "deletedAt": "2022-01-01T00:00:00Z",
    "events": [],
    "resourceIds": [
      "PN1234"
    ]
  }
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "description": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Body

application/json

events · enum<string>[] · required

Available options: message.received, message.delivered

url · string<uri> · required

The endpoint that receives events from the webhook.

Example:

"https://example.com"

label · string

Webhook's label

Example:

"my webhook label"

resourceIds · Option 1 · string[] Option 2 · string[]

The unique identifiers of the phone numbers associated with the webhook.

Pattern: ^PN(.*)$

Example:

["PN1234"]

status · enum<string> · default: enabled

The status of the webhook.

Available options: enabled, disabled

Example:

"enabled"

userId · string

The unique identifier of the user that creates the webhook. If not provided, default to workspace owner.

Pattern: ^US(.*)$

Example:

"US123abc"

Response

201

application/json

Created

data · object · required

Show child attributes