Configuring webhook recipients

A webhook is an HTTP-based callback function that allows event-driven communication between web applications. To implement webhooks in Helix ALM you need to:

  • Configure the webhook recipient, which is the destination endpoint for a webhook notification. The webhook recipient is used in the webhook rule. To configure webhook recipients, you must have the Configure Webhook Recipients command security permission. If you do not, please contact your Helix ALM Administrator to enable this.
  • Configure the webhook rule, which contains all the details required to generate webhook notifications when an issue, test case, test run, requirement, or requirement document is added or changed in Helix ALM. To configure a webhook rule, you need to have defined at least one webhook recipient. See Configuring webhook rules

  • In addition to configuring webhooks in Helix ALM, users must also create an HTTPS service that listens for webhook notifications. See About webhooks for information about the JSON payload, custom Helix ALM headers, and additional information that can help you create the HTTPS service.

Note:  Helix ALM has an example webhook service on GitHub you can reference when creating a service to receive webhook notifications from Helix ALM.

This topic explains how to configure webhook recipients in Helix ALM.

When configuring the webhook recipients, the Webhook Recipients dialog shows a list of recipients with the following columns:

Column Description
Name Displays the name of the webhook recipient.
Status Displays the status of the webhook recipient:
  • Enabled: Helix ALM continues to send webhook notifications to the recipient.
  • Disabled: Helix ALM has disabled this recipient due to repeated failures either connecting or sending webhook notifications to the recipient. Hovering over the status column for any disabled recipient displays the last error message stored for the recipient.
URL The URL of the webhook recipient.
Description The description of the webhook recipient.

1. Choose Tools > Administration > Webhook Recipients.

The Webhook Recipients dialog opens.

2. Click Add to add a new webhook recipient. See Adding webhook recipients.

3. Select a recipient and click Edit to edit it. See Editing and deleting webhook recipients. You can also edit a recipient by double-clicking on the recipient from the list.

4. Select a recipient and click Delete to delete it. See Editing and deleting webhook recipients. If the webhook recipient is in use in any webhook rules, it cannot be deleted.

5. To enable a disabled webhook recipient, select the disabled recipient and click Re-enable.

6. Click Close when you are finished configuring the webhook recipients.

After you configure a webhook recipient, you need to add the recipient to a webhook rule. See Configuring webhook rules