Webhooks

get_webhook_subscription

read

Get webhook subscription

Copy page

Confirm where one subscription delivers and which topic it carries, before changing or deleting it.

Overview

Reads one webhook subscription of the connected Store: its topic, destination URL and timestamps. The signing secret is not returned; it is shown once at creation and cannot be read back, so a lost secret is replaced by deleting the subscription and creating a new one. It requires the webhooks:read scope, has no side effects and is safe to retry.

Permission

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

Annotations

readOnlyHinttrue

destructiveHintfalse

idempotentHinttrue

openWorldHintfalse

Prerequisites

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

Arguments

webhook_idintegerrequired

The subscription id, from list_webhook_subscriptions.

Result

One subscription. Never a signing secret.

request_idstringalways present

storeobjectalways present

store.idintegeralways present

store.namestringalways present

subscriptionobjectalways present

The subscription. Never a signing secret.

subscription.idintegeralways present

subscription.topicstringalways present

subscription.urlstringalways present

subscription.created_atstring or null

subscription.updated_atstring or null

Error cases

insufficient_scope

The connection was approved without webhooks:read.

resource_not_found

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

Read one subscription

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_webhook_subscription",
    "arguments": {
      "webhook_id": 42
    }
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": {
      "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t",
      "store": {
        "id": 12,
        "name": "Demo Signs"
      },
      "subscription": {
        "id": 42,
        "topic": "product:created",
        "url": "https://example.com/webhooks/sign-customiser",
        "created_at": "2026-07-22T00:00:00Z",
        "updated_at": "2026-07-22T00:00:00Z"
      }
    }
  }
}

A subscription id from another store (error)

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_webhook_subscription",
    "arguments": {
      "webhook_id": 987654
    }
  }
}

{
  "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."
      }
    }
  }
}