v1

latestOpenAPI 3.0.32026-07-24235275.4 KB

Webhooks

Create webhook

Make an API call to this endpoint to subscribe to a webhook.

Events are a collection of strings of the following types:

sms.subscribed
sms.sent
sms.message_link_click
email.subscribed
email.unsubscribed
email.message_link_click
email.opened
custom_attribute.set

Event types are case sensitive.

All events included will be sent to the URL.

post/webhooks

Request body

urlstring

The destination url of the webhook

eventsstring[]

The list of events this webhook is subscribed to

Example request

{
  "url": "https://example.com/webhooks",
  "events": [
    "sms.sent",
    "phone.subscribed"
  ]
}

Response

Webhook has been created

idstring

The id of the installed webhook

urlstring

The destination url of the webhook

eventsstring[]

The list of events this webhook is subscribed to

typestring

The type of webhook; can be either INSTALLED or CREATOR

disabledAtstring

(optional) Date (YYYY-MM-DD hh:mm:ss) of when the webhook was deleted if it was deleted

Example response

{
  "id": "MjU6Q29tcGFueUFwcGxpY2F0aW9uV2ViaG9vazIy",
  "url": "https://example.com/webhooks",
  "events": [
    "sms.sent",
    "phone.subscribed"
  ]
}