v2

latestOpenAPI 3.1.0MIT2026-07-26105151330.5 KB
Webhooks

Test Webhook

Send a test event to a webhook endpoint to verify it is configured correctly. Returns the HTTP status code and response time. Requires API key with webhook:write.

post/v1/webhooks/{webhookId}/test

Path parameters

webhookIdstring required

Webhook ID (MongoDB ObjectId)

Response

Test result

successboolean required
errorstring nullable