Configuring a server webhook

Edit online

You can configure a server webhook to send notifications to a messaging application whenever an event occurs on IBM® DevOps Test Hub (Test Hub).

Before you begin

You must have completed the following tasks:

Ensured that you are assigned a role of a Server Administrator. See Managing access to the server projects.

Ensured that you have access to the messaging applications.
Created a channel type.
Configured your messaging application.
Copied the URL of the external communication application. See Creating an incoming webhook.
Created a webhook template. See Configuring a webhook template.

About this task

When you configure a webhook on Test Hub, you must copy the URL of the communication application in the Webhook URL field and paste the outgoing URL, and then select the events. You can select either all events or a subset of events.

You can be notified of the following types of events:

All Events
Team space Events
Project Events
Execution Events
License Events

You can configure the webhook resume policy by selecting either the Queue old messages or Discard old messages option. When a server webhook is disabled due to communication failures or network issues, the server event notifications are not delivered to the configured webhook, and you receive a notification that the webhook is disabled. By configuring the queue old messages, you can ensure that the event notifications are not lost and are delivered to the configured webhook after the server webhook is enabled again.

If you configure the Discard old messages for a server webhook, the event notifications are discarded from the moment the webhook is disabled. Only server events that occur after the webhook is re-enabled are sent to the configured webhook.

Procedure

Log in to Test Hub.
The Projects page of the initial team space is displayed.
Click the Settings icon on the menu bar, and then click Webhooks.
The Templates tab of Webhooks is displayed.
Click the Webhooks tab, and then click New Webhook.

The New Webhook page is displayed.
Enter a name for the webhook and paste the URL that you copied in the Webhook URL field.
You must copy the URL while you configure your communication application.
Click the Webhook resume policy, and then select a resume policy option from the drop-down list. You can select any of the following options:
1. Queue old messages
2. Discard old messages
Click the Channel Type, and then select a channel type from the list.
Enter a description for the webhook, and then select a template from the drop-down list.
A corresponding event that you configured for the template is displayed in the Events field.
Click the Templates icon , to add the templates that are configured for the channel type.

Note: If you want to change the events, then click the events option and select the required events.
You can perform any of the following steps:
1. Click move the template to a higher priority icon to move the template to a higher priority.
2. Click move the template to a lower priority icon to move the template to a lower priority.
Click Apply.
The webhook is created and added to the Webhooks tab.

Results

You have configured and created a server webhook on Test Hub.

What to do next

You can perform any of the following tasks:

You can duplicate or delete the template that you created on Test Hub. See Managing the webhook template configuration.
You can duplicate or delete the webhook you created on Test Hub. See Managing the webhook configuration.