Webhook Events

Test event

webhook.test: Sent by POST /v1/webhooks/{webhookId}/test to check that the endpoint receives and verifies deliveries.

Delivered as a POST to every active endpoint that subscribes to the event and whose profile access covers it. Delivery is at least once and events are not ordered, so deduplicate by id.

postWebhooktestEvents

Payload

idstring required

Event id (evt_…). Stable across automatic retries and manual redeliveries; deduplicate on it.

type'webhook.test' required

apiVersionstring required

Payload version.

createdAtstring date-time required

When the event was created.

Example payload

{
  "apiVersion": "2026-08-06"
}

Response

Acknowledges the delivery. Any other status, or no response within 10 seconds, schedules a retry.

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.