webhooks

Test Webhook Subscription

Send a synthetic test event to a webhook subscription.

Requires the webhooks:write scope on the API key.

post/v1/webhooks/{webhook_id}/test

Path parameters

webhook_idstring uuid required

ID of the webhook.

Successful Response

deliveredboolean required

Whether the receiver accepted the test payload.

errorstring nullable required

Failure reason when delivered is false.

No recorded changes to this endpoint across all 12 revisions of this API.