Webhooks

Test a webhook subscription

Sends a signed synthetic payload using the saved subscription configuration.

Required scope: webhooks:write

post/webhooks/{webhook_id}/test

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/webhooks/{webhook_id}/test
  • Auth: API key in header API-Key

Path parameters

webhook_idstring uuid required

Request body

event_typestring required

Response

The request has succeeded.

delivery_idstring required
successboolean required
response_codeinteger
response_bodystring
error_messagestring
duration_msinteger required
attempted_atstring date-time required

Changes

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