Skip to main content
POST
/
v1
/
webhooks
cURL
curl --request POST \
  --url https://9dc2c77e6dbf.ngrok-free.app/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/webhook",
  "events": [
    "MESSAGE_RECEIVED",
    "MESSAGE_SENT"
  ],
  "headers": {
    "X-Custom-Header": "value"
  }
}
'
{
  "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "appId": "b1ffcd11-1d1c-5fg9-cc7e-7cc0ce491b22",
  "url": "https://example.com/webhook",
  "events": [
    "MESSAGE_CREATED",
    "MESSAGE_SENT"
  ],
  "headers": {
    "X-Custom-Header": "value"
  },
  "createdAt": "2021-08-01T00:00:00Z",
  "updatedAt": "2021-08-01T00:00:00Z"
}

Authorizations

​
Authorization
string
header
required

App API key (format: sk_live_app_* or sk_test_app_*) for app-level operations

Body

application/json
​
url
string<uri>
required

URL to send webhook events to

Example:

"https://example.com/webhook"

​
events
enum<string>[]
required

Events to trigger webhook. MESSAGE_RECEIVED fires when an inbound message is received, MESSAGE_SENT fires when an outbound message is sent.

Available options:
MESSAGE_RECEIVED,
MESSAGE_SENT
Example:
["MESSAGE_RECEIVED", "MESSAGE_SENT"]
​
headers
object

Custom headers to include in webhook requests

Example:
{ "X-Custom-Header": "value" }

Response

201 - application/json

Create a new webhook

​
id
string<uuid>
required

Webhook UUID

Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

​
appId
string<uuid>
required

App UUID

Example:

"b1ffcd11-1d1c-5fg9-cc7e-7cc0ce491b22"

​
url
string<uri>
required

URL to send webhook events to

Example:

"https://example.com/webhook"

​
events
string[]
required

Events that trigger this webhook

Example:
["MESSAGE_CREATED", "MESSAGE_SENT"]
​
headers
object
required

Custom headers included in webhook requests

Example:
{ "X-Custom-Header": "value" }
​
createdAt
string<date-time>
required

When the webhook was created

Example:

"2021-08-01T00:00:00Z"

​
updatedAt
string<date-time>
required

When the webhook was last updated

Example:

"2021-08-01T00:00:00Z"