Skip to main content
Glama

Create Webhook

create_webhook

Register a webhook so long-running jobs notify you instead of blocking on wait_job — the right pattern for fan-out/async agents. Pass url + events — ONE terminal event per job kind with status INSIDE the payload (render.completed, compose.completed, media.completed, suggest.completed) plus checkpoint.ready (a held compose paused for review). DELIVERY: a POST { event, timestamp, projectId?, data } with Standard-Webhooks headers (webhook-id, webhook-timestamp, webhook-signature: v1,); the secret (whsec_) is returned ONCE — verify the RAW body with new Webhook(secret).verify(rawBody, headers). ACTIVATION is synchronous: CueFrame POSTs a signed webhook.verify challenge and your endpoint must reply 2xx echoing data.token — otherwise it returns status:"pending" and receives NO events (recover with verify_webhook, no delete/recreate). Read the cueframe://webhook-events resource (or GET /webhooks/events) for the full contract + every event's data shape BEFORE building your receiver.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "body": "<body>"
    },
    "name": "create_webhook"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesPOST /webhooks body.
commandIdNoRetry identity. A call repeated with the same commandId returns the first result instead of acting twice.

Output Schema

NameRequiredDescriptionDefault
idNo
urlNo
eventsNo
secretNoStandard Webhooks signing secret, format `whsec_<base64>`. Returned ONCE at create; rotate = delete + recreate. Every delivery carries `webhook-id`, `webhook-timestamp` (unix seconds), and `webhook-signature: v1,<base64>` (HMAC-SHA256 over `{id}.{timestamp}.{rawBody}`). Verify with any Standard-Webhooks library (`standardwebhooks` / `svix`): `new Webhook(secret).verify(rawBody, headers)`.
statusNoactive = ownership verified + receiving events; pending = challenge not echoed, inactive.
enabledNo
settleMsNo
verificationNoPresent ONLY when ownership verification did not complete (status:"pending"). CueFrame POSTs a signed `webhook.verify` challenge whose `data.token` your endpoint must echo in a 2xx to activate; `reason` is one of token_not_echoed | non_2xx_<code> | unreachable | ssrf_blocked. A pending webhook receives no events — fix the receiver and POST /webhooks/:id/verify (no delete/recreate needed). See GET /webhooks/events for the full contract.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed18 schema fields changed
    • addedInput schema / $defs
      Added value: +{
      +  "__schema0": {
      +    "example": "https://hooks.example.com/cueframe",
      +    "format": "uri",
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  "__schema1": {
      +    "items": {
      +      "$ref": "#/$defs/__schema2"
      +    },
      +    "minItems": 1,
      +    "type": "array"
      +  },
      +  "__schema2": {
      +    "enum": [
      +      "media.transcribed",
      +      "media.completed",
      +      "suggest.completed",
      +      "session.mux.complete",
      +      "session.mux.failed",
      +      "render.completed",
      +      "compose.completed",
      +      "checkpoint.ready",
      +      "project.updated",
      +      "composition.updated",
      +      "webhook.test"
      +    ],
      +    "type": "string"
      +  },
      +  "__schema3": {
      +    "maximum": 60000,
      +    "minimum": 0,
      +    "type": "integer"
      +  },
      +  "__schema4": {
      +    "maxLength": 128,
      +    "minLength": 1,
      +    "type": "string"
      +  }
      +}
    • addedInput schema / properties / body / properties / events / $ref
      Added value: +"#/$defs/__schema1"
    • removedInput schema / properties / body / properties / events / items
      Removed value: -{
      -  "enum": [
      -    "media.transcribed",
      -    "media.completed",
      -    "suggest.completed",
      -    "session.mux.complete",
      -    "session.mux.failed",
      -    "render.completed",
      -    "compose.completed",
      -    "checkpoint.ready",
      -    "project.updated",
      -    "composition.updated",
      -    "webhook.test"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / properties / body / properties / events / minItems
      Removed value: -1
    • removedInput schema / properties / body / properties / events / type
      Removed value: -"array"
    • addedInput schema / properties / body / properties / settleMs / $ref
      Added value: +"#/$defs/__schema3"
    • removedInput schema / properties / body / properties / settleMs / maximum
      Removed value: -60000
    • removedInput schema / properties / body / properties / settleMs / minimum
      Removed value: -0
    • removedInput schema / properties / body / properties / settleMs / type
      Removed value: -"integer"
    • addedInput schema / properties / body / properties / url / $ref
      Added value: +"#/$defs/__schema0"
    • removedInput schema / properties / body / properties / url / example
      Removed value: -"https://hooks.example.com/cueframe"
    • removedInput schema / properties / body / properties / url / format
      Removed value: -"uri"
    • removedInput schema / properties / body / properties / url / minLength
      Removed value: -1
    • removedInput schema / properties / body / properties / url / type
      Removed value: -"string"
    • addedInput schema / properties / commandId / $ref
      Added value: +"#/$defs/__schema4"
    • removedInput schema / properties / commandId / maxLength
      Removed value: -128
    • removedInput schema / properties / commandId / minLength
      Removed value: -1
    • removedInput schema / properties / commandId / type
      Removed value: -"string"
  2. Changed1 schema field changed
    • addedInput schema / properties / commandId
      Added value: +{
      +  "description": "Retry identity. A call repeated with the same commandId returns the first result instead of acting twice.",
      +  "maxLength": 128,
      +  "minLength": 1,
      +  "type": "string"
      +}
  3. Changed1 schema field changed
    • addedInput schema / properties / body / properties / url / example
      Added value: +"https://hooks.example.com/cueframe"
  4. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Goes far beyond the annotations: documents delivery payload shape, Standard-Webhooks headers, that the secret is returned once, the synchronous activation challenge with status:"pending" on failure, and non-idempotent-but-recoverable behavior. This is exactly the mutation-lifecycle context annotations don't carry.

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 purpose and the wait_job contrast, and every clause carries operational substance. It is dense and runs long with stacked parentheticals, which slightly hurts scanability but little 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?

Covers the full contract an agent needs for a webhook-creation mutation: event set semantics, delivery format, secret handling, activation handshake, failure mode, and recovery path. Output schema exists, so return values are correctly not belabored.

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?

Schema coverage is 100%, and the description still adds meaning: it clarifies that events are one terminal event per job kind with status inside the payload, plus checkpoint.ready semantics. It does not explain settleMs, which the schema leaves undocumented, so not a 5.

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 ('Register a webhook') and immediately frames its role against the sibling wait_job. An agent can distinguish it from wait_job, verify_webhook, and update_webhook without opening a schema.

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

Usage Guidelines5/5

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

Explicitly says when to use it ('the right pattern for fan-out/async agents', 'instead of blocking on wait_job') and names the recovery alternative (verify_webhook, 'no delete/recreate'). It also directs the agent to read a resource before building the receiver.

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.