Update a webhook subscription (deprecated)
Scopewebhooks:writeDeprecated. Use PATCH /v1/accounts/{account_id}/webhooks/{webhook_id}, which behaves identically.
Updates the fields present in the body — url, events, active,
account_relationship — and leaves the rest untouched.
events: replaces the whole list, it does not add to it, so an event left out of it stops being delivered.active: setting it tofalsestops deliveries without discarding the delivery history. A subscription we turned off ourselves (deactivated_by: beel) needs a successful test delivery before it can be turned back on. Turning a subscription back on counts towards the limit of 10 active subscriptions, and is rejected with400WEBHOOK_ACTIVE_SUBSCRIPTION_LIMIT_REACHEDwhen ten are already active.- Signing secret: not touched here. Rotate it with
POST /v1/accounts/{account_id}/webhooks/{webhook_id}/secret.
Retires on 9 December 2026. See the migration guide for what moved where and what changes when you switch.
Keys are prefixed beel_sk_, and each one carries the scopes it was created with: a key
short of the scope an operation needs is answered 403. The scope an operation requires
is shown next to its title, and the full catalogue lives in the Scopes reference.
Keys are created from the BeeL dashboard. They are secret credentials: do not share them or commit them to source control.
In: header
Path Parameters
uuidNew HTTPS endpoint URL.
uriNew list of event types to subscribe to.
1 <= itemsEnable or disable the webhook subscription.
"own" | "managed" | "all"Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://app.beel.es/api/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{
"success": true,
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"url": "http://example.com",
"events": [
"string"
],
"active": true,
"account_relationship": "own",
"deactivated_by": "owner",
"deactivated_at": "2019-08-24T14:15:22Z",
"last_error": "string",
"last_error_cause": "dns",
"consecutive_failures": 0,
"last_used_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request"
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication is required to access this resource"
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "You do not have permission to access this resource"
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}{
"success": false,
"error": {
"code": "INVOICE_NOT_FOUND",
"message": "Invoice not found"
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}{
"success": false,
"error": {
"code": "URL_TARGET_NOT_ALLOWED",
"message": "The webhook URL points to an internal network address. Use an endpoint reachable from the internet."
},
"meta": {
"timestamp": "2026-03-07T16:22:10Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}{
"success": false,
"error": {
"code": "UNSUPPORTED_MEDIA_TYPE",
"message": "Unsupported media type: text/plain. Supported: application/json"
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}Get a webhook subscription (deprecated) GET
**Deprecated.** Use `GET /v1/accounts/{account_id}/webhooks/{webhook_id}`, which behaves identically. Returns a single webhook subscription. The signing secret is never included. **Retires on 9 December 2026.** See the [migration guide](https://docs.beel.es/changelog/resources-under-the-nif) for what moved where and what changes when you switch.
Delete a webhook subscription (deprecated) DELETE
**Deprecated.** Use `DELETE /v1/accounts/{account_id}/webhooks/{webhook_id}`, which behaves identically. Permanently deletes a webhook subscription. No further events are delivered to its URL. To stop deliveries reversibly, set `active` to `false` instead. **Retires on 9 December 2026.** See the [migration guide](https://docs.beel.es/changelog/resources-under-the-nif) for what moved where and what changes when you switch.