Webhooks

Send a test event

Requires scope: manage. Fires a synthetic webhook.test event at the endpoint and reports the delivery result.

post/v1/webhooks/{id}/test

Request

  • Base URL: https://api.mails.ai
  • URL: https://api.mails.ai/v1/webhooks/{id}/test
  • Auth: HTTP bearer

Path parameters

idstring required

Webhook endpoint id.

Response

The test delivery result.

webhook_endpoint_idstring required

The endpoint the test event was sent to: the id in the path. A paused endpoint is sent it too.

event_idstring required

Id of the webhook.test event that was sent (evt_…). It is stored with test_mode true, and GET /v1/events/{id} returns it.

delivery_idstring required

Id of this test's delivery record (whd_…), listed by GET /v1/webhooks/{id}/deliveries. A failed test is not retried.

okboolean required

True when the endpoint answered with a 2xx status.

http_statusinteger nullable

The status the endpoint answered with, after following up to 3 redirects. Null when no answer came: a connection error, no answer within 5 seconds, or an address that is not public.

response_excerptstring

The first 500 characters of the endpoint's response body; when no answer came, the reason instead.

Changes

No recorded changes to this operation across all 1 revision of this API.