Webhooks Configuration

Who can use this feature? 

Super users and Users with Read/Write permissions for Manage Webhooks module

Available on Accounts with subscription to Manage Webhooks module.

How to configure webhooks?

1. Navigate to Channels > Connectors > Manage Webhooks.

2. Create new config using 'Create Webhooks' button.

On clicking “Create New Webhooks” it will redirect to the page in which user should be able to register the webhook and subscribe to the events that user needs

3. Configure the webhooks with the required fields.

• Webhook Name is mandatory
• Destination URL - Valid URL should be given
• Auth Type is mandatory
• Content Type is mandatory
• Event subscription  - Minimum one event should be subscribed

4. Click Next button to select 'Channel' and 'Store'

Channel selection is mandatory. At Least one channel should be selected

Multiple selection is allowed

5. Click 'Next' button to filter the attributes which should be the source for webhooks trigger.

Column Filter - Webhooks will be triggered if the attributes in Column Filter are updated. This depends on the attributes
Row Filter - Webhooks will be triggered if the attribute values defined in the configuration are equal or not equal. This depends on the attribute values

6. Click 'Next' button to configure the attributes which should be listed in JSON

If Send only updated attribute is selected, only updated attributes will be sent

If From Value is selected, then old value will also be sent in JSON

Either “Key Value Pair” or “Array” Object Type can be selected.

Object Hierarchy can mentioned, so that JSON will be created accordingly

Preview of the JSON can be viewed using “Preview” option

Once this is saved, events will be triggered to the URL which was configured

How to Enable/Disable Webhooks 

By default once it is created it will be enabled and the user can able to disable it at any time

How to edit Webhook 

On clicking the edit button, the user will be able to edit the existing webhook. On editing if they unselect products and after completing the entire 4 steps and on clicking save the others steps which are only relevant to product events will be removed.

How to delete Webhook

On deleting Webhook, JSON notification messages to the endpoint will be stopped.

How to get Webhooks log

Click on Webhook logs to download the log/error file