Webhooks

Send test webhook

Send a test webhook to verify your endpoint is configured correctly. The test payload includes event: "webhook.test" to distinguish it from real events.

webhook.test belongs to the webhooks resource group, so a key with that group disabled is rejected with 403, as is a test fire on a subscription that lists webhooks in its own disabledResourceGroups (a 403, not a reported delivery failure). Replays of real events (redelivery, dead-letter requeue) run the same checks as live delivery, against both the key's groups and the subscription's.

post/v1/webhooks/test

Request body

webhookIdstring required

ID of the webhook to test

Response

Test webhook sent successfully

successboolean
messagestring

Changes

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