Skip to main content
Glama
beel-es

BeeL MCP server

Official
by beel-es

beel_patch_webhook_subscription

Update an existing webhook subscription's URL, subscribed events, active status, or account relationship while preserving unmentioned settings.

Instructions

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 to false stops 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.

  • Signing secret: not touched here. Rotate it with POST /v1/accounts/{account_id}/webhooks/{webhook_id}/secret.

Endpoint: PATCH /v1/accounts/{account_id}/webhooks/{webhook_id}

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.
webhook_idYesSubscription 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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv0.5.0
    • addedInput schema / $defs / UpdateWebhookSubscriptionRequest / additionalProperties
      Added value: +false
    • removedInput schema / $defs / UpdateWebhookSubscriptionRequest / properties / account_relationship / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/WebhookAccountRelationship"
      -  }
      -]
    • addedInput schema / $defs / UpdateWebhookSubscriptionRequest / properties / account_relationship / anyOf
      Added value: +[
      +  {
      +    "allOf": [
      +      {
      +        "$ref": "#/$defs/WebhookAccountRelationship"
      +      }
      +    ],
      +    "description": "New set of accounts this subscription receives events from. Same field name and values as the `account_relationship` carried by every event envelope.\n"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedInput schema / $defs / UpdateWebhookSubscriptionRequest / properties / account_relationship / description
      Removed value: -"New set of accounts this subscription receives events from. Same field name and values as the `account_relationship` carried by every event envelope.\n"
    • removedInput schema / $defs / UpdateWebhookSubscriptionRequest / 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
  2. First observedv0.3.1

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the annotations (readOnlyHint=false, destructiveHint=false, openWorldHint=true), the description adds material caveats: `events` replaces the whole list rather than appending, `active:false` preserves delivery history, and a subscription deactivated by BeeL requires a successful test delivery before reactivation. These behaviors are not derivable from the schema or annotations and are exactly what an agent needs to avoid mistakes.

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 description is compact, bulleted, and front-loaded with the most important semantic (partial update, untouched rest). Each bullet earns its place by documenting a non-obvious behavior, and the endpoint line provides useful routing context without fluff.

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?

For a mutation with no output schema, the description covers all user-facing behavior needed to call it correctly: field semantics, replacement semantics, reactivation rule, and secret-rotation pointer. The account_id/webhook_id 403/404 behaviors are already documented in the input schema, so no additional coverage is needed there.

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

Parameters4/5

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

With schema coverage at 67%, the description shoulders some of the parameter burden. It adds meaning for `events` (whole-list replacement, dropped events stop delivery) and `active` (off behaves non-destructively and has reactivation constraints). It does not repeat the rich `account_relationship` semantics already in the schema, which is appropriate, but it leaves `url` described only as 'updates', relying on the schema's 'New HTTPS endpoint URL.'

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 description opens with a specific verb and resource: 'Updates the fields present in the body' and lists the exact fields (`url`, `events`, `active`, `account_relationship`) while clarifying the partial-update behavior. The endpoint line ties it to PATCH /v1/accounts/{account_id}/webhooks/{webhook_id}, clearly distinguishing it from sibling create/delete/test/rotate operations.

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?

It provides explicit guidance for when not to use this tool for secret rotation, directing the agent to `POST /v1/accounts/{account_id}/webhooks/{webhook_id}/secret`. The patch-vs-create distinction is implied rather than explicitly stated, so an agent is not told 'use this instead of beel_create_webhook_subscription when the subscription already exists', but the overall usage context is clear.

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