Skip to main content
Glama
beel-es

BeeL MCP server

Official
by beel-es
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

beel_create_webhook_subscription

Idempotent

Register an HTTPS endpoint to receive signed BeeL webhook notifications for chosen event types, returning the signing secret and a test delivery to verify your listener.

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 the BeeL-Signature header.

  • 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 is null when the test could not be run at all.

  • account_relationship: which accounts the subscription receives events from — own (the default), managed, or all.

  • Limits: an account holds at most 10 active subscriptions; creating an eleventh is rejected with 400 WEBHOOK_ACTIVE_SUBSCRIPTION_LIMIT_REACHED. 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

TableJSON Schema
NameRequiredDescriptionDefault
bodyYes
account_idYesYour 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_keyNoOptional 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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.9.0
    • changedInput schema / $defs / WebhookEventTypeEnum / description
      Previous value: -"Available webhook event types:\n- `invoice.issued` — Invoice issued and finalized\n- `invoice.email.sent` — Invoice sent by email\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- `verifactu.status.updated` — VeriFactu 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\nThe `account.*` events are delivered only to the **provisioner** that created the\naccount; a subscription on any other account never receives them.\n"New value: +"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\nThe `account.*` events are delivered only to the **provisioner** that created the\naccount; a subscription on any other account never receives them.\n"
    • changedInput schema / $defs / WebhookEventTypeEnum / enum
      Previous value: -[
-  "invoice.issued",
-  "invoice.email.sent",
-  "invoice.voided",
-  "recurring_invoice.paused",
-  "verifactu.status.updated",
-  "account.claimed",
-  "company.created",
-  "representation.signed"
-]New value: +[
+  "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"
+]
  2. Changed5 schema fields changedv0.5.0
    • addedInput schema / $defs / CreateWebhookSubscriptionRequest / additionalProperties
      Added value: +false
    • removedInput schema / $defs / CreateWebhookSubscriptionRequest / properties / events / example
      Removed value: -[
-  "invoice.issued",
-  "verifactu.status.updated"
-]
    • removedInput schema / $defs / CreateWebhookSubscriptionRequest / properties / url / example
      Removed value: -"https://yourapp.com/webhooks/beel"
    • changedInput schema / $defs / WebhookEventTypeEnum / description
      Previous value: -"Available webhook event types:\n- `invoice.issued` — Invoice issued and finalized\n- `invoice.email.sent` — Invoice sent by email\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- `verifactu.status.updated` — VeriFactu status changed (see `VeriFactuSubmissionStatus`)\n- `account.claimed` — A provisioned account was claimed by its holder\n- `company.created` — A NIF (company) was created inside a provisioned account\n- `representation.signed` — Fiscal representation signed for a NIF (production invoicing enabled)\n\nThe `account.*` events are delivered only to the **provisioner** that created the\naccount; a subscription on any other account never receives them.\n"New value: +"Available webhook event types:\n- `invoice.issued` — Invoice issued and finalized\n- `invoice.email.sent` — Invoice sent by email\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- `verifactu.status.updated` — VeriFactu 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\nThe `account.*` events are delivered only to the **provisioner** that created the\naccount; a subscription on any other account never receives them.\n"
    • addedInput schema / additionalProperties
      Added value: +false
  3. First observedv0.3.1

TDQS

A4.5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only supply the safety profile (readOnlyHint=false, idempotentHint=true, destructiveHint=false, openWorldHint=true). The description adds the critical one-time-return behavior of `secret`, the BeeL-Signature signing header, the best-effort and possibly-null `test_delivery`, and the hard subscription cap with its error code — none of which the annotations convey.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose sentence is front-loaded, and the bolded bullet headers (secret, test_delivery, account_relationship, Limits) let an agent skim to the detail it needs. Despite its length, every line carries operational information an agent cannot get from structured fields.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description carries the return-value burden and does so: it explains the one-time secret, the test-delivery result (including the null case), and the relationship field. Creation constraints, error codes, and duplicate-delivery consequences are all covered, so nothing needed to call this correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 67%, above the low-coverage threshold, and the description's account_relationship gloss ('own', 'managed', or 'all') largely restates the enum description already in the schema, as does its reference to the `events` list. It adds little syntax or format meaning for `url`, `account_id`, or `idempotency_key` beyond what the schema documents.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The first sentence names a specific verb and resource ('Registers an HTTPS endpoint to receive notifications') and scopes it to the event types in `events`, which cleanly separates it from beel_patch_webhook_subscription, beel_get_webhook_subscription, and beel_test_webhook_subscription. The trailing endpoint line (POST /v1/accounts/{account_id}/webhooks) confirms the operation unambiguously.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description supplies concrete usage context: the limit of 10 active subscriptions, the 400 WEBHOOK_ACTIVE_SUBSCRIPTION_LIMIT_REACHED rejection, and the consequence of registering the same URL twice. It never names an alternative tool or an explicit 'do not use this when' condition (e.g. to modify an existing subscription, use patch), so routing guidance is implied rather than stated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools