v3

OpenAPI 3.1.02026-07-2759128137.8 KB
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/{subscription_id}/test

Path parameters

subscription_idstring uuid required

ID of the subscription.

Response

Successful Response

deliveredboolean required

Whether the receiver accepted the test payload.

errorstring nullable required

Failure reason when delivered is false.