Replace a subscription
Replace the full subscription event set for a webhook endpoint.
This endpoint uses replacement semantics, not patch semantics.
How replacement works:
- The provided ‘events’ array becomes the complete source of truth.
- Existing subscriptions not included in the request are removed.
- New events in the request are added.
Usage guidance:
- Send the complete desired event list every time.
- Send an empty array to unsubscribe from all events.
- Fetch current state first with GET /seller/webhooks/ when building edit flows.
Typical workflow:
- Read current subscriptions.
- Build and submit the full desired ‘events’ array.
- Verify with GET /seller/webhooks/ or GET /seller/webhooks.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Identifier of the webhook endpoint to update
Body
Request body for updating the event subscriptions of a webhook endpoint.
Full list of event types that the webhook should be subscribed to
Event types that can trigger a webhook notification
LISTING_CREATED, LISTING_UPDATED, LISTING_DELETED, ORDER_CREATED, ORDER_UPDATED, TEST Response
Updated webhook endpoint including subscriptions
Represents a webhook endpoint configured by a seller to receive event notifications.
Unique identifier for the webhook endpoint
Destination URL for webhook deliveries
Indicates whether the webhook is currently active
Additional headers sent with each webhook request
Shared secret used to generate webhook signatures
Timestamp of the most recent successful delivery
Timestamp of the most recent failed delivery
Current number of consecutive delivery failures
Threshold at which the webhook will automatically be disabled
Timestamp when the webhook endpoint was created
Timestamp when the webhook endpoint was last updated
Event types that the webhook is subscribed to
Event types that can trigger a webhook notification
LISTING_CREATED, LISTING_UPDATED, LISTING_DELETED, ORDER_CREATED, ORDER_UPDATED, TEST Optional human readable description