Docs
Esc

Suggested

QuickstartGet started
Webhooks and signaturesMessaging
Create a messagemessages.create · POST /v1/accounts/{AC}/messages
RATE_LIMITED429 · Rate limit exceeded.
message.deliveredMessage resource
Contents

API reference

Webhooks

API reference descriptions are provided in English to preserve the exact published contract.

Redeliver a selection of retained events

POST/v1/accounts/{AC}/events/redeliver

postV1AccountsByAcEventsRedeliverSDK operation postV1AccountsByAcEventsRedeliver

Request body

  • eventSidsstring (EV… SID)[]Required
  • endpointSidstring (WH… SID)

Redeliver a retained event to its subscribed endpoints

POST/v1/accounts/{AC}/events/{EV}/redeliver

postV1AccountsByAcEventsByEvRedeliverSDK operation postV1AccountsByAcEventsByEvRedeliver

Send a retained event again, to every subscribed endpoint or to one with endpointSid.

Parameters

  • EVstring (EV… SID)Required

Request body

  • endpointSidstring (WH… SID)

List webhook deliveries for one retained resource

GET/v1/accounts/{AC}/webhook-deliveries

webhookDeliveries.listSDK operation getV1AccountsByAcWebhookDeliveries

Parameters

  • resourceSidstring (max 128 chars)queryRequired
  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query

List the event types a webhook endpoint can subscribe to

GET/v1/accounts/{AC}/webhook-event-types

webhookEventTypes.listSDK operation getV1AccountsByAcWebhookEventTypes

List customer webhook endpoints

GET/v1/accounts/{AC}/webhooks

webhooks.listSDK operation getV1AccountsByAcWebhooks

List your webhook endpoints with their verification and delivery state.

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query

Create a customer webhook endpoint

POST/v1/accounts/{AC}/webhooks

webhooks.createSDK operation postV1AccountsByAcWebhooks

Register an HTTPS endpoint for events. It receives nothing until verified. Needs a recent step-up (stepUpToken).

Request body

  • urlstring (uri, max 2048 chars)Required
  • apiVersionstring (pattern ^\d{4}-\d{2}-\d{2}$)
  • concurrencyCapinteger (1–256)
  • eventFiltersstring (max 128 chars)[]
  • stepUpTokenstring (max 256 chars)
  • timeoutMsinteger (1000–30000)

Fetch a customer webhook endpoint

GET/v1/accounts/{AC}/webhooks/{WH}

webhooks.retrieveSDK operation getV1AccountsByAcWebhooksByWh

Parameters

  • WHstring (WH… SID)Required

Update a customer webhook endpoint

PATCH/v1/accounts/{AC}/webhooks/{WH}

webhooks.updateSDK operation patchV1AccountsByAcWebhooksByWh

Change an endpoint's URL, event filters, timeout or concurrency.

Parameters

  • WHstring (WH… SID)Required

Request body

  • apiVersionstring (pattern ^\d{4}-\d{2}-\d{2}$)
  • concurrencyCapinteger (1–256)
  • eventFiltersstring (max 128 chars)[]
  • stepUpTokenstring (max 256 chars)
  • timeoutMsinteger (1000–30000)
  • urlstring (uri, max 2048 chars)

Disable a customer webhook endpoint

DELETE/v1/accounts/{AC}/webhooks/{WH}

webhooks.deleteSDK operation deleteV1AccountsByAcWebhooksByWh

Parameters

  • WHstring (WH… SID)Required

List webhook delivery history

GET/v1/accounts/{AC}/webhooks/{WH}/deliveries

webhooks.deliveries.listSDK operation getV1AccountsByAcWebhooksByWhDeliveries

Parameters

  • WHstring (WH… SID)Required
  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query
  • sortenumquery

    createdAt-createdAt

  • resourceSidstring (max 128 chars)query
  • eventIdstring (EV… SID)query

Retry queued or failed webhook deliveries, oldest first

POST/v1/accounts/{AC}/webhooks/{WH}/deliveries/retry

postV1AccountsByAcWebhooksByWhDeliveriesRetrySDK operation postV1AccountsByAcWebhooksByWhDeliveriesRetry

Parameters

  • WHstring (WH… SID)Required

Request body

  • deliverySidsstring (WD… SID)[]
  • stateenum

    pendingfailed

Fetch webhook delivery request and attempt history

GET/v1/accounts/{AC}/webhooks/{WH}/deliveries/{WD}

webhooks.deliveries.retrieveSDK operation getV1AccountsByAcWebhooksByWhDeliveriesByWd

Parameters

  • WHstring (WH… SID)Required
  • WDstring (WD… SID)Required

Redeliver a retained event without reprocessing its resource

POST/v1/accounts/{AC}/webhooks/{WH}/deliveries/{WD}/retry

postV1AccountsByAcWebhooksByWhDeliveriesByWdRetrySDK operation postV1AccountsByAcWebhooksByWhDeliveriesByWdRetry

Parameters

  • WHstring (WH… SID)Required
  • WDstring (WD… SID)Required

Read authoritative retained delivery totals

GET/v1/accounts/{AC}/webhooks/{WH}/delivery-summary

webhooks.deliverySummary.listSDK operation getV1AccountsByAcWebhooksByWhDeliverySummary

Parameters

  • WHstring (WH… SID)Required

Pause endpoint delivery

POST/v1/accounts/{AC}/webhooks/{WH}/pause

webhooks.pauseSDK operation postV1AccountsByAcWebhooksByWhPause

Parameters

  • WHstring (WH… SID)Required

Resume endpoint delivery

POST/v1/accounts/{AC}/webhooks/{WH}/resume

webhooks.resumeSDK operation postV1AccountsByAcWebhooksByWhResume

Parameters

  • WHstring (WH… SID)Required

End the signing-secret rotation overlap immediately

POST/v1/accounts/{AC}/webhooks/{WH}/secret/end-overlap

webhooks.secret.endOverlapSDK operation postV1AccountsByAcWebhooksByWhSecretEndOverlap

Expires the previous signing secret now. Deliveries stop carrying its v1= signature, so any integration still verifying with the old secret fails from this moment.

Parameters

  • WHstring (WH… SID)Required

Rotate the endpoint signing secret with overlap

POST/v1/accounts/{AC}/webhooks/{WH}/secret/rotate

webhooks.secret.rotateSDK operation postV1AccountsByAcWebhooksByWhSecretRotate

Issue a new signing secret. The old one keeps signing alongside it until expiresAt, so you can deploy the new one without dropping events.

Parameters

  • WHstring (WH… SID)Required

Request body

  • expiresAtstring (date-time)
  • stepUpTokenstring (max 256 chars)

Send a signed test.ping event

POST/v1/accounts/{AC}/webhooks/{WH}/test

webhooks.testSDK operation postV1AccountsByAcWebhooksByWhTest

Send a signed test.ping event to the endpoint and report how it answered.

Parameters

  • WHstring (WH… SID)Required

Verify endpoint ownership and activate delivery

POST/v1/accounts/{AC}/webhooks/{WH}/verify

webhooks.verifySDK operation postV1AccountsByAcWebhooksByWhVerify

Parameters

  • WHstring (WH… SID)Required