Sign in

v14

latestOpenAPI 3.1.02026-08-03122113375.9 KB
seller-webhooks

Create webhook

Create a new webhook endpoint for the authenticated seller.

Use this endpoint when onboarding a receiver service that should receive seller-side events.

What this endpoint configures:

  • The destination 'url' where deliveries are sent.
  • Optional 'description' so teams can identify endpoint purpose (for example, 'Production OMS').
  • Optional 'enabled' flag to control whether deliveries start immediately.
  • Optional 'additionalHeaders' that are included with each webhook request.
  • Initial 'subscriptions' defining which event types are delivered.

Important behavior:

  • A seller can register up to 5 webhook endpoints.
  • URL uniqueness is enforced per seller; creating a duplicate URL returns 409.
  • At least one subscription event is required in the request.
  • The response includes the webhook secret and generated webhook id.
post/seller/webhooks

Request body

urlstring uri required

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[] required

Initial subscriptions to associate with the webhook

Response

Webhook endpoint created

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