We’ve introduced Webhooks in the production Insights application to simplify how data is shared with external systems. With Webhooks, Factbird can automatically push structured JSON data to any defined endpoint whenever specific events occur, such as a batch starting or ending.
Webhooks let you send data instantly to external systems (e.g., ERP, MES, cloud services). This is not a full system integration, the receiving system must be setup to be able to handle the data and is not the responsibility of Factbird.
Today, the supported trigger types are:
- Batch start
- Batch end
You can specify:
- Endpoint URLs
- Optional headers for authentication
- Site or line-level scope
- Event-specific payloads
How to access Webhooks
Before navigating to Webhooks, you need to have access to the administration tab which is typically reserved for those with super user access similar.
1. Once on the administration panel click on System. You'll be presented with Webhooks, select this option.
2. By default when first opened there will not be any Webhooks. To add a Webhook simply click on the "+Webhook" button.
3. You will be prompted to fill out the following information.
Listed below is an explanation for each number:
- This is the name of the Webhook
- You can set a description for easy maintenance and summary of the Webhook i.e Notify SAP when a new batch begins.
- The endpoint is the destination where Factbird sends the Webhook data, each time the trigger occurs we send a Json payload to that address with all the relevant data.
- Headers are used in case your endpoint requires further authentication normally an API key. This is an optional step.
- Here you can select which trigger to use and it lets us know when we should send the data. As of now this is only for Batch start and Batch end. The location is where you would like this Webhook to apply, this location is selected from the organisation tree.
Note: You can run the Webhook on an individual site level or the entire organisation - If you need to temporarily disable the Webhook you have the option to do so.
Once you have finished creating your Webhook you will be presented this page which outlines the execution history so you can monitor if this is working as expected.
Note: We recommend to run a test to ensure that the Webhook is working as expected