v1

latestOpenAPI 3.1.1Proprietary2026-07-245895107.9 KB
Webhooks

Search webhook logs

Search for your webhook logs.

get/webhooks/logs

Query parameters

endpointstring uri
Example:https://example.com
atstring date-time

RFC 3339, section 5.6

Example:2024-04-24T17:42:28Z
idstring

Event ID

sidstring

Short ID

Example:callrsid

Webhook SID

httpcodeinteger
tryinteger
type'v2.billing.credit.topup' | 'v2.billing.credit.warning' | 'v2.billing.credit.shutdown' | 'v2.call.inbound.started' | 'v2.call.inbound.ended' | 'v2.call.outbound.started' | 'v2.call.outbound.ended' | 'v2.number.assigned' | 'v2.number.unassigned' | 'v2.task.updated' | 'v2.audio-file.updated' | 'v2.recording.updated' | 'v2.sms.inbound.received' | 'v2.sms.outbound.updated'
  • 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.
sort'at'

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": [
    {
      "id": "a03317440280451052hUD7yPiwWrzgGB",
      "at": "2024-04-24T17:42:28Z",
      "sid": "callrsid",
      "endpoint": "https://example.com",
      "httpCode": 200
    }
  ]
}