How to set up and edit a webhook

A guide to setting up and editing a webhook

How to set up a webhook

To begin setting up a new webhook, click the "Create Webhook" button in the top-right corner of the webhook configuration page.

Webhook configuration page

This will present you with the configrations setup page for the webhook being created.

Webhook configurations setup page

When creating a webhook, choose a title that identifies the webhook and enter the URL you want the webhook to call based on selected events. You can activate or deactivate the webhook by clicking the toggle.

Finally you have the option to add request headers. Once you have configured everything, scroll down to the events section and select the events you want to trigger the webhook.

Selecting events for webhook

Events are when a change is made in the PIM system. An example of this would be when a variant is created, deleted or updated. When one of these events happen, it triggers the webhook to send data to an external system.

Collapsed webhook events section

In the events section, there is a selection of events to choose from when configuring the webhook. Based on the event you want to trigger the webhook, you can expand the events and select from the available options.

Expanded Assets events

By enabling the update event slider, you will be given the option to configure the "Advanced settings" for said event.

When done setting up your webhook, you can save the changes by clicking the "Save"-button in the buttom right of the page.

Example of webhook configuration

Webhook configurations

In the image above the webhook has been given a URL to call when an event is triggered. The title "TestWebhook" is to identify that the webhook is for testing. The webhook has been activated by clicking on the slider but nothing has been added to the header.

Selected events for webhook

The events for when a variant is created and deleted has been enabled to ensure that requests will be sent via the webhook when these changes is made to the variants in the PIM system.

How to edit a webhook

To edit a webhook, hover over the workflow you want to edit. A symbol will appear to the far right of the webhook.

To delete a webhook simply click the "Trash can"-icon when hovering over the webhook.