Skip to main content

Configure notifications

Last updated on

Get started with pipeline notifications

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

Prerequisites

Configure New Channels to sent notification

A new channel can be configured across all scopes. To set up a channel, go to Settings for your desired scope → General → Notification Management, and click Channels as shown below:

  1. Click New Channel and enter a Channel Name.

  2. Choose a Connectivity Mode — you can send notifications either directly through the Harness Platform or via a Harness Delegate.

    connectivity-mode

    If you choose to send notifications through a Harness Delegate, select the appropriate delegate in the Delegate Setup window.

    delegate-mode

  3. Notification Method: Once the connectivity mode is configured, select the Channel Type and add details related to the channel type to proceed.

    note

    If you select the Connectivity Mode as "Connect through a Harness Delegate" and Channel Type as "Email", ensure to add an SMTP configuration to which the Harness delegate has access. If this is not done, then the Email notifications will fail.

Configure pipeline notifications

When configuring pipeline notifications, you select the Pipeline Events that trigger the notification. Available pipeline-level events include start, end, success, failure, pause, and Waiting for User Action. The Waiting for User Action event fires whenever a pipeline pauses because it needs user input, such as an Approval step, Manual Intervention, or runtime execution input. For the full list of events and their behavior, see Add a pipeline notification strategy.

  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.
    • For stage-based events, select the stage name that you want to trigger the notification and click Next.
  4. In Notification Method, select Email. 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.
    • Additionally, use the user group that you created above to receive notifications.
    • You can also use the user group that you created above to receive notifications.
  5. You can optionally add notification templates to get custom notifications based on the event. To learn more, go to Custom Notification templates for Pipeline Notifications.
  6. Select the Connectivity Mode.
    • Connect through Harness Platform to send notifications.
    • Connect through Harness Delegate to send notifications.
      • Select the delegate that you want to use to send notifications.
  7. Select Submit and your notification is created.

More detailed information on how to configure the notification at the receiver end can be found here.

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