Send a test event

POST/v1/webhook-endpoints/{id}/testRun

Requires webhooks:write permission.

Path parameters

idstringrequired

The id of the endpoint (whk_…).

Example: whk_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with whk_.

Request body

project_idstringoptional

Project to use for the test event. Required for a merchant-level endpoint; a project endpoint uses its configured project.

Example: prj_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with prj_.

Response (200)

dataobjectrequired

The returned object, or an array of objects for a list.

event_idstringrequired

The id of the test event that was queued.

Example: wev_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with wev_.

metaobjectrequired

Request details such as its id and pagination cursor.

request_idstringrequired

The id of this request. Quote it when you ask support about it.

Example: req_Hy3k9QzT2LmN8vXa

A failed request answers with the common error shape; see Errors.

Request

curl -X POST "https://api.baiyar.com/v1/webhook-endpoints/{id}/test" \
  -H "Authorization: Bearer $BAIYAR_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Response

{
  "data": {
    "event_id": "wev_01k7q3m8x2v5t9n4b6c1d0e7fa"
  },
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa"
  }
}