Skip to main content
Glama
canopy-labs

Featureflip

Official

List webhook deliveries

list_webhook_deliveries
Read-only

List a webhook subscription's delivery attempts, newest first, to check Pending, Succeeded, or DeadLettered statuses and diagnose failures using response codes or errors.

Instructions

List one subscription's delivery attempts, most recent first. status is Pending (awaiting an attempt, backing off, or in flight), Succeeded or DeadLettered; lastResponseStatusCode and lastError explain a failure. Paginated via cursor. Requires an Admin token. A 404 on every webhook call means webhooks are not enabled for the organization.

Input Schema

NameRequiredDescriptionDefault
idYesSubscription id (from list_webhooks)
limitNoPage size (default 20)
cursorNonext_cursor from a previous response

Output Schema

NameRequiredDescriptionDefault
itemsNo
next_cursorNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.3.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$defs": {
      +    "PublicWebhookDeliveryResponse": {
      +      "description": "One delivery attempt record. `status` is `Pending` (awaiting its first attempt,\nbacking off, or in flight), `Succeeded` or `DeadLettered`.",
      +      "properties": {
      +        "attemptCount": {
      +          "type": [
      +            "integer",
      +            "null"
      +          ]
      +        },
      +        "completedAt": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "createdAt": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "id": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "lastError": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "lastResponseStatusCode": {
      +          "type": [
      +            "integer",
      +            "null"
      +          ]
      +        },
      +        "nextAttemptAt": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "status": {
      +          "description": "Allowed values: Pending, Succeeded, DeadLettered.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "webhookEventId": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        }
      +      },
      +      "type": [
      +        "object",
      +        "null"
      +      ]
      +    }
      +  },
      +  "description": "A page of results plus an opaque cursor for the next page, or null when this is the last\npage. Wire keys are frozen: `items` (already lowercase under the camelCase policy) and\n`next_cursor` (pinned explicitly — the policy alone would emit `nextCursor`).",
      +  "properties": {
      +    "items": {
      +      "items": {
      +        "anyOf": [
      +          {
      +            "$ref": "#/$defs/PublicWebhookDeliveryResponse"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "type": [
      +        "array",
      +        "null"
      +      ]
      +    },
      +    "next_cursor": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    }
      +  },
      +  "type": "object"
      +}
  2. Addedv0.1.8

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the readOnlyHint annotation, it discloses the auth requirement (Admin token), the meaning of the status values including the ambiguous 'Pending' case (awaiting, backing off, in flight), how to interpret failures via lastResponseStatusCode/lastError, and an org-level 404 troubleshooting rule. This is substantive behavioral context an agent cannot get from annotations or schema.

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

Conciseness5/5

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

Four short, dense sentences with no filler: scope/ordering first, then status semantics, then pagination, then auth and the 404 diagnostic. Every sentence earns its place.

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-field documentation is not required here; the description still covers the operational essentials (ordering, pagination, auth, failure interpretation, 404 troubleshooting). Nothing an agent needs to invoke this correctly is missing.

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%, so the baseline is 3; the description adds a little by confirming cursor-based pagination flow and framing id as scoping to a single subscription. It adds no new syntax or format detail for limit or cursor beyond the schema, so it stays near baseline.

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 ('List one subscription's delivery attempts') plus ordering ('most recent first'), which cleanly separates it from the sibling list_webhooks (which lists subscriptions, not deliveries). An agent can pick this tool without opening either schema.

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

Usage Guidelines4/5

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

Gives clear context for when this is the right call — per-subscription delivery history — and adds operational guidance (Admin token required; a 404 across webhook calls means webhooks are disabled for the org). It never names an alternative such as list_webhooks or deliver_webhook, so the routing guidance is implied rather than explicit.

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