Sign in

v14

OpenAPI 3.1.02026-08-03122113375.9 KB
seller-webhooks

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/{webhookId} when building edit flows.

Typical workflow:

  1. Read current subscriptions.
  2. Build and submit the full desired 'events' array.
  3. Verify with GET /seller/webhooks/{webhookId} or GET /seller/webhooks.
put/seller/webhooks/{webhookId}/subscriptions

Path parameters

webhookIdstring required

Identifier of the webhook endpoint to update

Identifier of the webhook endpoint to update

Request body

eventsstring[] required

Full list of event types that the webhook should be subscribed to

Response

Updated webhook endpoint including subscriptions

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