post

POST /v2/webhooks/{webhook}/test — Send a test event

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Sends a synthetic test event of the specified type to the webhook's URL and records it with isTest: true in the delivery log.

Request body

FieldTypeRequiredDescription
eventTypestringEvent type to simulate (e.g. "order_created")

Response 200

{
  "success": true,
  "message": "OK",
  "statusCode": 200,
  "latencyMs": 142,
  "data": {
    "preview": "...\n(truncated preview of the endpoint's response body)",
    "contentType": "application/json",
    "contentLength": 128
  }
}

There is no webhookEvent object on this response — the test delivery is still recorded in the delivery log (isTest: true), retrievable via GET /v2/webhooks/{webhook}/getEvents, but it isn't returned inline here.

Response 400 (delivery failure)

{
  "success": false,
  "message": "Endpoint returned 503",
  "statusCode": 503,
  "latencyMs": 88,
  "data": {
    "preview": "...",
    "contentType": "text/plain",
    "contentLength": 42
  }
}
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!