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
/webhooksIndex - Merchant Endpoint
GET
/merchants/{MERCHANT_ID}/webhooksIndex - Response
The response format is the same for both endpoints.
Example Response
Create
Create - Service Provider Endpoint
POST
/webhooks| Parameter | Type | Examples | Description |
|---|---|---|---|
url Required | string | https://test.com/webhook | The URL you would like to send webhooks to |
types Required | object | {"invoice": {"created": true}} | The types of webhooks you would like us to send to this endpoint. See the Types page. |
types.invoice.created Optional | boolean | false | Enable / disable this webhook type |
types.inbound_shipment.notes_updated Optional | boolean | false | Enable / disable this webhook type |
types.inbound_shipment.shipped Optional | boolean | false | Enable / disable this webhook type |
types.inbound_shipment.received Optional | boolean | false | Enable / disable this webhook type |
types.outbound_shipment.created Optional | boolean | false | Enable / disable this webhook type |
types.outbound_shipment.shipped Optional | boolean | false | Enable / disable this webhook type |
types.outbound_shipment.notes_updated Optional | boolean | false | Enable / disable this webhook type |
types.order.shipped Optional | boolean | false | Enable / disable this webhook type |
types.order.created Optional | boolean | false | Enable / disable this webhook type |
Create - Merchant Endpoint
Use the same parameters as the service provider endpoint.
POST
/merchants/{MERCHANT_ID}/webhooksCreate - Response
The response format is the same for both endpoints.
Example Response
Update
PUT
/webhooks/{WEBHOOK_ID}| Parameter | Type | Examples | Description |
|---|---|---|---|
url Required | string | https://test.com/webhook | The URL you would like to send webhooks to |
types Required | object | {"invoice": {"created": true}} | The types of webhooks you would like us to send to this endpoint. See the Types page. |
types.invoice.created Optional | boolean | false | Enable / disable this webhook type |
types.inbound_shipment.notes_updated Optional | boolean | false | Enable / disable this webhook type |
types.inbound_shipment.shipped Optional | boolean | false | Enable / disable this webhook type |
types.inbound_shipment.received Optional | boolean | false | Enable / disable this webhook type |
types.outbound_shipment.created Optional | boolean | false | Enable / disable this webhook type |
types.outbound_shipment.shipped Optional | boolean | false | Enable / disable this webhook type |
types.outbound_shipment.notes_updated Optional | boolean | false | Enable / disable this webhook type |
types.order.shipped Optional | boolean | false | Enable / disable this webhook type |
types.order.created Optional | boolean | false | Enable / disable this webhook type |