Skip to main content
PATCH
Update webhook endpoint

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Webhook endpoint public ID (wh_...).

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

Body

application/json

Partial update for a webhook endpoint.

name
string

Updated display name.

Minimum string length: 1
url
string<uri>

New destination URL for deliveries.

events
string[]

Replace the list of subscribed event types.

status
enum<string>

Set to DISABLED to pause deliveries without deleting the endpoint.

Available options:
ACTIVE,
DISABLED

Response

Webhook endpoint updated

Registered HTTPS endpoint that receives signed webhook events.

id
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:
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.