Sign in

v1

latestOpenAPI 3.0.32026-07-24235275.4 KB
Webhooks

Update webhook

Make an API call to this endpoint to update a webhook

put/webhooks/{webhookId}

Path parameters

webhookIdstring required

The id of the webhook to update

Request body

urlstring

The destination url of the webhook

eventsstring[]

The list of events this webhook is subscribed to

disabledboolean

(optional) Disable the webhook endpoint if set to true.

Example request

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

Response

Webhook has been updated

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"
  ]
}