Adding webhook recipients

A webhook recipient defines all required information regarding the destination endpoint for a webhook notification. This includes (but is not limited to) the destination URL, any security options that should be applied, and any additional header information the recipient expects to be sent with webhook notifications.

1. Choose Tools > Administration > Webhook Recipients.

The Webhook Recipients dialog opens.

2. Click Add to add a new webhook recipient.

The Add Webhook Recipient dialog box opens.

3. Enter and select the basic recipient information.

• Name identifies the webhook recipient. You can enter up to 32 characters.
• Description provides additional information about the webhook recipient. You can enter up to 255 characters.
• URL is the URL of the webhook recipient. The URL must start with "https://". You can enter up to 2048 characters.

4. Select Batch notifications for different items into a single request to batch webhook actions into a single webhook request. If the same webhook is invoked many times in a short period of time, this setting instructs Helix ALM to bundle these requests and run a single webhook with a list of change actions rather than invoking the same webhook many times.

5. Add or edit the verification signature the webhook sends to the recipient by selecting Change from the Security section. See Changing webhook signatures.

6. Optionally, click Revoke to revoke the previous signature configuration immediately. This button is only visible when the recipient has a prior signature configuration that is being used to generate secondary signatures. A secondary signature lasts 24 hours to give you time to update all webhook recipients without disrupting your use of webhooks.

7. Click Add to add an additional header. See Adding webhook headers.

8. Select a header and click Edit to edit it. See Adding webhook headers. You can also edit a header by double-clicking on it from the list.

9. Select a header and click Delete to delete it.

10. Click Test Connection to test the connection to the webhook recipient based on the current configuration in the dialog. Any error message generated when testing the connection is appended to the standard message indicating an error occurred.

To test the connection, Helix ALM Server sends a ping package to the URL to verify that the URL is valid and if the recipient can parse the content of Helix ALM webhooks and validate the signature. However the validation of the signature is dependent on the recipient being set up to understand Helix ALM request data.

11. Click Save to save the webhook recipient.