Get webhook endpoint

{ "id": "<string>", "name": "Production webhook", "url": "<string>", "secret_prefix": "a1b2c3d4", "events": [ "invoice.created", "invoice.paid", "invoice.expired", "invoice.failed" ], "managed": true, "last_delivery_at": "2023-11-07T05:31:56Z", "last_delivery_status": "<string>", "failure_count": 123, "created_at": "2023-11-07T05:31:56Z" }

Authorizations

Authorization

string

header

required

Store-scoped API key. Prefix with sk_live_. Example: Authorization: Bearer sk_live_EXAMPLE_DO_NOT_USE

Path Parameters

string

required

Webhook endpoint public ID (wh_...).

Pattern: ^(inv_|txn_|plink_|wh_|whd_|evt_|int_)[0-9a-z]{20,32}$

Response

Webhook endpoint details

Registered HTTPS endpoint that receives signed webhook events.

string

Webhook endpoint ID (wh_...).

Pattern: ^(inv_|txn_|plink_|wh_|whd_|evt_|int_)[0-9a-z]{20,32}$

name

string

Human-readable label in the merchant dashboard.

Example:

"Production webhook"

url

string<uri>

HTTPS URL that receives POST requests for subscribed events.

secret_prefix

string

First characters of the signing secret (for identification only).

Example:

"a1b2c3d4"

events

string[]

Event types this endpoint is subscribed to.

Example:

[
  "invoice.created",
  "invoice.paid",
  "invoice.expired",
  "invoice.failed"
]

status

enum<string>

Webhook endpoint state:

ACTIVE: deliveries are sent
DISABLED: paused by merchant
ARCHIVED: permanently retired

Available options:

ACTIVE,

DISABLED,

ARCHIVED

managed

boolean

True when owned by an integration (for example WooCommerce) and not fully editable in the dashboard.

last_delivery_at

string<date-time> | null

Timestamp of the most recent delivery attempt.

last_delivery_status

string | null

Outcome of the last delivery (for example success, failed).

failure_count

integer

Consecutive or recent failed delivery count, depending on endpoint policy.

created_at

string<date-time>

When the endpoint was registered.