Retrieve a webhook

{ "id": "<string>", "url": "<string>", "enabled": true, "additionalHeaders": {}, "secret": "<string>", "lastSuccessAt": "2023-11-07T05:31:56Z", "lastFailureAt": "2023-11-07T05:31:56Z", "consecutiveFailures": 123, "maxConsecutiveFailures": 123, "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "subscriptions": [], "description": "<string>" }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

webhookId

string

required

Identifier of the webhook endpoint to retrieve

Response

Webhook endpoint

Represents a webhook endpoint configured by a seller to receive event notifications.

string

required

Unique identifier for the webhook endpoint

url

string<uri>

required

Destination URL for webhook deliveries

enabled

boolean

required

Indicates whether the webhook is currently active

additionalHeaders

object

required

Additional headers sent with each webhook request

Show child attributes

secret

string

required

Shared secret used to generate webhook signatures

lastSuccessAt

string<date-time> | null

required

Timestamp of the most recent successful delivery

lastFailureAt

string<date-time> | null

required

Timestamp of the most recent failed delivery

consecutiveFailures

integer

required

Current number of consecutive delivery failures

maxConsecutiveFailures

integer

required

Threshold at which the webhook will automatically be disabled

createdAt

string<date-time>

required

Timestamp when the webhook endpoint was created

updatedAt

string<date-time>

required

Timestamp when the webhook endpoint was last updated

subscriptions

enum<string>[]

required

Event types that the webhook is subscribed to

Event types that can trigger a webhook notification

Available options:

LISTING_CREATED,

LISTING_UPDATED,

LISTING_DELETED,

ORDER_CREATED,

ORDER_UPDATED,

TEST

description

string | null

Optional human readable description