API referenceWebhooks
Send a test event to an endpoint
POST
/webhook-endpoints/{id}/testQueues a webhook.test delivery to this endpoint alone, so you can confirm your receiver verifies the signature and answers 2xx without running an extraction. It is signed and logged exactly like a real event, and its data carries no ids — there is nothing to fetch. webhook.test is not a subscribable event type: any endpoint can receive one, so treat an unrecognised type as ACK-and-ignore rather than an error. 202 means enqueued, not delivered — read the result from GET /webhook-endpoints/{id}/deliveries.
Requires an API key with one of these roles: admin.
Authorization
bearerAuth AuthorizationBearer <token>
An API key created in Settings → API Keys.
In: header
Path Parameters
id*string
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/webhook-endpoints/497f6eca-6276-4993-bfeb-53cbbbba6f08/test"{ "data": { "status": "enqueued", "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c" }, "meta": { "requestId": "string", "timestamp": "string" }}