Skip to main content
Glama

create_webhook_endpoint

Idempotent

Create a webhook: name, public HTTPS URL, events (inbound.received, inbound.action.requested, inbound.action.completed, inbound.pages_ready, inbound.keywords_matched) and optional keyword rules (literal terms, any/all, exclusions). Active on save. Returns the whsec_ signing secret once; hand it only to the operator's secure configuration, never logs or mail content. Requires explicit user intent for the URL. Agent keys must use their own agent_id and environment; member keys may use agent_id:null for account scope. 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

TableJSON Schema
NameRequiredDescriptionDefault
urlYes
nameYes
rulesYes
agent_idYes
environmentYes
event_typesYes
idempotency_keyYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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"
      +]
  2. Added

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the annotations, the description discloses critical behavioral details: the webhook is active immediately on save, the whsec_ signing secret is returned only once and must be handled securely, idempotency_key reuse is required after uncertain mutations, and authorization follows the same bounded control plane as existing webhook endpoints. These details materially affect how the agent should invoke and handle results.

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?

The description is a dense paragraph, but every sentence carries material operational or security guidance. It is front-loaded with the core creation action and parameter overview, followed by important caveats. A slightly more structured layout or shorter sentences would improve readability, but nothing is wasted.

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?

Given seven required parameters, an output schema, and annotations, the description covers all essential context: authentication requirements, scope rules, secret-handling instructions, idempotency behavior, and a link to full documentation. An agent has what it needs to call the tool safely and correctly.

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

Parameters5/5

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

Schema description coverage is 0%, so the description carries the full burden of explaining parameters. It does so comprehensively: name, public HTTPS URL, event types, rules structure (literal terms, any/all, exclusions), agent_id/environment scoping, and idempotency_key semantics. This adds meaning beyond the raw schema and would allow an agent to construct a correct request.

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 clear, specific verb-resource pairing: 'Create a webhook' and then enumerates the exact fields and event types involved. This makes it immediately distinguishable from sibling update/test/rotate tools without needing to inspect schemas.

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 provides strong contextual guidance: it explains when creation is appropriate, emphasizes explicit user intent for the URL, distinguishes agent-key versus member-key scoping, and states the required webhook.manage permission. It does not explicitly name a sibling such as update_webhook_endpoint for modifications, but the create versus update distinction is clear from the tool name and description.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources