Skip to main content

Walkthrough: Adding and configuring a webhook validation action

Abstract

Describes how to add and configure a webhook validation item.

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.

You can add a webhook validation action to a command item in a workflow. Then, when the command runs, the destination URL 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:

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

    Note

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

  2. Right-click on the command where you want to add the webhook validation action, then click Insert, Webhook Validation Action.

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

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:

  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 validation action request.

    If you do not choose a serialization type, JSON is selected by default.

  6. Click Save.