v1

latestOpenAPI 3.1.1Proprietary2026-07-245895107.9 KB

Webhooks

Update webhook

Update a webhook. You cannot change the endoint URL. To change the URL, create a new webhook.

patch/webhooks/{sid}

Path parameters

sidstring required

Short ID

Example:callrsid

Resource SID (8 lowercase alphanumeric characters)

Request body

status'disabled' | 'enabled' required

Webhook status (set by user)

Response

Webhook updated

sidstring required

Short ID

v2.billing.credit.topup = Your account has been credited with a new amount.
v2.billing.credit.warning = Your prepaid balance has reached its warning level.
v2.billing.credit.shutdown = Your prepaid balance has reached its shutdown level. Your account is suspended.
v2.call.inbound.started = An inbound call just started.
v2.call.inbound.ended = An inbound call just hung up.
v2.call.outbound.started = An outbound call just started.
v2.call.outbound.ended = An outbound call just hung up.
v2.number.assigned = A phone number was assigned to your account.
v2.number.unassigned = A phone number was unassigned from your account.
v2.task.updated = A task has been updated.
v2.audio-file.updated = An audio file has been updated.
v2.recording.updated = A recording has been updated.
v2.sms.inbound.received = An inbound SMS has been received.
v2.sms.outbound.updated = An outbound SMS has an updated status.

endpointstring uri required

status'disabled' | 'disabled-admin' | 'disabled-system' | 'enabled' required

Webhook status

failedinteger required

The number of times your endpoint did not respond to a webhook

lastfailedstring date-time

RFC 3339, section 5.6

createdstring date-time required

RFC 3339, section 5.6

updatedstring date-time required

RFC 3339, section 5.6

Example response

{
  "sid": "callrsid",
  "endpoint": "https://example.com",
  "status": "enabled",
  "options": {
    "hmac": {
      "algorithm": "sha512"
    }
  },
  "lastfailed": "2024-04-24T17:42:28Z",
  "created": "2024-04-24T17:42:28Z",
  "updated": "2024-04-24T17:42:28Z"
}