Webhooks

Listen for events instead of polling for them

Webhooks allow you to receive immediate updates from the system rather than polling.

Index

See your current list of active webhooks.

Index - Service Provider Endpoint

GET/webhooks

Index - Merchant Endpoint

GET/merchants/{MERCHANT_ID}/webhooks

Index - Response

The response format is the same for both endpoints.

Example Response

Create

Create - Service Provider Endpoint

POST/webhooks

Required attributes

Name
url
Type
string
Description
The URL you would like to send webhooks to https://test.com/webhook
Name
types
Type
object
Description
The webhook event types you would like us to send to this endpoint. {"order":{"created":true}}

Optional attributes

Name
types.channel.connected
Type
boolean
Description
Enable or disable the channel.connected webhook event. false
Name
types.fba_transport_plan.shipped
Type
boolean
Description
Enable or disable the fba_transport_plan.shipped webhook event. false
Name
types.inbound_shipment.created
Type
boolean
Description
Enable or disable the inbound_shipment.created webhook event. false
Name
types.inbound_shipment.items_updated
Type
boolean
Description
Enable or disable the inbound_shipment.items_updated webhook event. false
Name
types.inbound_shipment.notes_updated
Type
boolean
Description
Enable or disable the inbound_shipment.notes_updated webhook event. false
Name
types.inbound_shipment.received
Type
boolean
Description
Enable or disable the inbound_shipment.received webhook event. false
Name
types.inbound_shipment.shipped
Type
boolean
Description
Enable or disable the inbound_shipment.shipped webhook event. false
Name
types.invoice.created
Type
boolean
Description
Enable or disable the invoice.created webhook event. false
Name
types.item.identifier_created
Type
boolean
Description
Enable or disable the item.identifier_created webhook event. false
Name
types.item.stock_updated
Type
boolean
Description
Enable or disable the item.stock_updated webhook event. false
Name
types.merchant.added_to_service_provider
Type
boolean
Description
Enable or disable the merchant.added_to_service_provider webhook event. false
Name
types.merchant.user_added
Type
boolean
Description
Enable or disable the merchant.user_added webhook event. false
Name
types.order.created
Type
boolean
Description
Enable or disable the order.created webhook event. false
Name
types.order.shipped
Type
boolean
Description
Enable or disable the order.shipped webhook event. false
Name
types.outbound_shipment.cancellation_denied
Type
boolean
Description
Enable or disable the outbound_shipment.cancellation_denied webhook event. false
Name
types.outbound_shipment.cancellation_requested
Type
boolean
Description
Enable or disable the outbound_shipment.cancellation_requested webhook event. false
Name
types.outbound_shipment.cancellation_withdrawn
Type
boolean
Description
Enable or disable the outbound_shipment.cancellation_withdrawn webhook event. false
Name
types.outbound_shipment.closed
Type
boolean
Description
Enable or disable the outbound_shipment.closed webhook event. false
Name
types.outbound_shipment.created
Type
boolean
Description
Enable or disable the outbound_shipment.created webhook event. false
Name
types.outbound_shipment.notes_updated
Type
boolean
Description
Enable or disable the outbound_shipment.notes_updated webhook event. false
Name
types.outbound_shipment.shipped
Type
boolean
Description
Enable or disable the outbound_shipment.shipped webhook event. false
Name
types.outbound_shipment.status_changed
Type
boolean
Description
Enable or disable the outbound_shipment.status_changed webhook event. false
Name
types.stripe_merchant_customer.payment_method_added
Type
boolean
Description
Enable or disable the stripe_merchant_customer.payment_method_added webhook event. false
Name
types.transportation_tracking.data_updated
Type
boolean
Description
Enable or disable the transportation_tracking.data_updated webhook event. false

Create - Merchant Endpoint

Use the same parameters as the service provider endpoint.

POST/merchants/{MERCHANT_ID}/webhooks

Create - Response

The response format is the same for both endpoints.

Example Response

Update

PUT/webhooks/{WEBHOOK_ID}

Required attributes

Name
url
Type
string
Description
The URL you would like to send webhooks to https://test.com/webhook
Name
types
Type
object
Description
The webhook event types you would like us to send to this endpoint. {"order":{"created":true}}

Optional attributes

Name
types.channel.connected
Type
boolean
Description
Enable or disable the channel.connected webhook event. false
Name
types.fba_transport_plan.shipped
Type
boolean
Description
Enable or disable the fba_transport_plan.shipped webhook event. false
Name
types.inbound_shipment.created
Type
boolean
Description
Enable or disable the inbound_shipment.created webhook event. false
Name
types.inbound_shipment.items_updated
Type
boolean
Description
Enable or disable the inbound_shipment.items_updated webhook event. false
Name
types.inbound_shipment.notes_updated
Type
boolean
Description
Enable or disable the inbound_shipment.notes_updated webhook event. false
Name
types.inbound_shipment.received
Type
boolean
Description
Enable or disable the inbound_shipment.received webhook event. false
Name
types.inbound_shipment.shipped
Type
boolean
Description
Enable or disable the inbound_shipment.shipped webhook event. false
Name
types.invoice.created
Type
boolean
Description
Enable or disable the invoice.created webhook event. false
Name
types.item.identifier_created
Type
boolean
Description
Enable or disable the item.identifier_created webhook event. false
Name
types.item.stock_updated
Type
boolean
Description
Enable or disable the item.stock_updated webhook event. false
Name
types.merchant.added_to_service_provider
Type
boolean
Description
Enable or disable the merchant.added_to_service_provider webhook event. false
Name
types.merchant.user_added
Type
boolean
Description
Enable or disable the merchant.user_added webhook event. false
Name
types.order.created
Type
boolean
Description
Enable or disable the order.created webhook event. false
Name
types.order.shipped
Type
boolean
Description
Enable or disable the order.shipped webhook event. false
Name
types.outbound_shipment.cancellation_denied
Type
boolean
Description
Enable or disable the outbound_shipment.cancellation_denied webhook event. false
Name
types.outbound_shipment.cancellation_requested
Type
boolean
Description
Enable or disable the outbound_shipment.cancellation_requested webhook event. false
Name
types.outbound_shipment.cancellation_withdrawn
Type
boolean
Description
Enable or disable the outbound_shipment.cancellation_withdrawn webhook event. false
Name
types.outbound_shipment.closed
Type
boolean
Description
Enable or disable the outbound_shipment.closed webhook event. false
Name
types.outbound_shipment.created
Type
boolean
Description
Enable or disable the outbound_shipment.created webhook event. false
Name
types.outbound_shipment.notes_updated
Type
boolean
Description
Enable or disable the outbound_shipment.notes_updated webhook event. false
Name
types.outbound_shipment.shipped
Type
boolean
Description
Enable or disable the outbound_shipment.shipped webhook event. false
Name
types.outbound_shipment.status_changed
Type
boolean
Description
Enable or disable the outbound_shipment.status_changed webhook event. false
Name
types.stripe_merchant_customer.payment_method_added
Type
boolean
Description
Enable or disable the stripe_merchant_customer.payment_method_added webhook event. false
Name
types.transportation_tracking.data_updated
Type
boolean
Description
Enable or disable the transportation_tracking.data_updated webhook event. false

Example Response

Event Types

These event payloads are generated from the current PrepBusiness OpenAPI webhook specs.

Channel

channel.connected

This webhook is sent to subscribed endpoints when the channel.connected event occurs.

Subscription parameter: types.channel.connected
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "channel.connected",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 6001,
    "merchant_id": 42,
    "type": "shopify",
    "nickname": "Main Store",
    "is_active": true,
    "account_id": "store.example.com"
  }
}

FBA Transport Plan

fba_transport_plan.shipped

This webhook is sent to subscribed endpoints when the fba_transport_plan.shipped event occurs.

Subscription parameter: types.fba_transport_plan.shipped
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "fba_transport_plan.shipped",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "plan_id": 123,
    "outbound_shipment_id": 7001,
    "merchant_id": 42
  }
}

Inbound Shipment

inbound_shipment.created

This webhook is sent to subscribed endpoints when the inbound_shipment.created event occurs.

Subscription parameter: types.inbound_shipment.created
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "inbound_shipment.created",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 1001,
    "merchant_id": 42,
    "warehouse_id": 5
  }
}

inbound_shipment.items_updated

This webhook is sent to subscribed endpoints when the inbound_shipment.items_updated event occurs.

Subscription parameter: types.inbound_shipment.items_updated
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "inbound_shipment.items_updated",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 1001,
    "merchant_id": 42,
    "warehouse_id": 5,
    "expected_items": [],
    "actual_items": [],
    "unsellable_items": []
  }
}

inbound_shipment.notes_updated

This webhook is sent to subscribed endpoints when the inbound_shipment.notes_updated event occurs.

Subscription parameter: types.inbound_shipment.notes_updated
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "inbound_shipment.notes_updated",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 1001,
    "merchant_id": 42,
    "warehouse_id": 5
  }
}

inbound_shipment.received

This webhook is sent to subscribed endpoints when the inbound_shipment.received event occurs.

Subscription parameter: types.inbound_shipment.received
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "inbound_shipment.received",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 1001,
    "merchant_id": 42,
    "warehouse_id": 5
  }
}

inbound_shipment.shipped

This webhook is sent to subscribed endpoints when the inbound_shipment.shipped event occurs.

Subscription parameter: types.inbound_shipment.shipped
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "inbound_shipment.shipped",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 1001,
    "merchant_id": 42,
    "warehouse_id": 5
  }
}

Invoice

invoice.created

This webhook is sent to subscribed endpoints when the invoice.created event occurs.

Subscription parameter: types.invoice.created
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "invoice.created",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 9001,
    "charger_id": 12,
    "chargee_id": 42,
    "currency": "USD",
    "status": "draft",
    "total": 123.45
  }
}

Item

item.identifier_created

This webhook is sent to subscribed endpoints when the item.identifier_created event occurs.

Subscription parameter: types.item.identifier_created
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "item.identifier_created",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "product_uuid": "00000000-0000-0000-0000-000000000001",
    "item_id": 5001,
    "item_sku": "SKU-001",
    "identifier_type": "fnsku",
    "identifier": "X001234567"
  }
}

item.stock_updated

This webhook is sent to subscribed endpoints when the item.stock_updated event occurs.

Subscription parameter: types.item.stock_updated
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "item.stock_updated",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 5001,
    "merchant_id": 42,
    "merchant_sku": "SKU-001",
    "identifiers": []
  }
}

Merchant

merchant.added_to_service_provider

This webhook is sent to subscribed endpoints when the merchant.added_to_service_provider event occurs.

Subscription parameter: types.merchant.added_to_service_provider
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "merchant.added_to_service_provider",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 42,
    "name": "Example Merchant",
    "notes": "Priority merchant",
    "primaryEmail": "merchant@example.com",
    "billingCycle": "monthly",
    "enabled": true
  }
}

merchant.user_added

This webhook is sent to subscribed endpoints when the merchant.user_added event occurs.

Subscription parameter: types.merchant.user_added
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "merchant.user_added",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 8001,
    "name": "Jane Doe",
    "merchant_id": 42,
    "merchant_name": "Example Merchant",
    "user_role_on_merchant": "owner"
  }
}

Order

order.created

This webhook is sent to subscribed endpoints when the order.created event occurs.

Subscription parameter: types.order.created
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "order.created",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 3001,
    "customer": {
      "id": 2001,
      "name": "Example Customer"
    },
    "order_items": []
  }
}

order.shipped

This webhook is sent to subscribed endpoints when the order.shipped event occurs.

Subscription parameter: types.order.shipped
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "order.shipped",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 3001,
    "customer": {
      "id": 2001,
      "name": "Example Customer"
    },
    "order_items": [],
    "tracking_numbers": []
  }
}

Outbound Shipment

outbound_shipment.cancellation_denied

This webhook is sent to subscribed endpoints when the outbound_shipment.cancellation_denied event occurs.

Subscription parameter: types.outbound_shipment.cancellation_denied
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "outbound_shipment.cancellation_denied",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 7001,
    "merchant_id": 42,
    "warehouse_id": 5
  }
}

outbound_shipment.cancellation_requested

This webhook is sent to subscribed endpoints when the outbound_shipment.cancellation_requested event occurs.

Subscription parameter: types.outbound_shipment.cancellation_requested
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "outbound_shipment.cancellation_requested",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 7001,
    "merchant_id": 42,
    "warehouse_id": 5
  }
}

outbound_shipment.cancellation_withdrawn

This webhook is sent to subscribed endpoints when the outbound_shipment.cancellation_withdrawn event occurs.

Subscription parameter: types.outbound_shipment.cancellation_withdrawn
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "outbound_shipment.cancellation_withdrawn",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 7001,
    "merchant_id": 42,
    "warehouse_id": 5
  }
}

outbound_shipment.closed

This webhook is sent to subscribed endpoints when the outbound_shipment.closed event occurs.

Subscription parameter: types.outbound_shipment.closed
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "outbound_shipment.closed",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 7001,
    "merchant_id": 42,
    "warehouse_id": 5,
    "previous_status": "open"
  }
}

outbound_shipment.created

This webhook is sent to subscribed endpoints when the outbound_shipment.created event occurs.

Subscription parameter: types.outbound_shipment.created
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "outbound_shipment.created",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 7001,
    "merchant_id": 42,
    "warehouse_id": 5
  }
}

outbound_shipment.notes_updated

This webhook is sent to subscribed endpoints when the outbound_shipment.notes_updated event occurs.

Subscription parameter: types.outbound_shipment.notes_updated
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "outbound_shipment.notes_updated",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 7001,
    "merchant_id": 42,
    "warehouse_id": 5
  }
}

outbound_shipment.shipped

This webhook is sent to subscribed endpoints when the outbound_shipment.shipped event occurs.

Subscription parameter: types.outbound_shipment.shipped
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "outbound_shipment.shipped",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 7001,
    "merchant_id": 42,
    "warehouse_id": 5,
    "previous_status": "open"
  }
}

outbound_shipment.status_changed

This webhook is sent to subscribed endpoints when the outbound_shipment.status_changed event occurs.

Subscription parameter: types.outbound_shipment.status_changed
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "outbound_shipment.status_changed",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": 7001,
    "merchant_id": 42,
    "warehouse_id": 5,
    "previous_status": "open"
  }
}

Stripe Merchant Customer

stripe_merchant_customer.payment_method_added

This webhook is sent to subscribed endpoints when the stripe_merchant_customer.payment_method_added event occurs.

Subscription parameter: types.stripe_merchant_customer.payment_method_added
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "stripe_merchant_customer.payment_method_added",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "id": "cus_123",
    "merchant_id": 42,
    "payment_method_id": "pm_123"
  }
}

Transportation Tracking

transportation_tracking.data_updated

This webhook is sent to subscribed endpoints when the transportation_tracking.data_updated event occurs.

Subscription parameter: types.transportation_tracking.data_updated
Acknowledgement: Return a 2xx response to indicate that the webhook was received successfully.

Example payload

{
  "specversion": "1.0",
  "id": "string",
  "source": "string",
  "type": "transportation_tracking.data_updated",
  "datacontenttype": "application/json",
  "time": "2026-01-01T00:00:00Z",
  "correlationid": "string",
  "data": {
    "status": "transit",
    "number": "1Z999AA10123456784",
    "carrier": "ups"
  }
}