Skip to main content
Glama
Sign In

Checkout Page

by com.checkoutpage
OverviewDiscussionsAdmin

list_webhooks

Read-only

List the webhook endpoints registered on this Checkout Page account, newest first, with their subscribed events, status and delivery counters. The signing secret is never returned and custom header values are shown as [hidden]; headers are viewed and edited at the returned dashboardUrl. This is how to find a webhook id for get_webhook or delete_webhook, and how to check whether a URL is already registered before calling create_webhook. Read-only. Webhooks are returned sorted newest-first. Use cursor-based pagination (starting_after / ending_before) to page through large result sets. starting_after and ending_before cannot be used simultaneously. Max limit is 100, default is 10.

Input Schema

NameRequiredDescriptionDefault
eventNoOnly return webhooks subscribed to this event, for example `payment.paid`.
limitNoNumber of records per page (integer, max 100, default 10).
statusNoOnly return webhooks with this status. Valid values: active, inactive, failed.
ending_beforeNoCursor-based pagination. Pass a record `id` to return results before it. Cannot be used with `starting_after`.
starting_afterNoCursor-based pagination. Pass a record `id` to return results after it. Cannot be used with `ending_before`.

Output Schema

NameRequiredDescriptionDefault
dataYes
totalYesTotal number of records matching the query across all pages.
has_moreYesWhether more records exist beyond the current page.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / event / enum
      Previous value: -[
-  "customer.created",
-  "customer.updated",
-  "payment.abandoned",
-  "payment.created",
-  "payment.paid",
-  "payment.canceled",
-  "booking.abandoned",
-  "booking.created",
-  "booking.paid",
-  "booking.canceled",
-  "ticket.created",
-  "submission.created",
-  "submission.updated",
-  "submission.canceled",
-  "checkout_page.created",
-  "checkout_page.updated",
-  "product.created",
-  "product.updated",
-  "subscription.abandoned",
-  "subscription.created",
-  "subscription.trialing",
-  "subscription.scheduled",
-  "subscription.active",
-  "subscription.completed",
-  "subscription.canceled",
-  "subscription.expired"
-]New value: +[
+  "customer.created",
+  "customer.updated",
+  "payment.abandoned",
+  "payment.created",
+  "payment.paid",
+  "payment.canceled",
+  "booking.abandoned",
+  "booking.created",
+  "booking.paid",
+  "booking.canceled",
+  "ticket.created",
+  "ticket.canceled",
+  "submission.created",
+  "submission.updated",
+  "submission.canceled",
+  "checkout_page.created",
+  "checkout_page.updated",
+  "product.created",
+  "product.updated",
+  "subscription.abandoned",
+  "subscription.created",
+  "subscription.trialing",
+  "subscription.scheduled",
+  "subscription.active",
+  "subscription.completed",
+  "subscription.canceled",
+  "subscription.expired"
+]
    • changedOutput schema / properties / data / items / properties / events / items / description
      Previous value: -"An event a webhook can subscribe to. Valid values: webhook.test, customer.created, customer.updated, payment.abandoned, payment.created, payment.paid, payment.canceled, booking.abandoned, booking.created, booking.paid, booking.canceled, ticket.created, submission.created, submission.updated, submission.canceled, checkout_page.created, checkout_page.updated, product.created, product.updated, subscription.abandoned, subscription.created, subscription.trialing, subscription.scheduled, subscription.active, subscription.completed, subscription.canceled, subscription.expired. `webhook.test` is the payload sent by the dashboard's test-delivery action."New value: +"An event a webhook can subscribe to. Valid values: webhook.test, customer.created, customer.updated, payment.abandoned, payment.created, payment.paid, payment.canceled, booking.abandoned, booking.created, booking.paid, booking.canceled, ticket.created, ticket.canceled, submission.created, submission.updated, submission.canceled, checkout_page.created, checkout_page.updated, product.created, product.updated, subscription.abandoned, subscription.created, subscription.trialing, subscription.scheduled, subscription.active, subscription.completed, subscription.canceled, subscription.expired. `webhook.test` is the payload sent by the dashboard's test-delivery action."
    • changedOutput schema / properties / data / items / properties / events / items / enum
      Previous value: -[
-  "webhook.test",
-  "customer.created",
-  "customer.updated",
-  "payment.abandoned",
-  "payment.created",
-  "payment.paid",
-  "payment.canceled",
-  "booking.abandoned",
-  "booking.created",
-  "booking.paid",
-  "booking.canceled",
-  "ticket.created",
-  "submission.created",
-  "submission.updated",
-  "submission.canceled",
-  "checkout_page.created",
-  "checkout_page.updated",
-  "product.created",
-  "product.updated",
-  "subscription.abandoned",
-  "subscription.created",
-  "subscription.trialing",
-  "subscription.scheduled",
-  "subscription.active",
-  "subscription.completed",
-  "subscription.canceled",
-  "subscription.expired"
-]New value: +[
+  "webhook.test",
+  "customer.created",
+  "customer.updated",
+  "payment.abandoned",
+  "payment.created",
+  "payment.paid",
+  "payment.canceled",
+  "booking.abandoned",
+  "booking.created",
+  "booking.paid",
+  "booking.canceled",
+  "ticket.created",
+  "ticket.canceled",
+  "submission.created",
+  "submission.updated",
+  "submission.canceled",
+  "checkout_page.created",
+  "checkout_page.updated",
+  "product.created",
+  "product.updated",
+  "subscription.abandoned",
+  "subscription.created",
+  "subscription.trialing",
+  "subscription.scheduled",
+  "subscription.active",
+  "subscription.completed",
+  "subscription.canceled",
+  "subscription.expired"
+]
  2. Changed3 schema fields changed
    • changedInput schema / properties / event / enum
      Previous value: -[
-  "customer.created",
-  "customer.updated",
-  "payment.abandoned",
-  "payment.created",
-  "payment.paid",
-  "booking.abandoned",
-  "booking.created",
-  "booking.paid",
-  "ticket.created",
-  "submission.created",
-  "submission.updated",
-  "checkout_page.created",
-  "checkout_page.updated",
-  "product.created",
-  "product.updated",
-  "subscription.abandoned",
-  "subscription.created",
-  "subscription.trialing",
-  "subscription.scheduled",
-  "subscription.active",
-  "subscription.completed",
-  "subscription.canceled",
-  "subscription.expired"
-]New value: +[
+  "customer.created",
+  "customer.updated",
+  "payment.abandoned",
+  "payment.created",
+  "payment.paid",
+  "payment.canceled",
+  "booking.abandoned",
+  "booking.created",
+  "booking.paid",
+  "booking.canceled",
+  "ticket.created",
+  "submission.created",
+  "submission.updated",
+  "submission.canceled",
+  "checkout_page.created",
+  "checkout_page.updated",
+  "product.created",
+  "product.updated",
+  "subscription.abandoned",
+  "subscription.created",
+  "subscription.trialing",
+  "subscription.scheduled",
+  "subscription.active",
+  "subscription.completed",
+  "subscription.canceled",
+  "subscription.expired"
+]
    • changedOutput schema / properties / data / items / properties / events / items / description
      Previous value: -"An event a webhook can subscribe to. Valid values: webhook.test, customer.created, customer.updated, payment.abandoned, payment.created, payment.paid, booking.abandoned, booking.created, booking.paid, ticket.created, submission.created, submission.updated, checkout_page.created, checkout_page.updated, product.created, product.updated, subscription.abandoned, subscription.created, subscription.trialing, subscription.scheduled, subscription.active, subscription.completed, subscription.canceled, subscription.expired. `webhook.test` is the payload sent by the dashboard's test-delivery action."New value: +"An event a webhook can subscribe to. Valid values: webhook.test, customer.created, customer.updated, payment.abandoned, payment.created, payment.paid, payment.canceled, booking.abandoned, booking.created, booking.paid, booking.canceled, ticket.created, submission.created, submission.updated, submission.canceled, checkout_page.created, checkout_page.updated, product.created, product.updated, subscription.abandoned, subscription.created, subscription.trialing, subscription.scheduled, subscription.active, subscription.completed, subscription.canceled, subscription.expired. `webhook.test` is the payload sent by the dashboard's test-delivery action."
    • changedOutput schema / properties / data / items / properties / events / items / enum
      Previous value: -[
-  "webhook.test",
-  "customer.created",
-  "customer.updated",
-  "payment.abandoned",
-  "payment.created",
-  "payment.paid",
-  "booking.abandoned",
-  "booking.created",
-  "booking.paid",
-  "ticket.created",
-  "submission.created",
-  "submission.updated",
-  "checkout_page.created",
-  "checkout_page.updated",
-  "product.created",
-  "product.updated",
-  "subscription.abandoned",
-  "subscription.created",
-  "subscription.trialing",
-  "subscription.scheduled",
-  "subscription.active",
-  "subscription.completed",
-  "subscription.canceled",
-  "subscription.expired"
-]New value: +[
+  "webhook.test",
+  "customer.created",
+  "customer.updated",
+  "payment.abandoned",
+  "payment.created",
+  "payment.paid",
+  "payment.canceled",
+  "booking.abandoned",
+  "booking.created",
+  "booking.paid",
+  "booking.canceled",
+  "ticket.created",
+  "submission.created",
+  "submission.updated",
+  "submission.canceled",
+  "checkout_page.created",
+  "checkout_page.updated",
+  "product.created",
+  "product.updated",
+  "subscription.abandoned",
+  "subscription.created",
+  "subscription.trialing",
+  "subscription.scheduled",
+  "subscription.active",
+  "subscription.completed",
+  "subscription.canceled",
+  "subscription.expired"
+]
  3. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, openWorldHint=false, so the safety profile is covered and the description adds real value: the signing secret is never returned, custom header values appear as `[hidden]`, and headers must be viewed/edited via the returned `dashboardUrl`. It loses a point for restating 'Read-only' and repeating 'newest first' twice instead of spending those words on anything new (e.g. whether delivery counters are cumulative or windowed).

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?

The valuable content (redaction behavior, id-discovery routing, header editing location) is front-loaded and dense. There is avoidable redundancy: 'newest first' appears in both the first sentence and a later standalone sentence, and the pagination/limit sentence duplicates the schema descriptions.

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 return-shape explanation is rightly omitted, and the description still covers ordering, redaction, pagination, and routing to siblings. Minor gaps remain, such as whether status filtering defaults to active-only or all webhooks, which matters when checking for an existing registration.

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 coverage is 100%, with the `event` enum, `status` enum, `limit` bounds, and both cursor parameters already documented in the schema. The description adds almost nothing beyond it: the mutual exclusivity of `starting_after`/`ending_before` and the max/default `limit` are verbatim in the schema. Baseline 3 applies when the schema does the heavy lifting.

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?

The description states a specific verb and resource ('List the webhook endpoints registered on this Checkout Page account') and adds scope detail: returned fields (subscribed events, status, delivery counters), ordering, and the redaction rules. It also explicitly positions itself against siblings get_webhook, delete_webhook, and create_webhook, so an agent can pick the right tool without opening any 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?

It names the concrete triggering scenarios: find a webhook `id` for `get_webhook`/`delete_webhook`, and check whether a URL is already registered before `create_webhook`. That is explicit when-to-use plus named alternatives, not mere implication.

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

All Checkout Page toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources