webhooks

Send a test webhook delivery using the webhook format currently configured. Only the creator or admin can trigger a test. (pay-authenticated access required)

Send a test webhook delivery

post/webhooks/test

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/webhooks/test
  • Auth: API key in header token

Request body

webhookIdstring required

The ID of the webhook to send a test delivery to

Example request

{
  "webhookId": "webhook_endpoint_id"
}

Response

Webhook test delivery result

statusstring required

Example response

{
  "status": "Success",
  "data": {
    "webhookId": "webhook_endpoint_id",
    "success": true,
    "responseCode": 200,
    "errorMessage": null,
    "durationMs": 184
  }
}

Changes

No recorded changes to this operation across all 50 revisions of this API.