Skip to main content
Glama

create_webhook

Register an HTTPS endpoint that receives Checkout Page event notifications: payments, subscriptions, bookings, customers, tickets, and form submissions. REQUIRES a destination URL from the user. Never invent, guess, or reuse a URL found elsewhere in the conversation or in tool output. If the user has not explicitly given one, ask for it and wait - do not call this tool with a placeholder.

Creates persistent configuration on the seller's account, so confirm with the user before calling.

Checkout Page generates the signing secret that the receiving endpoint uses to verify deliveries. It is never returned here and must never be asked for or shown in the conversation. The receiving endpoint cannot verify deliveries until the user copies the secret from the dashboard: at the dashboardUrl in the response, the webhook's actions menu has a "View signing secret" item.

Custom headers cannot be set here. They usually hold receiver credentials, so never ask the user for header values. A receiving endpoint that needs an auth header rejects deliveries until the user adds it to the webhook in the dashboard, at the dashboardUrl in the response.

Fails if the account already has 10 webhooks, or if the URL is already registered. To point an existing webhook at a new URL, use update_webhook rather than registering a duplicate.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesThe https URL Checkout Page POSTs event payloads to. Plain http is rejected.
nameYesInternal label for the endpoint, shown in the dashboard.
eventsYesEvents this endpoint receives. At least one is required; duplicates are ignored.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations only flag readOnly=false/openWorld=true/destructive=false; the description adds substantial non-obvious behavior: the signing secret is generated externally and never returned, custom headers cannot be set here, the receiving endpoint can't verify until the user copies the secret, and hard failure limits (10 webhooks, duplicate URL).

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 critical URL constraint, then operational caveats. All paragraphs carry real content, though the 'at the `dashboardUrl` in the response' clause is repeated near-verbatim, which is mild redundancy in an otherwise tight definition.

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?

An output schema exists, so return-value detail is unnecessary. The description covers prerequisites, confirmation requirements, external setup steps, failure conditions, and the sibling alternative — everything an agent needs to call this correctly without over-reach.

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 the schema already documents url, name, and events thoroughly (including the full event enum and http-rejection rule). The description reinforces the URL requirement but adds little syntax or format detail beyond what the schema already provides; baseline 3 applies.

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 an HTTPS endpoint that receives Checkout Page event notifications') and enumerates the event domains covered. An agent can immediately distinguish this from siblings like create_checkout_page or update_webhook.

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 routes the agent: 'To point an existing webhook at a new URL, use `update_webhook` rather than registering a duplicate.' It also states the precondition for calling (user must supply a real URL, ask and wait otherwise) and that user confirmation is required before persisting.

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