Walkthrough: Adding and configuring a webhook submit action
You can add a webhook submit action to a workflow to inform you when an item workflow state changes or when a command runs.
This walkthrough describes how to:
-
Add a webhook submit action.
-
Configure a webhook submit action.
Add a webhook submit action
You can add a webhook submit action to a state or action of a workflow. Then, when an item using this workflow moves to the state or runs the command that contains the webhook, XM sends a request to the specified endpoint.
You can find a Sample Webhook Workflow
in the /sitecore/System/Workflows folder.
To add a webhook submit action to a workflow state or action:
-
In the content tree, navigate to the /sitecore/System/Workflows folder, then expand the workflow where you want to add a webhook submit action.
NoteYou can add a webhook action to the workflow of any item, just like other actions.
-
Right-click on the state or action where you want to add a webhook submit action, then click Insert, Webhook Submit Action.
-
In the Message dialog, enter a name for the webhook, then click OK.
Configure a webhook submit action
When you add a webhook submit action, you must configure its fields to send requests.
To configure a webhook submit 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 submit action request.
If you do not choose a serialization type, JSON is selected by default.
-
Click Save.