Bruin CLI

Appearance

Notifications ​

Bruin Cloud supports various types of notifications, starting with Slack & Microsoft Teams. These notifications allow you to receive updates on your data pipelines, such as when a pipeline has completed successfully, as well as when a pipeline has failed.

Notifications are always defined on a pipeline level, inside the pipeline.yml file.

Slack ​

INFO

You need to create a Slack connection in Bruin Cloud before you can use Slack notifications. You can do this by navigating to the Connections tab in the Bruin Cloud UI.

Adding Slack notifications is just a few lines of code:

yaml
notifications:
  slack:
    # the only required field is `channel`. By default, this will send both success and failure notifications to this channel.   
    - channel: "#channel1"
    
    # you can have multiple channels, all of them will be notified.
    - channel: "#channel2"
    
    # you can also specify different channels for success and failure notifications
    - channel: "#channel-for-only-success"
      failure: false

    - channel: "#channel-for-only-failure"
      success: false

The full spec for Slack notifications is like this:

yaml
notifications:
  slack:
    - channel: "#your-channel-name"
      success: true
      failure: true

Microsoft Teams ​

INFO

You need to create a Microsoft Teams connection in Bruin Cloud before you can use Teams notifications. You can do this by navigating to the Connections tab in the Bruin Cloud UI.

A Microsoft Teams webhook can be configured per channel, which means you can send notifications to multiple channels by adding separate connections.

The full spec for Microsoft Teams notifications is like this:

yaml
notifications:
  ms_teams:
    - connection: "the-name-of-the-ms-teams-connection"
      success: true
      failure: true

Discord ​

INFO

You need to create a Discord connection in Bruin Cloud before you can use Discord notifications. You can do this by navigating to the Connections tab in the Bruin Cloud UI.

A Discord webhook can be configured per channel, which means you can send notifications to multiple channels by adding separate connections.

The full spec for Discord notifications is like this:

yaml
notifications:
  discord:
    - connection: "the-name-of-the-discord-connection"
      success: true
      failure: true