Create webhooks

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.

• Add a webhook
• Check the logs

Add a webhook

First, you need to get the webhook URL of the application to which you want to send the data.

1. Click on the blue circle at the top right.
2. Go to the “Integrations” tab.
3. Click on “Webhooks”.

   

4. Click on the button “Add”.
5. Fill in the following information:
   • Name,
   • URL address,
   • Authentication mode,
   • Username,
   • Password.
6. Determine the Events to send.
7. Click on the “Save” button.

   

Here are the AntsRoute events that can be sent:

• Work order assigned to a route
• Work order done
• Work order cancelled
• Work order deleted
• Work order locked
• Work order confirmed
• Work order pending
• Work order brought forward or delayed or assigned to another route
• Work order set to unassigned state
• Customer signature added
• Photo evidence added
• Route started
• Route completed
• Notification sent to customer

The events regarding the pick-up and delivery mode that can be sent:

• Loading done
• Unloading done
• Loading cancelled
• Unloading cancelled

Here is an example of an HTTP request:

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. 

1. Identify a webhook and click on “…”.
2. 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.