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 types of webhooks you would like us to send to this endpoint. See the Types page. {"invoice": {"created": true}}
Optional attributes
- Name
types.invoice.created- Type
- boolean
- Description
- Enable / disable this webhook type false
- Name
types.inbound_shipment.notes_updated- Type
- boolean
- Description
- Enable / disable this webhook type false
- Name
types.inbound_shipment.shipped- Type
- boolean
- Description
- Enable / disable this webhook type false
- Name
types.inbound_shipment.received- Type
- boolean
- Description
- Enable / disable this webhook type false
- Name
types.outbound_shipment.created- Type
- boolean
- Description
- Enable / disable this webhook type false
- Name
types.outbound_shipment.shipped- Type
- boolean
- Description
- Enable / disable this webhook type false
- Name
types.outbound_shipment.notes_updated- Type
- boolean
- Description
- Enable / disable this webhook type false
- Name
types.order.shipped- Type
- boolean
- Description
- Enable / disable this webhook type false
- Name
types.order.created- Type
- boolean
- Description
- Enable / disable this webhook type 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 types of webhooks you would like us to send to this endpoint. See the Types page. {"invoice": {"created": true}}
Optional attributes
- Name
types.invoice.created- Type
- boolean
- Description
- Enable / disable this webhook type false
- Name
types.inbound_shipment.notes_updated- Type
- boolean
- Description
- Enable / disable this webhook type false
- Name
types.inbound_shipment.shipped- Type
- boolean
- Description
- Enable / disable this webhook type false
- Name
types.inbound_shipment.received- Type
- boolean
- Description
- Enable / disable this webhook type false
- Name
types.outbound_shipment.created- Type
- boolean
- Description
- Enable / disable this webhook type false
- Name
types.outbound_shipment.shipped- Type
- boolean
- Description
- Enable / disable this webhook type false
- Name
types.outbound_shipment.notes_updated- Type
- boolean
- Description
- Enable / disable this webhook type false
- Name
types.order.shipped- Type
- boolean
- Description
- Enable / disable this webhook type false
- Name
types.order.created- Type
- boolean
- Description
- Enable / disable this webhook type false