Webhooks

The Webhook administration panel is being used to setup webhooks, that can notify your data consumers on updates.

The Webhook panel lists the Webhooks you have already created, and let you create and edit them:

Click on “ADD NEW” to create a new Webhook configuration, or the “pen” icon to edit an existing webhook. You can also delete a web hook by clicking on the vertical “…” button and selecting “Delete”.

Create or edit Webhooks

When you create or edit webhooks, the settings for this particular webhook is configured in a popup dialog.

Similarly to the API token editor, you can set an internal name that makes sense to you.

Select triggering entity type

The webhook is defined for each IoL entity type, so you have to select which entity type this webhook relates to (should be triggered by):

In this example, the webhook is activated by changes to TransportInstruction entities.

Filter on data conditons

You can define filters that limit what entity updates triggers the web hook, based on data conditions. In the example below, for example, the webhook is only activated if TransportInstructions with the Carrier name property equals to POSTNORD. Changes to other TransportInstructions do not activate the webhook.

If you add more filter conditions, logical AND is applied and so the webhook only fires if all conditions are fulfilled.

Hide data fields from being shared

Similar to API tokens, webhooks can be configured to hide sensitive data properties from being shared (they become hidden from the data consumer receiving the webhook notification). You do that by adding filter conditions in the “Exclude” group, visible in the screenshot above.

Configuring the webhook communications method

At the end of the dialog box, you can configure the URL of the web hook (that has to be implemented by your partner the data consumer):