Skip to main content
Glama

Create Webhook

create_webhook

Create an incoming webhook for a room the account owns. The bound account must be Pro. Returns the secret trigger URL — treat it as a credential.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
iconNoA v3 room-icon catalog id, e.g. "bell". Call list_room_icons to discover the valid ids.
nameYesWebhook name (shown to the owner).
colorNoHex color, e.g. "#e33122".
soundNoCanonical sound id, e.g. "ting". Omit for the room default.
titleNoOptional push title used when the webhook fires.
enabledNoWhether the webhook is active. Defaults to true.
messageNoOptional default push body (max 120 characters in private rooms, 160 in public rooms).
invite_codeYesRoom invite code.
action_numberNoQuick-action slot whose label, sound, and acknowledgement preset fires use. Omit or pass null for an independent webhook with no Quick Ping preset.
cooldown_secondsNoMinimum seconds between fires. Defaults to 5.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYesAn incoming webhook. `webhook_url` embeds the secret — treat it as a credential.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / action_number / description
      Previous value: -"Quick-action slot to attribute fires to. Auto-assigned if omitted."New value: +"Quick-action slot whose label, sound, and acknowledgement preset fires use. Omit or pass null for an independent webhook with no Quick Ping preset."
    • changedInput schema / properties / action_number / type
      Previous value: -"integer"New value: +[
      +  "integer",
      +  "null"
      +]
  2. Changed1 schema field changed
    • changedInput schema / properties / action_number / maximum
      Previous value: -4New value: +16
  3. Changed4 schema fields changed
    • addedOutput schema / properties / result / additionalProperties
      Added value: +false
    • changedOutput schema / properties / result / description
      Previous value: -"Purpose-built PingRoom result with credential and account fields removed."New value: +"An incoming webhook. `webhook_url` embeds the secret — treat it as a credential."
    • addedOutput schema / properties / result / properties
      Added value: +{
      +  "action_number": {
      +    "type": [
      +      "integer",
      +      "null"
      +    ]
      +  },
      +  "color": {
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "cooldown_seconds": {
      +    "type": [
      +      "integer",
      +      "null"
      +    ]
      +  },
      +  "enabled": {
      +    "type": "boolean"
      +  },
      +  "icon": {
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "id": {
      +    "format": "uuid",
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "message": {
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "name": {
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "sound": {
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "title": {
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "webhook_url": {
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  }
      +}
    • addedOutput schema / properties / result / type
      Added value: +"object"
  4. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already establish the write profile (readOnlyHint=false, idempotentHint=false, destructiveHint=false), so the description's job is to add context — and it does: the Pro-plan gate, the ownership requirement, and the warning that the returned trigger URL is a credential to be handled as such. It doesn't cover failure modes or rate limits, but the safety-relevant disclosure is present.

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?

Two sentences, both load-bearing: the first gives purpose plus scope, the second gives a hard prerequisite and a security caveat. No filler and the credential warning is not buried.

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?

An output schema exists, so the description needn't explain return values, yet it still flags the one return value an agent must handle carefully. Prerequisites and ownership are covered; what's missing is behavior on prerequisite failure (e.g. non-Pro account) for a 10-parameter mutation tool.

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% across all 10 parameters, so the schema already carries the field semantics (including cross-references like list_room_icons for icon ids). The description adds no parameter-level detail, which is acceptable at this coverage level but yields the baseline score.

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?

States a specific verb and resource ('Create an incoming webhook') plus a scoping constraint ('for a room the account owns'). This cleanly separates it from update_webhook, delete_webhook, and list_webhooks, which share the resource but differ in verb.

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?

Gives a clear precondition for use — the room must be owned by the account and the bound account must be Pro — which tells the agent when this tool is applicable. It stops short of naming alternatives or stating what to do instead when the plan requirement isn't met.

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