Walkthrough: Adding and configuring a webhook validation action
You can add a webhook validation action to prevent an item from changing workflow state unless validated by a third-party service.
This walkthrough describes how to:
-
Add a webhook validation action.
-
Configure a webhook validation action.
Add a webhook validation action
You can add a webhook validation action to a command item in a workflow. Then, when the command runs, the destination endpoint of the validation action must return a valid response or the item does not change its state.
To add a webhook validation action to a workflow command:
-
In the content tree, navigate to the /sitecore/System/Workflows folder, then expand the workflow where you want to add a webhook validation action.
NoteYou can add a webhook action to the workflow of any item, just like other actions.
-
Right-click on the command where you want to add the webhook validation action, then click Insert, Webhook Validation Action.
-
In the Message dialog, enter a name for the webhook, then click OK.
Configure a webhook validation action
When you add a webhook validation action, you must configure its fields to send requests. You must also set up your endpoint to send a valid response.
To configure a webhook validation action:
-
In the content area of the webhook, in the Information section, in the Description field, enter a description for the webhook.
-
To enable the webhook, in the Data section, select the Enabled check box.
-
In the Url field, enter the endpoint URL for the requests.
-
Optionally, if the destination endpoint requires authentication, in the Authorization drop-down menu, click the authorization item you want to use.
If the appropriate authorization item is not available, you can create a new authorization item.
-
In the Serialization Type drop-down menu, click the payload type you want to use for the webhook validation action request.
If you do not choose a serialization type, JSON is selected by default.
-
Click Save.