Skip to main content
Glama
Sign In

mailbox.bot

by bot.mailbox
OverviewDiscussionsAdmin

update_webhook_endpoint

DestructiveIdempotent

Update name, URL, events, keyword rules or active/paused status with expected_revision. Do not redirect notifications without the operator's authorization. Agent/environment scope cannot be changed. Requires webhook.manage. Uses the same bounded control plane and tenant/agent/Live-Sandbox authorization as /api/v1/webhooks/endpoints. Reuse the exact idempotency_key and input after an uncertain mutation. Webhook docs: https://mailbox.bot/docs/webhooks.

Input Schema

NameRequiredDescriptionDefault
urlNoPublic HTTPS URL on port 443 (no credentials, fragment or private host) that receives the signed POSTs. Set or change it only on the operator's explicit instruction. Omit to keep the current value.
nameNoLabel shown in the dashboard and delivery log. Omit to keep the current value.
rulesNoUp to 10 keyword rules, each with a unique id: source (envelope, letter for the contents, or any), match (any or all), 1–20 terms and optional exclude_terms. inbound.keywords_matched fires when a rule matches. Omit to keep the current value.
statusNoactive or paused. Omit to keep the current value.
endpoint_idYesWebhook endpoint id (UUID) from list_webhook_endpoints.
event_typesNoEvents to deliver (1–32, unique). Inbound mail: inbound.received, inbound.action.requested, inbound.action.completed, inbound.pages_ready, inbound.keywords_matched. Outbound mail: mail.pending_approval, mail.submitted, mail.ready, mail.mailed, mail.delivered, mail.failed, mail.cancelled. Batches: batch.submitted, batch.completed, batch.partially_completed, batch.failed, batch.cancelled, batch.piece.scanned, batch.piece.confirmed. Omit to keep the current value.
idempotency_keyYesA new UUID for this one intent; reuse it only to retry the identical request.
expected_revisionYesThe endpoint's current revision from list_webhook_endpoints; a stale revision is refused so concurrent edits are never overwritten.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / event_types / description
      Previous value: -"Events to deliver (1–32, unique). Inbound mail: inbound.received, inbound.action.requested, inbound.action.completed, inbound.pages_ready, inbound.keywords_matched. Outbound mail: mail.pending_approval, mail.submitted, mail.ready, mail.mailed, mail.delivered, mail.failed, mail.cancelled. Batches: batch.submitted, batch.completed, batch.partially_completed, batch.failed, batch.cancelled. Omit to keep the current value."New value: +"Events to deliver (1–32, unique). Inbound mail: inbound.received, inbound.action.requested, inbound.action.completed, inbound.pages_ready, inbound.keywords_matched. Outbound mail: mail.pending_approval, mail.submitted, mail.ready, mail.mailed, mail.delivered, mail.failed, mail.cancelled. Batches: batch.submitted, batch.completed, batch.partially_completed, batch.failed, batch.cancelled, batch.piece.scanned, batch.piece.confirmed. Omit to keep the current value."
    • changedInput schema / properties / event_types / items / enum
      Previous value: -[
-  "inbound.received",
-  "inbound.action.requested",
-  "inbound.action.completed",
-  "inbound.pages_ready",
-  "inbound.keywords_matched",
-  "mail.pending_approval",
-  "mail.submitted",
-  "mail.ready",
-  "mail.mailed",
-  "mail.delivered",
-  "mail.failed",
-  "mail.cancelled",
-  "batch.submitted",
-  "batch.completed",
-  "batch.partially_completed",
-  "batch.failed",
-  "batch.cancelled"
-]New value: +[
+  "inbound.received",
+  "inbound.action.requested",
+  "inbound.action.completed",
+  "inbound.pages_ready",
+  "inbound.keywords_matched",
+  "mail.pending_approval",
+  "mail.submitted",
+  "mail.ready",
+  "mail.mailed",
+  "mail.delivered",
+  "mail.failed",
+  "mail.cancelled",
+  "batch.submitted",
+  "batch.completed",
+  "batch.partially_completed",
+  "batch.failed",
+  "batch.cancelled",
+  "batch.piece.scanned",
+  "batch.piece.confirmed"
+]
    • changedOutput schema / properties / result / properties / endpoint / properties / event_types / items / enum
      Previous value: -[
-  "inbound.received",
-  "inbound.action.requested",
-  "inbound.action.completed",
-  "inbound.pages_ready",
-  "inbound.keywords_matched",
-  "mail.pending_approval",
-  "mail.submitted",
-  "mail.ready",
-  "mail.mailed",
-  "mail.delivered",
-  "mail.failed",
-  "mail.cancelled",
-  "batch.submitted",
-  "batch.completed",
-  "batch.partially_completed",
-  "batch.failed",
-  "batch.cancelled"
-]New value: +[
+  "inbound.received",
+  "inbound.action.requested",
+  "inbound.action.completed",
+  "inbound.pages_ready",
+  "inbound.keywords_matched",
+  "mail.pending_approval",
+  "mail.submitted",
+  "mail.ready",
+  "mail.mailed",
+  "mail.delivered",
+  "mail.failed",
+  "mail.cancelled",
+  "batch.submitted",
+  "batch.completed",
+  "batch.partially_completed",
+  "batch.failed",
+  "batch.cancelled",
+  "batch.piece.scanned",
+  "batch.piece.confirmed"
+]
  2. Changed5 schema fields changed
    • changedInput schema / properties / event_types / description
      Previous value: -"Events to deliver (1–16, unique): inbound.received, inbound.action.requested, inbound.action.completed, inbound.pages_ready, inbound.keywords_matched. Omit to keep the current value."New value: +"Events to deliver (1–32, unique). Inbound mail: inbound.received, inbound.action.requested, inbound.action.completed, inbound.pages_ready, inbound.keywords_matched. Outbound mail: mail.pending_approval, mail.submitted, mail.ready, mail.mailed, mail.delivered, mail.failed, mail.cancelled. Batches: batch.submitted, batch.completed, batch.partially_completed, batch.failed, batch.cancelled. Omit to keep the current value."
    • changedInput schema / properties / event_types / items / enum
      Previous value: -[
-  "inbound.received",
-  "inbound.action.requested",
-  "inbound.action.completed",
-  "inbound.pages_ready",
-  "inbound.keywords_matched"
-]New value: +[
+  "inbound.received",
+  "inbound.action.requested",
+  "inbound.action.completed",
+  "inbound.pages_ready",
+  "inbound.keywords_matched",
+  "mail.pending_approval",
+  "mail.submitted",
+  "mail.ready",
+  "mail.mailed",
+  "mail.delivered",
+  "mail.failed",
+  "mail.cancelled",
+  "batch.submitted",
+  "batch.completed",
+  "batch.partially_completed",
+  "batch.failed",
+  "batch.cancelled"
+]
    • changedInput schema / properties / event_types / maxItems
      Previous value: -16New value: +32
    • changedOutput schema / properties / result / properties / endpoint / properties / event_types / items / enum
      Previous value: -[
-  "inbound.received",
-  "inbound.action.requested",
-  "inbound.action.completed",
-  "inbound.pages_ready",
-  "inbound.keywords_matched"
-]New value: +[
+  "inbound.received",
+  "inbound.action.requested",
+  "inbound.action.completed",
+  "inbound.pages_ready",
+  "inbound.keywords_matched",
+  "mail.pending_approval",
+  "mail.submitted",
+  "mail.ready",
+  "mail.mailed",
+  "mail.delivered",
+  "mail.failed",
+  "mail.cancelled",
+  "batch.submitted",
+  "batch.completed",
+  "batch.partially_completed",
+  "batch.failed",
+  "batch.cancelled"
+]
    • changedOutput schema / properties / result / properties / endpoint / properties / event_types / maxItems
      Previous value: -16New value: +32
  3. Changed8 schema fields changed
    • addedInput schema / properties / endpoint_id / description
      Added value: +"Webhook endpoint id (UUID) from list_webhook_endpoints."
    • addedInput schema / properties / event_types / description
      Added value: +"Events to deliver (1–16, unique): inbound.received, inbound.action.requested, inbound.action.completed, inbound.pages_ready, inbound.keywords_matched. Omit to keep the current value."
    • addedInput schema / properties / expected_revision / description
      Added value: +"The endpoint's current revision from list_webhook_endpoints; a stale revision is refused so concurrent edits are never overwritten."
    • addedInput schema / properties / idempotency_key / description
      Added value: +"A new UUID for this one intent; reuse it only to retry the identical request."
    • addedInput schema / properties / name / description
      Added value: +"Label shown in the dashboard and delivery log. Omit to keep the current value."
    • addedInput schema / properties / rules / description
      Added value: +"Up to 10 keyword rules, each with a unique id: source (envelope, letter for the contents, or any), match (any or all), 1–20 terms and optional exclude_terms. inbound.keywords_matched fires when a rule matches. Omit to keep the current value."
    • addedInput schema / properties / status / description
      Added value: +"active or paused. Omit to keep the current value."
    • addedInput schema / properties / url / description
      Added value: +"Public HTTPS URL on port 443 (no credentials, fragment or private host) that receives the signed POSTs. Set or change it only on the operator's explicit instruction. Omit to keep the current value."
  4. Changed5 schema fields changed
    • changedInput schema / properties / event_types / items / enum
      Previous value: -[
-  "inbound.received",
-  "inbound.scan_available",
-  "inbound.context_ready",
-  "inbound.rule_matched",
-  "inbound.action_completed",
-  "inbound.action_failed",
-  "mail.submitted",
-  "mail.ready",
-  "mail.mailed",
-  "mail.delivered",
-  "mail.failed",
-  "mail.cancelled",
-  "mail.pending_approval"
-]New value: +[
+  "inbound.received",
+  "inbound.action.requested",
+  "inbound.action.completed",
+  "inbound.pages_ready",
+  "inbound.keywords_matched"
+]
    • changedOutput schema / properties / result / properties / endpoint / properties / event_types / items / enum
      Previous value: -[
-  "inbound.received",
-  "inbound.scan_available",
-  "inbound.context_ready",
-  "inbound.rule_matched",
-  "inbound.action_completed",
-  "inbound.action_failed",
-  "mail.submitted",
-  "mail.ready",
-  "mail.mailed",
-  "mail.delivered",
-  "mail.failed",
-  "mail.cancelled",
-  "mail.pending_approval"
-]New value: +[
+  "inbound.received",
+  "inbound.action.requested",
+  "inbound.action.completed",
+  "inbound.pages_ready",
+  "inbound.keywords_matched"
+]
    • changedOutput schema / properties / result / properties / endpoint / properties / status / enum
      Previous value: -[
-  "pending_verification",
-  "active",
-  "paused"
-]New value: +[
+  "active",
+  "paused"
+]
    • removedOutput schema / properties / result / properties / endpoint / properties / verified_at
      Removed value: -{
-  "anyOf": [
-    {
-      "format": "date-time",
-      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
-      "type": "string"
-    },
-    {
-      "type": "null"
-    }
-  ]
-}
    • changedOutput schema / properties / result / properties / endpoint / required
      Previous value: -[
-  "name",
-  "url",
-  "agent_id",
-  "environment",
-  "event_types",
-  "rules",
-  "id",
-  "member_id",
-  "status",
-  "revision",
-  "verified_at",
-  "created_at",
-  "updated_at",
-  "last_delivery_at",
-  "last_http_status",
-  "failure_count",
-  "signing_key_prefix",
-  "previous_key_expires_at"
-]New value: +[
+  "name",
+  "url",
+  "agent_id",
+  "environment",
+  "event_types",
+  "rules",
+  "id",
+  "member_id",
+  "status",
+  "revision",
+  "created_at",
+  "updated_at",
+  "last_delivery_at",
+  "last_http_status",
+  "failure_count",
+  "signing_key_prefix",
+  "previous_key_expires_at"
+]
  5. Added

TDQS

A3.9/5.0
Behavior4/5

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

With destructiveHint and idempotentHint already declared, the description still adds genuine operational context: required permission scope, the shared control-plane/authorization model, concurrency via `expected_revision`, and the retry contract for `idempotency_key` after an uncertain mutation. It stops short of saying which fields are destructive to change (e.g. that a URL swap silently retargets all deliveries), which is the most important behavior for a destructive-hinted tool.

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

Conciseness4/5

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

Front-loaded with the field list, and each sentence carries actionable content (permission, immutability, idempotency, docs link). It is slightly cluttered by the internal API-path reference ('same bounded control plane ... as /api/v1/webhooks/endpoints'), which adds jargon without much decision value.

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

Completeness4/5

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

For an 8-parameter mutation with full schema coverage, an output schema, and rich annotations, the description covers permissions, concurrency, retry semantics, immutability, and a docs pointer — enough to call it correctly. The remaining gap is sibling disambiguation from `update_webhook`, plus a note on how to recover from a stale-revision refusal.

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 100%, so every parameter is already fully documented, including the 'omit to keep current value' semantics and the enum meanings. The description adds only a thin layer (concurrency intent, idempotency retry with the same input), which does not go meaningfully beyond the schema.

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

Purpose4/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 and enumerates the mutable fields (name, URL, event_types, rules, status), and it adds a negative scope statement (agent/environment scope is immutable). It does not distinguish itself from the sibling `update_webhook`, which appears alongside it and sounds nearly identical, so an agent still has to guess between the two.

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 gives real preconditions and exclusions: requires `webhook.manage`, cannot change agent/environment scope, and must not redirect notifications without operator authorization. What's missing is routing guidance — nothing says when to pick this versus `update_webhook` or `create_webhook_endpoint`.

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

All mailbox.bot toolsInspect
Try in Browser
Shareable, User-Owned Context BackendPeople, applications, and agents read, write, and coordinate together in one context lake. Reach it over MCP, a CLI, a Python SDK, or REST.fulcradynamics.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources