Webhooks

webhook_endpoint.test

Sent by POST /v1/webhook_endpoints/{id}/test, and before an endpoint disabled for failing is re-enabled. Answer 2xx; there is nothing else to do with it.

postWebhookwebhook_endpoint.test

Headers

Topkey-Signaturestring required

t=<unix>,v1=<hex>: see Verifying signatures in the Webhooks section of the introduction.

Payload

idstring required

evt_…. Delivery is at least once: dedupe on this.

object'event' required

api_version'v1' required

createdinteger required

When the change happened, in Unix seconds.

type'webhook_endpoint.test' required

The event type.

livemodeboolean required

false outside production.

pending_webhooksinteger required

Deliveries of this event not yet successful when this one was sent, this one included. Earlier failed deliveries count, so resending a failed one sends 2.

Response

Received. Anything else, including a redirect or no answer within 15 seconds, is a failure and is retried.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.