Webhooks

Send a test event

Permission required: webhooks:write. Same signature, same headers, same log as a real event — and your service's response is AWAITED, so you know straight away. The body carries "data": { "test": true }.

post/api/v1/webhooks/{id}/test

Request

  • Base URL: https://mailcheer.com
  • URL: https://mailcheer.com/api/v1/webhooks/{id}/test
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Response

The test was attempted — read status.

object'webhook_test'
delivery_idstring
status'delivered' | 'pending' | 'failed'
attemptsinteger
response_statusinteger nullable
errorstring nullable

Changes

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