Skip to main content
Glama

Create a webhook

create_webhook
Destructive

Set up a webhook to receive real-time notifications for shop events like orders, products, and promotions. Specify the URL and event types to trigger automated workflows.

Instructions

Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.

Create a webhook

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNo
accountNoExact private shop profile label; not a provider identity or authorization proof.
confirmNoExplicit approval for this exact provider effect or local private-file operation.
payloadNoComplete current native JSON body; cannot mix with native body flags or payload_file.
allowedTypesNo
payload_fileNoAbsolute regular non-symlink native JSON body file, at most1MiB. Cannot mix with payload or body flags.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

C2.6/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false, idempotentHint=false, and openWorldHint=true, so the safety profile is covered. The description adds a concrete rate limit (100 requests / 10 seconds per shop) with a link, which is genuinely useful beyond the annotations, but it says nothing about the required 'confirm' approval, what a created webhook enables, or failure modes.

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

Conciseness3/5

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

It is short and the rate limit is front-loaded, so it is not bloated. However, the 'Create a webhook' sentence duplicates the title and the rate-limit line is doing nearly all the work, so the text is thin rather than efficiently packed.

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

Completeness2/5

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

For a six-parameter, destructive, nested-payload mutation with no output schema and zero required parameters, the description is far too sparse. It omits the confirm/approval semantics, the account scoping, and which payload representation to supply, leaving key invocation decisions unaddressed.

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

Parameters2/5

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

Schema description coverage is only 67% and the description mentions no parameters at all. The nested payload object, the enum of allowed event types, and the mutually exclusive payload/payload_file/body-flag options are left entirely to the schema, with no clarifying prose about which form to use.

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

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description says 'Create a webhook', which gives a verb and a resource, but it is essentially a restatement of the title and adds no scope, constraints, or distinguishing detail. With four sibling webhook tools (get_webhook, update_webhook, delete_webhook, list_webhooks) it does not help the agent discriminate among them.

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

Usage Guidelines2/5

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

There is no when-to-use guidance, no prerequisites, and no mention of alternatives such as update_webhook or list_webhooks. The only content is a rate-limit note, which is operational context rather than selection guidance.

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

Deploy Server

Other Tools