Skip to main content
A webhook (whk_*) is a URL you register so Natural can send events to your server as they happen. To learn more, see Receive events.

Example

GET /webhooks/{webhookId}
The object is everything inside data. The field names below are relative to it: attributes.url is data.attributes.url in the response.

Fields

string
required
Resource type. Always webhook.
string
required
Webhook ID (whk_*).
object
required
The webhook’s details.
object
required
Related resources, each by type and ID.

Statuses

Events

This resource sends no webhook events.

Endpoint differences

These endpoints return the object with a difference:
  • POST /webhooks also returns the signingSecret, the only time it is shown.
  • POST /webhooks/{webhookId}/rotate-secret returns the new signingSecret, shown only this once, and previousSecretExpiresAt, when the old secret stops working.
  • POST /webhooks/{webhookId}/rotate-secret returns only the secret fields, not the whole webhook.

Errors

See the error codes these endpoints return.

Sandbox simulations

None.