Send a test event now

POST /webhooks/{id}/test

Requires the businesses scope.

Delivers one synthetic webhook.test event immediately, regardless of the endpoint's event filter: how you wire up a Make/Zapier trigger without issuing anything. delivered says whether your endpoint answered 2xx.

Path parameters

Name	Type		Description
`id`	string	required	Webhook endpoint id.

Response

200: { "ok": true, … }

Field	Type		Description
`ok`	boolean	required
`delivered`	boolean	required	Your endpoint answered 2xx.
`delivery`	WebhookDelivery		One attempt-tracked event delivery. The wire envelope carries this row's `id`. Dedupe on it.

Errors: 400, 401, 403, 404, 429. Every failure answers { "error": …, "reason": … }. Branch on reason.

On this page

Path parameters Response

POST /webhooks/{id}/test

curl -X POST "$BASE/webhooks/$DOC_ID/test" \
  -H "X-Api-Key: $KEY"

const res = await fetch(`${BASE}/webhooks/${DOC_ID}/test`, {
  method: 'POST',
  headers: {
    'X-Api-Key': KEY,
  },
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)

import requests
res = requests.post(
    f"{BASE}/webhooks/{DOC_ID}/test",
    headers={"X-Api-Key": KEY},
)
data = res.json()

Set BASE to https://api.billos.co.il/v1 and KEY to your bk_live_… key, or a bk_test_… key to run it against the sandbox.

Manage your businesses, keys and webhooks in the BillOS Console.