Skip to main content

Overview

In this step, you will create a Webhook that will later be connected to the Rule you created in the previous tutorial. Webhooks in Sift are created and managed from the Manage page.

Create a Webhook

Let’s create a Webhook.
  1. Click your profile menu.
  2. Select Manage, then open Webhooks from the navigation menu.
  3. Click Create webhook.
  4. In the Webhook name box, enter the following:
    fl_tutorial_5_webhook
    
  5. Replace fl (in fl_tutorial_5_webhook) with your initials (first and last name).
  6. In Trigger event type, select Rule violation.
  7. In Destination URL, enter the the following:
    https://example.com/webhook
    
    • This is an example destination URL. It is provided so you can continue through the Webhook configuration flow. In a real environment, this would be replaced with the URL of a system that can accept Webhooks.
  8. Click Next. On this page, you can specify custom HTTP headers and send a test notification to the selected destination URL. You can also define the payload that will be sent when the Webhook fires, either by using built-in variables or by starting from one of the available templates. For the purposes of this tutorial, you will use one of the templates to send a payload to Slack when the Rule created in the previous tutorial enters a violated or resolved state during live data evaluation.
  9. In the Payload config list, select Slack. The Slack template you selected uses built-in variables associated with the Rule Violation trigger event type. These variables allow the payload to include useful context about the Rule and where it was evaluated.
    • {{.RuleName}} and {{.RuleVersion}} identify the Rule that triggered the Webhook
    • {{.Status}} indicates whether the Rule entered a violated or resolved state
    • {{.AssetName}} and {{.RunId}} provide context about the Asset and Run involved in the evaluation
    Sift replaces these placeholders automatically when sending the Webhook.
  10. Click Save.