The use of webhooks enables you to be notified in real time in your favourite applications when a modification is made on orders in your AntsRoute account. In concrete terms, a webhook let you send an HTTP request to a specified URL in response to an event.
The automated sending of this information makes it possible to trigger workflows in the incoming application. For example, the creation of an invoice in your Quickbooks account as soon as a delivery is completed with AntsRoute.
💡 Only “Admin” users can access the tab for setting up webhooks.
Example of an HTTP request:
Events that can be sent:
- Status change: Delivery cancelled, Delivery confirmed, Delivery created, Delivery pending, Delivery deleted, Delivery done, Confirmed status removed, Pending status removed.
- Planning: Delivery set to unassigned state, Delivery moved forward or delayed or assigned to another route, Delivery assigned to a route, Delivery assigned to a route in progress, Delivery scheduled from the basket, Delivery moved to the basket, Planning date changed.
- Proof of delivery: Proof of delivery (photo) added, Customer signature added.
- Other: Delivery locked, Delivery updated.
- Route: Route started, Route ended.
- Notification: Notification sent.
- Pick-up & Delivery: Loading done, Unloading done, Loading cancelled, Unloading cancelled.
How to add a webhook
First, you need to get the webhook URL of the application to which you want to send the data.
- Click on the blue circle at the top right.
- Go to the “Integrations” tab.
- Click on “Webhooks”.
- Click on the button “+” at the top right.
- Fill in the required information: name, URL address, authentication mode, etc.
- Select the events to send.
- Choose to include or not all the work order information.
- If you have several sites, select the sites concerned.
- Click on the “Save” button.
How to check the logs
The “Logs” enables you to access the history of the information sent to your applications and display any errors for each of your webhooks.
💡 You can filter the logs to display only those in error.
- Identify a webhook and click on “…”.
- Click on “Logs”.
💡 The icon ✔ indicates that the information has been sent. In contrast, the X icon indicates that the information has not been uploaded to the third party application. In this case, you can click on the content sent in the table to understand the error.