Properties
| Name | Type | Description |
|---|---|---|
| url | string | HTTPS endpoint URL that will receive webhook POST requests. |
| events | array | List of event types to subscribe to. |
| account_relationship | object | Which accounts this subscription receives events from. Defaults to `own`. Same field name and values as the `account_relationship` carried by every event envelope. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/beel-es/json-schema/beel-es-create-webhook-subscription-request-schema.json",
"title": "CreateWebhookSubscriptionRequest",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/beel-es-accountwebhooks-api-openapi.yml#/components/schemas/CreateWebhookSubscriptionRequest",
"type": "object",
"required": [
"url",
"events"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "HTTPS endpoint URL that will receive webhook POST requests."
},
"events": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/$defs/WebhookEventTypeEnum"
},
"description": "List of event types to subscribe to."
},
"account_relationship": {
"allOf": [
{
"$ref": "#/$defs/WebhookAccountRelationship"
}
],
"default": "own",
"description": "Which accounts this subscription receives events from. Defaults to `own`. Same field name and values as the `account_relationship` carried by every event envelope.\n"
}
},
"$defs": {
"WebhookAccountRelationship": {
"type": "string",
"enum": [
"own",
"managed",
"all"
],
"description": "Which accounts a subscription receives events from — the same vocabulary as the\n`account_relationship` field in every delivered event envelope. One term to ask for\nevents, the same term to route them on arrival.\n\n* `own` (default) — only your own account.\n* `managed` — only accounts you manage (accounts you provisioned). Whether you actually\n receive them also depends on the management relationship granting data visibility; a\n billing-only relationship does not.\n* `all` — both.\n\nA delivered event is always `own` or `managed` (never `all`): its\n`account_relationship`, alongside `account_id` and `account_external_ref`, tells you\nwhich account it belongs to.\n"
},
"WebhookEventTypeEnum": {
"type": "string",
"description": "Available webhook event types:\n- `invoice.issued` — Invoice issued and finalized\n- `invoice.email.sent` — Invoice sent by email\n- `invoice.pdf.generated` — The PDF of an invoice was (re)rendered, so any copy you cached\n is stale; fetch it again from the PDF endpoint\n- `invoice.voided` — Invoice voided\n- `recurring_invoice.paused` — A schedule stopped generating on its own (downgrade or a\n permanent generation failure); the invoice it was going to issue will not arrive\n- `invoice.schedule_failed` — A scheduled invoice could not be issued on its date and BeeL.\n gave up retrying; it stays in drafts and can be issued by hand once the cause is fixed\n- `verifactu.status.updated` — VeriFactu public status changed (see `VeriFactuSubmissionStatus`)\n- `account.claimed` — A provisioned account was claimed by its holder\n- `company.created` — A company was created inside a provisioned account\n- `representation.signed` — Fiscal representation signed for a NIF (production invoicing enabled)\n- `email_domain.verified` — A sending domain of the account became `VERIFIED`; sent once per transition\n- `email_domain.failed` — A sending domain of the account became `FAILED`; sent once per transition\n- `email_domain.removed` — A sending domain of the account was removed, with a `reason` (`EXPIRED`,\n `DELETED_BY_USER` or `DELETED_AT_PROVIDER`); sent once per removal\n\nThe `email_domain.*` events belong to the account: they are delivered only to its live\nendpoints, never to the account that manages it, and `company_id` and `nif` are not set (absent or `null`).\n\nThe `account.*` events are delivered only to the **provisioner** that created the\naccount; a subscription on any other account never receives them.\n",
"enum": [
"invoice.issued",
"invoice.email.sent",
"invoice.pdf.generated",
"invoice.voided",
"recurring_invoice.paused",
"invoice.schedule_failed",
"verifactu.status.updated",
"account.claimed",
"company.created",
"representation.signed",
"email_domain.verified",
"email_domain.failed",
"email_domain.removed"
]
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/beel-es-create-webhook-subscription-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.