carriers5

channels5

clusters5

customer-addresses3

customers4

delivery-modalities5

delivery-types5

freight-types5

fulfillment-order-shipment-tracking-events1

fulfillment-order-shipments3

fulfillment-order-tracking-events1

fulfillment-orders4

inventory2

inventory-movements1

operators5

order-payments2

orders7

payment-methods3

permissions1

price-lists7

product-categories5

products3

promotions5

state-machines6

statuses5

strategies5

strategy-carriers5

strategy-channels5

strategy-operators5

strategy-price-lists5

webhook-subscriptions6

webhook-subscriptions

Create webhook subscription

Creates a new webhook subscription within the caller account.

post/api/v1/webhook-subscriptions

Request body

event_typesstring[] required

headersobject nullable

metadataobject nullable

namestring required

urlstring uri required

Response

Webhook subscription created.

status'ACTIVE' | 'DISABLED_BY_FAILURES' | 'DISABLED_BY_USER' required

headersobject nullable required

metadataobject nullable required

idstring required

namestring required

urlstring required

event_typesstring[] required

disabled_atstring nullable required

created_atstring required

updated_atstring required

Changes

Changed in 2 of the 9 revisions of this API.38

Jul 7, 2026a3b4750a505f37See the full diff
- ▲
  added the new required request property name
  new-required-request-property
- ▲
  added the new required request property url
  new-required-request-property
- ▲
  the event_types request property's minItems was increased to 1
  request-property-min-items-increased
- ○
  added the required property created_at to the response with the 201 status
  response-required-property-added
- ○
  added the required property disabled_at to the response with the 201 status
  response-required-property-added
- ○
  added the required property event_types to the response with the 201 status
  response-required-property-added
- ○
  added the required property id to the response with the 201 status
  response-required-property-added
- ○
  added the required property name to the response with the 201 status
  response-required-property-added
- ○
  added the required property updated_at to the response with the 201 status
  response-required-property-added
- ○
  added the required property url to the response with the 201 status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 7, 202684194c31ab851See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history