Creating and Managing Notification Mediums

A notification medium is used to send notifications when secrets need to be rotated or to send approval requests. While email and email with magic links are the default notification mediums, you can also use other mediums such as Slack or Teams to send notifications. 

An email with a magic link is used for easy approval or rejection of approval requests. An approver receives a unique, one-time-use link via email. This link is used to approve or reject any request. This makes the approval process faster and easier to use on mobile devices. The magic link is valid till the approval request validity. Email and email with a magic link are mutually exclusive notification mediums, you can select either.

Audit log webhooks can also be configured to receive audit logs matching the filter expression. For more information about how to add webhooks, see Managing Webhooks.

Notifications are sent only to active users. But if an inactive user is part of a Slack or Teams channel, the user still receives the notifications as Britive sends notifications to the entire channel. You need to manually remove the inactive members from the Slack or Teams channels. After creating a notification medium, you can create notifications based on the event. For more information about creating notifications, see Workflows.

Adding a Notification Medium

1. Login to Britive.
2. Click on Admin->Global Settings->Notification Mediums.
3. Click the Add Medium button to create a new notification medium.
4. Enter the following on the Add Medium page:
   1. Enter Name.
   2. Enter Description (Optional).
   3. Select the Application from the drop-down list:

      1. Slack Application

         1. Click on the Add to Slack button to install the Slack app. This redirects to the Slack page.
         2. Authenticate and select a workspace in Slack using the following steps:
            1. Log in to Slack if you are not already logged in.
            2. Select the desired Slack workspace from the drop-down list of workspaces.
            3. Click the Allow button to authorize the app. The Britive Slack App is now installed in the selected workspace and is visible to all workspace members.
         3. Enter the Slack workspace name on Britive where the notification medium is created. The required format for the Slack workspace is your-workspace.slack.com.

      2. Slack

         • Generate Bot User OAuth Token using the procedure, Setting up Slack Notification Medium.
         • Enter the Auth Token for the Application BOT.
         • Enter the Slack URL in this format: https://<<company_name>>.slack.com/api/.
         • For more information about Slack bots, see Slack: Enabling interactions with bots.

      3. Teams: Webhook URL of Channel

      4. For more information about getting the Webhook URL of the Channel, see Create an Incoming Webhook.

      5. Webhook

         • Enter the Webhook URL where you would like to receive the activity logs and use it as a notification medium to receive JSON objects for all approvals.
   4. Click Save.

Setting up Slack Notification Medium

Note: Ensure your Slack ID is the same as your email address.

1. Log in to your official Slack account.
2. Create an app to send notifications, if it has not been created already:
   1. Create a new app using Slack API.
   2. Enter the App Name and select a Workspace. 
   3. Click on Create App. It shows the Basic Information page.
3. Select the app created to send notifications. 
4. Select the OAuth & Permissions section from the Features navigation menu and scroll down to Scopes.
5. Click Add an OAuth Scope to add the following scopes one by one: channels:history, channels:join, channels:manage, channels:read, chat:write, users:read, users:read.email, groups:read, groups:write and groups:history.
6. Click on Install to Workspace if the app is created just now, else click on Reinstall to Workspace. 
7. Click Allow to apply the settings and give access to an app.
8. Copy the Bot User OAuth Token, you need to enter this token on the notification medium page.

Note: Make sure the app is added to a private channel.

Managing Notification Mediums

You can manage each notification medium by editing/cloning/deleting it.

1. Login to Britive.
2. Click on Admin->Global Settings->Notification Mediums.
3. A list of all notification mediums is displayed. You can Manage, Clone, or Delete a particular notification medium.
4. Select the notification medium and select any of the following actions:
   a. Manage: You can Edit/Clone/Delete a notification medium.
   b. Clone: You can clone a notification medium and refine the required fields as per your requirements. You cannot edit or clone the application selected while creating a notification medium.
   c. Delete: You can delete a notification medium.