Sign Customiser

Navigation

Dark mode

Webhooks

list_webhook_subscription_activity_logs

read

List webhook subscription activity logs

Copy page

Find why a webhook endpoint stopped receiving deliveries, and which customiser the failed deliveries came from.

Overview

Lists the deliveries of one webhook subscription of the connected Store, newest first, as the merchant admin webhook Activity tab shows them: each request direction, the line the admin shows, the HTTP status the endpoint answered and how long it took, what caused it and the storefront page the shopper was on. Filters narrow it by customiser and by status: errors for a 4xx or 5xx answer or no answer. The signing secret, request body and headers are never returned. It requires the webhooks:read scope and has no side effects.

Permission

Requires thewebhooks:readpermission. A connection without it answersinsufficient_scopenaming the permission to approve.

Annotations

readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
openWorldHintfalse

Prerequisites

  • A webhook subscription id from list_webhook_subscriptions.
  • A merchant has connected this store and approved the webhooks:read scope.

Arguments

webhook_idintegerrequired

The webhook subscription id, from list_webhook_subscriptions.

limitinteger

How many deliveries to return per page, between 1 and 100. Defaults to 20.

cursorstring

The opaque next_cursor value from the previous page, sent back with the same subscription and filters.

filterobject

Optional filters. An unknown filter is rejected, never ignored.

filter.customiser_idinteger

Only deliveries of this customiser.

filter.statusstring

errors for a 4xx or 5xx answer or no answer (closed).

One of: errors

Result

Up to `limit` deliveries of the subscription, newest first, plus the cursor for the next page.

request_idstringalways present
storeobjectalways present
store.idintegeralways present
store.namestringalways present
webhook_idintegeralways present
activity_logsarray of objectalways present

The page of deliveries, newest first.

activity_logs[].idintegeralways present
activity_logs[].eventstring or null

The request direction: request:outgoing or request:incoming, or the older outgoing-request and incoming-request names on old rows. Expected to grow.

activity_logs[].descriptionstringalways present

The line the merchant admin shows for the request.

activity_logs[].status_codeinteger or null

The HTTP status of the request, or null.

activity_logs[].duration_msinteger or null

How long the request took, or null.

activity_logs[].causerobject or null

What sent or caused the request, or null.

activity_logs[].causer.kindstringalways present

One of: api_key, integration, webhook

activity_logs[].causer.namestring or null
activity_logs[].causer.last_fourstring or null

The last four characters of an API key; null for every other kind.

activity_logs[].storefront_pageobject or null

The storefront page the shopper was on when the request started, or null.

activity_logs[].storefront_page.urlstring or null
activity_logs[].storefront_page.originstring or null
activity_logs[].storefront_page.sourcestringalways present

One of: window, parent, referrer, unavailable

activity_logs[].storefront_page.availabilitystringalways present

One of: available, unavailable

activity_logs[].storefront_page.captured_atstring or null
activity_logs[].created_atstringalways present
paginationobjectalways present
pagination.has_morebooleanalways present
pagination.next_cursorstring or null

Error cases

insufficient_scope

The connection was approved without webhooks:read.

invalid_cursor

The cursor was altered or reused for a different subscription, Store or filters; restart with no cursor.

invalid_parameter

customiser_id is not an integer from 1 to 2147483647, status is not errors, or limit is not an integer from 1 to 100.

resource_not_found

No webhook subscription with that id belongs to this store. Call list_webhook_subscriptions to find a valid id.

unknown_filter

Remove the filter named in parameter. This tool forwards unknown filter names so the API can refuse them explicitly.

Failed deliveries

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_webhook_subscription_activity_logs",
    "arguments": {
      "webhook_id": 7,
      "limit": 1,
      "filter": {
        "status": "errors"
      }
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": {
      "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t",
      "store": {
        "id": 12,
        "name": "Demo Signs"
      },
      "webhook_id": 7,
      "activity_logs": [
        {
          "id": 88140,
          "event": "request:outgoing",
          "description": "Sent order:created webhook",
          "status_code": 500,
          "duration_ms": 2110,
          "causer": {
            "kind": "webhook",
            "name": "https://example.com/webhooks/sign-customiser",
            "last_four": null
          },
          "storefront_page": null,
          "created_at": "2026-11-14T09:30:00Z"
        }
      ],
      "pagination": {
        "has_more": false,
        "next_cursor": null
      }
    }
  }
}

A webhook subscription of another store (error)

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_webhook_subscription_activity_logs",
    "arguments": {
      "webhook_id": 999
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "isError": true,
    "structuredContent": {
      "error": {
        "code": "resource_not_found",
        "title": "Resource not found",
        "detail": "The requested resource does not exist or does not belong to the authenticated store.",
        "recovery": "The identifier does not exist in this store. Use the matching list tool to rediscover a valid id."
      }
    }
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.