beel_test_webhook_subscription
Send a synthetic, signed test payload to a webhook subscription to verify endpoint reachability and delivery handling before relying on real events.
Instructions
Sends a synthetic payload to the subscription's URL immediately, outside the normal delivery queue. Use it to verify that your endpoint is reachable and handles deliveries correctly before you rely on real events.
The payload carries "test": true and synthetic data, and is signed like any other
delivery, so it also verifies your signature check. It is not retried on failure and
does not appear in the delivery history.
Repeating the call with the same Idempotency-Key returns the cached result without
sending the test payload again.
Endpoint: POST /v1/accounts/{account_id}/webhooks/{webhook_id}/test
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| account_id | Yes | Your own account, or an account you provisioned. It — not the credential, and not the `BeeL-Active-Company` header — decides which account the operation acts on. An account you do not reach answers `403`, and so does an account that does not exist, so the existence of somebody else's account is never disclosed. | |
| webhook_id | Yes | Subscription of the account in the path. A subscription of another account answers `404`, the same as one that does not exist: under the account resolved from `{account_id}` it simply is not there. | |
| idempotency_key | No | Optional idempotency key for this operation. Omit it and one is derived from the request itself, which makes a blind retry safe but also collapses a SECOND, deliberately identical operation into the first for 24 hours. Set it — to an order id, or anything unique per intended operation — whenever you mean to create something that may look identical to what you just created. |