Skip to main content

Walkthrough: Adding and configuring a webhook submit action

Abstract

Describes how to add and configure 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.

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 URL.

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:

  1. In the content tree, navigate to the /sitecore/System/Workflows folder, then expand the workflow where you want to add a webhook submit action.

    Note

    You can add a webhook action to the workflow of any item, just like other actions.

  2. Right-click on the state or action where you want to add a webhook submit action, then click Insert, Webhook Submit Action.

  3. In the Message dialog, enter a name for the webhook, then click OK.

When you add a webhook submit action, you must configure its fields to send requests.

To configure a webhook submit action:

  1. In the content area of the webhook, in the Information section, in the Description field, enter a description for the webhook.

  2. To enable the webhook, in the Data section, select the Enabled check box.

  3. In the Url field, enter the destination URL for the requests.

  4. Optionally, if the destination URL 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.

  5. 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.

  6. Click Save.