Sign in

v14

OpenAPI 3.1.02026-08-03122113375.9 KB
seller-webhooks

Update a webhook

Update mutable configuration fields for an existing seller webhook endpoint.

This is a partial update endpoint. Send only the fields you want to change.

Updatable fields:

  • 'url'
  • 'description'
  • 'enabled'
  • 'additionalHeaders'

Behavior notes:

  • URL uniqueness is enforced; updating to a duplicate URL returns 409.
  • If no updatable fields are supplied, the current webhook state is returned unchanged.
  • Subscription events are not modified here; use PUT /seller/webhooks/{webhookId}/subscriptions.

Recommended change flow:

  1. GET /seller/webhooks/{webhookId} to load current configuration.
  2. PATCH this endpoint with only the fields being changed.
  3. GET /seller/webhooks/{webhookId}/test to validate connectivity after URL/header changes.
  4. Review failures and metrics to confirm post-change stability.
patch/seller/webhooks/{webhookId}

Path parameters

webhookIdstring required

Identifier of the webhook endpoint to update

Identifier of the webhook endpoint to update

Request body

urlstring uri

Destination URL that will receive webhook deliveries

descriptionstring

Optional human readable description

enabledboolean

Whether the webhook should be active immediately

additionalHeadersobject

Additional headers to include on webhook deliveries

subscriptionsstring[]

Initial subscriptions to associate with the webhook

Response

Updated 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