beel_create_webhook_subscription
Register an HTTPS endpoint to receive signed webhook notifications for selected invoice, VeriFactu, and account events. Includes a test delivery to verify your endpoint responds.
Instructions
Registers an HTTPS endpoint to receive notifications for the event types listed
in events.
secret: returned only in this response and never again. Store it before discarding the body; deliveries are signed with it and carry the signature in theBeeL-Signatureheader.test_delivery: a one-off signed delivery sent to your URL as part of creating the subscription, so you learn whether your endpoint answers without a second call. It is best effort: the subscription exists and is active whatever it says, and the field isnullwhen the test could not be run at all.account_relationship: which accounts the subscription receives events from —own(the default),managed, orall.Limits: an account holds at most 10 active subscriptions; creating an eleventh is rejected. Registering the same URL twice creates two subscriptions, and the endpoint then receives each event twice.
Endpoint: POST /v1/accounts/{account_id}/webhooks
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | ||
| 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. | |
| 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. |