Using webhooks, the Fulfill Engine platform is able to push notifications to your system when events occur on orders in your account. When these events occur, Fulfill Engine will make an authenticated REST call to a URL of your choosing.
To enable a webhook, place a request to your account representative with the necessary details. The API team will work to quickly enable the webhook for your account.
When requesting to register a webhook, the following details should be provided
- Webhook Event - The event that will trigger the webhook. The currently supported events are Order shipped, Order in progress, Shipment canceled, and Order canceled.
- URL - A URL that will be called by Fulfill Engine. A POST request will be made to this URL when the webhook event occurs. The request will include a POST body describing the event.
- Credentials (optional) - An optional username and password that will be supplied as basic authentication credentials on the POST request. This can be used by your system to authenticate the request from Fulfill Engine.