v1

latestOpenAPI 3.1.1Proprietary2026-07-245895107.9 KB

Webhooks

Search webhooks

Search for your webhooks.

get/webhooks

Query parameters

sidstring

Short ID

Example:callrsid

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.

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

Webhook status

Example:enabled

sort'created'

Sort by one field

order'asc' | 'desc'

Sort order (ascending or descending)

offsetinteger

Offset index (zero-based)

Search offset index (zero-based)

limitinteger

Limit search results

Example:20

Number of items to return

Response

Search results

offsetinteger required

Offset index (zero-based)

totalinteger required

hasMoreboolean required

Whether there are more results available

Example response

{
  "total": 20,
  "hits": [
    {
      "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"
    }
  ]
}