Manage webhooks (Beta)

Overview

This guide shows how to manage webhook integrations using the Webhooks section in Sift's Manage Workspace.

Instructions

Create a webhook (with the option to test it)

To create a webhook with the option to test it before saving it:

1. Click your profile icon, which shows the first initial of your account name.
2. Select Manage.
3. In the Manage navigation menu, click Webhooks.
4. Click Create webhook.
5. In the Webhook name box, enter a name for the webhook.
6. In the Trigger event type list, select a trigger event type.

   To learn about available trigger event types, see Trigger event types.

7. In the Destination URL box, enter the destination (target) URL.
8. Click Next.
9. Optional: Configure custom HTTP headers.
   1. Click + Add header
   2. In the Key list, select an HTTP header.
   3. In the Value box, enter the corresponding value for the HTTP header key.
10. In the Payload config template list, select a payload configuration template for the trigger event type.
11. Edit/create the payload body.

    To learn about webhook payloads, see:

    • Webhook payloads
    • Populate a webhook's payload with Rule context using built-in variables from a Rule Violation trigger
12. Optional: Test webhook.
    1. Click Test webhook.
       • When you click Test webhook, Sift sends a webhook using your configured payload to the specified destination URL and display the exact response received from the target system.
       • Sift does not retain logs generated from test webhook executions.
13. Click Save.

Edit a webhook (with the option to test the edits)

To edit a webhook and test its edits:

1. Click your profile icon, which shows the first initial of your account name.
2. Select Manage.
3. In the Manage navigation menu, click Webhooks.
4. In the Webhooks table, click the webhook to edit.
5. Click Edit.
6. Edit the webhook.
7. Optional: Test the edits.
   1. Click Test webhook.
      • When you click Test webhook, Sift sends a webhook using your configured payload to the specified destination URL and display the exact response received from the target system.
      • Sift does not retain logs generated from test webhook executions.
8. Click Save.

Archive a webhook

To archive a webhook:

1. Click your profile icon, which shows the first initial of your account name.
2. Select Manage.
3. In the Manage navigation menu, click Webhooks.
4. In the Webhooks table, click the webhook to archived.
5. Click More options.
6. Click Archive.
7. In the Archive webhoo pop-up box, click Archive.

Unarchive a webhook

To unarchive a webhook:

1. Click your profile icon, which shows the first initial of your account name.
2. Select Manage.
3. In the Manage navigation menu, click Webhooks.
4. In the Webhooks table, click Show archived
5. In the Webhooks table, click the webhook to unarchived.

Configure a webhook for a Rule

To configure a webhook for a Rule:

1. In Sift, click .
2. Click the Rules. tab.
3. In the Rules table, click the Rule you want to configure a webhook for.
4. Click Edit.
5. In the Webhook card, click + Configure webhook.
6. In the Webhooks table, select the Rule you want to configure a webhook for by clicking its name.
7. Click Select.
8. Click Save.
9. Click Publish.

View a webhook's logs

To view a webhook's logs:

1. Click your profile icon, which shows the first initial of your account name.
2. Select Manage.
3. In the Manage navigation menu, click Webhooks.
4. In the Webhooks table, click the webhook whose logs you want to view.
5. Click the Logs tab.

Generate the webhook signing key

To generate the webhook signing key:

1. Click your profile icon, which shows the first initial of your account name.
2. Select Manage.
3. In the Manage navigation menu, click Webhooks.
4. Click Generate key.

Obtain (that is, copy) the webhook signing key

To obtain (that is, copy) the webhook signing key:

1. Click your profile icon, which shows the first initial of your account name.
2. Select Manage.
3. In the Manage navigation menu, click Webhooks.
4. Click Copy.

Examples

Populate a webhook's payload with Rule context using built-in variables from a Rule Violation trigger

Each trigger event type includes a set of built-in variables that are available for use and viewing when creating or editing a webhook. These variables can be used to customize the webhook payload with dynamic, event-specific data.

This table lists the built-in variables available for the Rule Violation trigger event type. These variables can be included in the payload of any webhook configured with this trigger.

Here's an example payload definition using the built-in variables for a Rule Violation trigger, followed by a sample of what it might look like after being populated:

{
  "ruleName": "{{.RuleName}}",
  "status": "{{.Status}}",
  "webhookId": "{{.WebhookId}}",
  "eventId": "{{.EventId}}",
  "ruleId": "{{.RuleId}}",
  "ruleVersion": "{{.RuleVersion}}",
  "assetName": "{{.AssetName}}",
  "runId": "{{.RunId}}",
  "sentAt": "{{.SentAt}}"
}

{
  "ruleName": "Battery spike check",
  "status": "violated",
  "webhookId": "123",
  "eventId": "123",
  "ruleId": "123",
  "ruleVersion": 1,
  "assetName": "Rover",
  "runId": "123",
  "sentAt": "2025-06-05T16:42:10Z"
}