Sign in

v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-03269339953.6 KB
Mail: Webhooks

Test webhook

Send a test delivery to the webhook URL and return the result. Test requests are rate limited upstream.

post/api/mail/v1/webhooks/{webhookId}/test

Path parameters

webhookIdstring required
Example:019683f8-1234-7abc-8def-0123456789ab

Webhook ID (returned when the webhook was created)

Response

Success response

http_statusinteger

HTTP status code returned by the webhook endpoint

is_successfulboolean

Whether the test delivery was successful

errorstring nullable

Error message returned by the webhook endpoint in case of failure

Example response

{
  "http_status": 200,
  "is_successful": true,
  "error": "Something bad happened"
}