Skip to main content
Glama

Cluby MCP

Create webhook endpoint

create_webhook_endpoint

Add a webhook endpoint (requires the admin role). Omit secret to have one generated: it is returned once in secret and never again, so show it to the user. name defaults to the URL's host. Plain http URLs are accepted for localhost only. Events are POSTed as JSON with an HMAC signature in X-Cluby-Signature (t=<unix>,v1=<hex hmac-sha256(secret, "<t>.<body>")>). Event types: smart_link.scanned (A member scanned a smart link or NFC tag whose target names a venue (sent to every endpoint subscribed to it; posRef only to the endpoint the tag is tied to).). Includes (optional sections added to each event's data): profile (The member's display name, profile photo URL and the date they joined the event's venue.), membershipCards (Membership / VIP cards the member holds at the venue, valid now.), benefits (Benefits the member can activate at the venue right now — a spent one, one outside its schedule, or a members-only one the member does not hold is left out (name, price text, and for the POS channel an actionId and its single-use redeemUrl).), stampCards (The member's stamp cards in the organization, with stamps and the number to fill (and for the POS channel an actionId and awardStampUrl on the cards that run at the scanned venue).), items (Items the member holds that are usable at the scanned venue — rewards earned (a full stamp card, a birthday gift) and products bought — with units left (and for the POS channel an actionId and a useUrl, good for as many uses as there are units, at most 10).).

Input Schema

NameRequiredDescriptionDefault
urlYesA public HTTPS URL. Private, link-local and loopback addresses are refused, and redirects are not followed.
nameNoA label for lists and alerts. The URL's host by default.
orgIdNoOrganization public id, the `id` field from list_orgs. Omit it when the API key reaches exactly one organization.
eventsNoThe event types to receive. `smart_link.scanned` by default.
secretNoThe key events are signed with. Omit it to have one generated (`whsec_…`), returned once and never again. Use the whole string, prefix included, as the HMAC key. A new one replaces the old at once.
enabledNo`false` stops deliveries without deleting the endpoint.
includesNoWhat each event carries beyond its own data: `profile`, `membershipCards`, `benefits`, `stampCards`, `items`. None by default; a POS connection's own endpoint gets all of them.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changed
    • addedInput schema / properties / enabled / description
      Added value: +"`false` stops deliveries without deleting the endpoint."
    • addedInput schema / properties / events / description
      Added value: +"The event types to receive. `smart_link.scanned` by default."
    • addedInput schema / properties / includes / description
      Added value: +"What each event carries beyond its own data: `profile`, `membershipCards`, `benefits`, `stampCards`, `items`. None by default; a POS connection's own endpoint gets all of them."
    • changedInput schema / properties / includes / items / enum
      Previous value: -[
      -  "profile",
      -  "membershipCards",
      -  "benefits",
      -  "stampCards"
      -]New value: +[
      +  "profile",
      +  "membershipCards",
      +  "benefits",
      +  "stampCards",
      +  "items"
      +]
    • addedInput schema / properties / name / description
      Added value: +"A label for lists and alerts. The URL's host by default."
    • addedInput schema / properties / secret / description
      Added value: +"The key events are signed with. Omit it to have one generated (`whsec_…`), returned once and never again. Use the whole string, prefix included, as the HMAC key. A new one replaces the old at once."
    • addedInput schema / properties / url / description
      Added value: +"A public HTTPS URL. Private, link-local and loopback addresses are refused, and redirects are not followed."
  2. Added

TDQS

A3.9/5.0
Behavior4/5

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

Rich beyond what `destructiveHint: false` provides: the secret is shown once and never again (so it must be surfaced to the user), signatures and their HMAC format are documented, event delivery semantics and per-endpoint `posRef` scoping are described. One internal inconsistency weakens it: the description says plain http is accepted for localhost, while the schema says loopback addresses are refused.

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

Conciseness2/5

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

The security and secret guidance is correctly front-loaded, but the bulk of the text is a sprawling enumeration of event payload fields that largely restates the schema's `includes` description, complete with doubled parentheses ('(A member scanned ... at most 10).).') that make it hard to parse. Much of it does not earn its place in a tool-selection description.

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?

For a 7-parameter mutation tool with no output schema, the description covers the returned `secret`, defaults, and delivery behavior, so an agent has what it needs to call it correctly. It is undermined mainly by formatting and by the http/loopback inconsistency rather than by missing information.

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 already 100%, but the description adds semantics the schema cannot: the generated secret's one-time visibility and format, the `name` default, and that a POS connection's own endpoint silently receives all `includes`. That is real value over baseline 3.

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?

Opens with a specific verb + resource ('Add a webhook endpoint') and immediately constrains it with the admin-role requirement. An agent can tell this apart from update_webhook_endpoint or test_webhook_endpoint without opening the schema.

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

Usage Guidelines3/5

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

The description gives useful preconditions (admin role required, omit `secret` to auto-generate) but never routes to alternatives such as `update_webhook_endpoint` for existing endpoints, `list_webhook_endpoints` to check for duplicates, or `test_webhook_endpoint` to verify delivery afterward. Usage is implied rather than stated.

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