v14

OpenAPI 3.1.02026-08-03122113375.9 KB

seller-webhooks

Retrieve a webhook

Retrieve one webhook endpoint by 'webhookId' for the authenticated seller.

Use this endpoint when loading details for a specific endpoint before editing, testing, or troubleshooting.

Typical use cases:

Populate a webhook details page.
Confirm the active subscription set before replacing subscriptions.
Inspect latest delivery health fields (last success/failure and failure counters).

Behavior notes:

Returns 404 when the webhook id is unknown or does not belong to the current seller.
Response shape matches webhook records returned by list endpoints, including subscriptions.

get/seller/webhooks/{webhookId}

webhookIdstring required

Identifier of the webhook endpoint to retrieve

Webhook endpoint

idstring required

Unique identifier for the webhook endpoint

urlstring uri required

Destination URL for webhook deliveries

descriptionstring nullable

Optional human readable description

enabledboolean required

Indicates whether the webhook is currently active

additionalHeadersobject required

Additional headers sent with each webhook request

secretstring required

Shared secret used to generate webhook signatures

lastSuccessAtstring date-time nullable required

Timestamp of the most recent successful delivery

lastFailureAtstring date-time nullable required

Timestamp of the most recent failed delivery

consecutiveFailuresinteger required

Current number of consecutive delivery failures

maxConsecutiveFailuresinteger required

Threshold at which the webhook will automatically be disabled

createdAtstring date-time required

Timestamp when the webhook endpoint was created

updatedAtstring date-time required

Timestamp when the webhook endpoint was last updated

subscriptionsstring[] required

Event types that the webhook is subscribed to