Notification settings

With notification settings, you can enable or disable notification channels at an account level. By default, all notification channels are enabled on an account. Organizations and projects in the account inherit the account-level settings.

When a notification channel is in the disabled state, no notification is sent for that channel, whether existing or new, until you enable the channel again.

You can enable or disable the following notification channels:

• Slack
• Microsoft Teams
• Webhooks
• PagerDuty

To disable a given notification channel, in Harness, go to Account Settings > Account Resources > Default Settings > Notifications, and then turn off the corresponding toggle.

With notification settings, you can add domain allowlists for notification channels at the account level. This feature enables you to specify fixed URL domains to which notifications can be sent. Expression URLs are not yet supported.

To add a domain filter to a notification channel, navigate to Account Settings > Account Resources > Default Settings > Notifications in the Harness platform and add the fixed URL domain to the corresponding notification setting.

You can add domain filter to the following notification channels:

• Email
• Slack
• Microsoft Teams
• Webhooks
• PagerDuty

When a domain is added to a notification channel's domain allowlist, only recipients whose domains are present in the allowlist will receive notifications from that channel. This applies to both existing and new recipients until their domain is added to the channel's domain allowlist.

Get started with notifications

Learn how to notify users of different pipeline events using popular notification methods.

Prerequisites

• You need a Harness pipeline with active delegates and connectors. You can follow the tutorial to get started with Harness Continuous Delivery (CD) to set up a sample pipeline.
• These steps use Harness user groups to manage user access. If you want to follow along, create a user group named notification-demo at the account level, and then add yourself as a user in that group.

Configure pipeline notifications

Email

1. Select the Notify icon on the right side of the Harness pipeline studio.
2. In New Notification, add a name for your notification.
3. In Pipeline Events, select the events (pipeline or stages) that will trigger the notification.
4. For stage-based events, select the stage name that you want to trigger the notification and click Next.
5. In Notification Method, select Email.
6. For email notifications, simply type in the email addresses that you want to notify.
   • Enter multiple addresses as a comma-separated list. For example, john.doe@example.io,qateam@example.io.
7. Additionally, use the user group that you created above to receive notifications.
8. Select Finish and your notification is created.

Slack

To configure Slack notifications, you need to create a Slack webhook. For more information, go to the sending messages using incoming webhooks tutorial provided by Slack. Copy and store the webhook URL for use in Harness.

1. Select the Notify icon on the right side of the Harness pipeline studio.
2. In New Notification, add a name for your notification.
3. In Pipeline Events, select the events (pipeline or stages) that will trigger the notification.
4. For stage-based events, select the stage name that you want to trigger the notification and click Next.
5. In Notification Method, select Slack.
6. Paste the webhook in Slack Webhook URL. Harness recommends that you add the webhook as an encrypted text secret and reference it in Slack Webhook URL as an expression, such as <+secrets.getValue("slackwebhookURL")>.
7. Now additionally you can use the user-group created above, if it is associated with the slack channels to send notifications, for more information on the same follow the instructions mentioned here
8. Select Finish and your notification is created.

PagerDuty

To configure PagerDuty notification, you need a PagerDuty service key to integrate with Harness. Copy or store this key from PagerDuty's Configuration > Services > Service Details dialog > Integrations tab.

1. Select the Notify icon on the right side of the Harness pipeline studio.
2. In New Notification, add a name for your notification.
3. In Pipeline Events, select the events (pipeline or stages) that will trigger the notification.
4. For stage-based events, select the stage name that you want to trigger the notification and click Next.
5. In Notification Method, select Pagerduty.
6. Create an encrypted text secret with the name pagerdutykey for the PagerDuty service you have created above, and reference it in PagerDuty Key using an expression. Harness will send notifications using this key.
   • For example, you can reference a secret within the Org scope using an expression with org:

   <+secrets.getvalue("org.your-secret-Id")>
7. Select Finish and your PagerDuty notification is created.

Microsoft Teams

For steps on creating Microsoft Teams notifications, follow the detailed instructions here.

Webhook

In Harness you can use webhook notifications to inform an external application of a pipeline/stage event.

1. Select the Notify icon on the right side of the Harness pipeline studio.

2. In New Notification, add a name for your notification.

3. In Pipeline Events, select the events (pipeline or stages) that will trigger the notification.

4. For stage-based events, select the stage name that you want to trigger the notification and click Next.

5. In Notification Method, select Webhook.

6. In Enter the URL to be called, use expressions to compose the URL to be called when the event occurs. For example, https://companyurl.notify.com/execution=-<+pipeline.executionId>.

   The webhook call is made as a POST request, and includes a JSON object containing the properties of the triggered event.

   The expression must be evaluated in the context of the event. For example, stage-related expressions might not be valid for pipeline start events.

7. Select Finish and your Webhook notification is created.

When you run the pipeline, you'll receive notifications on the platform you set up.