Webhooks

Send a test delivery

Delivers a signed sample payload to the endpoint so you can confirm signature verification before real events arrive. It carries the same signature headers as a real delivery, X-Kawaa-Signature-V2 with the time of this send and the legacy X-Kawaa-Signature.

post/v1/webhooks/{id}/test

Request

  • Base URL: https://api.kawaa.com
  • URL: https://api.kawaa.com/v1/webhooks/{id}/test
  • Auth: one of:
    • API key in header X-Api-Key
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.kawaa.com/oauth/authorize, token URL https://api.kawaa.com/oauth/token, scopes: webhooks:write)

Path parameters

idstring required

Request body

eventstring

Which event's sample payload to send. Omitted, the FIRST event Kawaa defines (verification.completed) is used, not necessarily one this webhook is subscribed to, so a test with no body can exercise an event the endpoint never receives in practice. Explicit null and other non-string values are refused with 400; only omission selects the default. An unrecognised name is refused with 400 Invalid events: <name> (the same message create and update give), so a mistyped dmarc.failur fails loudly instead of delivering a verification.completed sample and reporting success. Legacy aliases (batch.completed, credits.depleted) resolve to their canonical names. The response's event field names whichever event was actually sent. Valid names come from GET /v1/webhooks/events.

Response

The delivery was ATTEMPTED. 200 does not mean it worked: branch on data.success.

successunknown required

Changes

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