Skip to main content
POST
/
v1
/
webhooks
/
{id}
/
test
Send a test webhook event
curl --request POST \
  --url https://api.ledger.so/v1/webhooks/{id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "event": "customer.created",
    "payload": {
      "id": "cus_test123",
      "type": "individual",
      "status": "active"
    }
  }
}
'
{
  "ok": true,
  "data": {
    "delivered": true,
    "httpStatus": 200
  }
}

Authorizations

​
Authorization
string
header
required

API key passed as a Bearer token. Format: ld_<env>_<prefix>_<secret> where <env> is test or live.

Path Parameters

​
id
string
required

The webhook ID (prefixed with whk_).

Example:

"whk_bcd890"

Body

application/json
​
data
object
required

Arbitrary event payload to send as a test. Structure it like a real webhook event for the most accurate test.

Response

Test event sent successfully

​
ok
boolean
required

Indicates the request was successful.

​
data
object