Chapter 1. Integrating communications applications with the Hybrid Cloud Console

Procedure

1. Create a new channel in Microsoft Teams or select an existing channel.
2. Navigate to Apps and search for the Incoming Webhook application.
3. Select the Incoming Webhook application and click Add to a team.
4. Select the team or channel name and click Set up a connector.
5. Enter a name for the incoming webhook (for example, Red Hat Notifications). This name appears on all notifications that the Microsoft Teams channel receives from the Red Hat Hybrid Cloud Console through this incoming webhook.
6. Optional: Upload an image to associate with the name of the incoming webhook. This image appears on all notifications that the Microsoft Teams channel receives from the Hybrid Cloud Console through this incoming webhook.
7. Click Create to complete creation and display the webhook URL.
8. Copy the URL to your clipboard. You need the URL to configure notifications in the Hybrid Cloud Console.
9. Click Done. The Microsoft Teams page displays the channel and the incoming webhook.
10. In the Hybrid Cloud Console, navigate to Settings > Integrations.
11. Click the Communications tab.
12. Click Add integration.
13. Select Microsoft Office Teams as the integration type, and then click Next.
14. In the Integration name field, enter a name for your integration (for example, console-teams).
15. Paste the incoming webhook URL that you copied from Microsoft Teams into the Endpoint URL field.
16. Click Next.

17. Optional: Associate events with the integration. Doing this automatically creates a behavior group.

    Note

    You can skip this step and associate the event types later.

    1. Select a product family, for example OpenShift, Red Hat Enterprise Linux, or Console.
    2. Select the event types you would like your integration to react to.
18. To enable the integration, review the integration details and click Submit.
19. Refresh the Integrations page to show the Microsoft Teams integration in the Integrations > Communications list. Under Last connection attempt, the status is Ready to show the connection can accept notifications from the Hybrid Cloud Console.

1. Next to your Microsoft Teams integration on the Integrations > Communications page, click the options icon (⋮) and click Test.
2. In the Integration Test screen, enter a message and click Send. If you leave the field empty, the Hybrid Cloud Console sends a default message.
3. Open your Microsoft Teams channel and check for the message sent from the Hybrid Cloud Console.
4. In the Hybrid Cloud Console, go to Notifications > Event Log and check that the Integration: Microsoft Teams event is listed with a green label.

Procedure

1. In the Hybrid Cloud Console, navigate to Settings > Notifications.
2. Under Notifications, select Configure Events.
3. Select the application bundle tab you want to configure event notification behavior for: Red Hat Enterprise Linux, Console, or OpenShift.
4. Click the Behavior Groups tab.
5. Click Create new group to open the Create behavior group wizard.
6. Type a name for the behavior group and click Next.
7. In the Actions and Recipients step, select Integration: Microsoft Teams from the Actions drop-down list.
8. From the Recipient drop-down list, select the name of the integration you created (for example, console-teams) and click Next.
9. In the Associate event types step, select one or more events for which you want to send notifications (for example, Policies: Policy triggered) and click Next.
10. Review your behavior group settings and click Finish. The new behavior group appears on the Notifications > Configure Events page in the Behavior Groups tab.

Verification

1. Create an event that will trigger a Hybrid Cloud Console notification. For example, run insights-client on a system that will trigger a policy event.
2. Wait a few minutes, and then navigate to Microsoft Teams.
3. Select the channel that you configured from the left menu. If the setup process succeeded, the page displays a notification from the Hybrid Cloud Console. The notification contains the name of the host that triggered the event and a link to that host, as well as the number of events and a link that opens the corresponding Hybrid Cloud Console service.

4. In the Hybrid Cloud Console, go to Settings > Notifications > Event Log and check for an event that shows the label Integration: Microsoft Teams.

   • If the label is green, the notification succeeded.

   • If the label is red, verify that the incoming webhook connector was properly created in Microsoft Teams, and that the correct incoming webhook URL is added in the Hybrid Cloud Console integration configuration.

     Note

     See Troubleshooting notification failures in the notifications documentation for more details.

Procedure

1. In your Google space, click the arrow on the space name to open the dropdown menu:

   1. Select Apps & Integrations.
   2. Click Webhooks.

2. Enter the following information in the Incoming webhooks dialog:

   1. Enter a name for the integration (for example, Engineering Google Chat).
   2. Optional: To add an avatar for the notifications, enter a URL to an image.
   3. Click Save to generate the webhook URL.
   4. Copy the webhook URL to use for configuration in the Hybrid Cloud Console.

Procedure

1. In the Hybrid Cloud Console, navigate to Settings > Integrations.
2. Select the Communications tab.
3. Click Add integration.
4. Select Google Chat as the integration type, and then click Next.
5. In the Integration name field, enter a name for your integration (for example, console-gchat).
6. Paste the incoming webhook URL that you copied from your Google space into the Endpoint URL field, and click Next.

7. Optional: Associate events with the integration. Doing this automatically creates a behavior group.

   Note

   You can skip this step and associate the event types later.

   1. Select a product family, for example OpenShift, Red Hat Enterprise Linux, or Console.
   2. Select the event types you would like your integration to react to.
8. To enable the integration, review the integration details and click Submit.
9. Refresh the Integrations page to show the Google Chat integration in the Integrations > Communications list. Under Last connection attempt, the status is Ready to show the connection can accept notifications from the Hybrid Cloud Console.

1. Next to your Google Chat integration on the Integrations > Communications page, click the options icon (⋮) and click Test.
2. In the Integration Test screen, enter a message and click Send. If you leave the field empty, the Hybrid Cloud Console sends a default message.
3. Open your Google space and check for the message sent from the Hybrid Cloud Console.
4. In the Hybrid Cloud Console, go to Notifications > Event Log and check that the Integration: Google Chat event is listed with a green label.

Procedure

1. In the Hybrid Cloud Console, navigate to Settings > Notifications.
2. Under Notifications, select Configure Events.
3. Select the application bundle tab you want to configure event notification behavior for: Red Hat Enterprise Linux, Console, or OpenShift.
4. Click the Behavior Groups tab.
5. Click Create new group to open the Create behavior group wizard.
6. Type a name for the behavior group and click Next.
7. In the Actions and Recipients step, select Integration: Google Chat from the Actions drop-down list.
8. From the Recipient drop-down list, select the name of the integration you created (for example, console-gchat) and click Next.
9. In the Associate event types step, select one or more events for which you want to send notifications (for example, Policies: Policy triggered) and click Next.
10. Review your behavior group settings and click Finish. The new behavior group is listed on the Notifications page.

Verification

1. Create an event that will trigger a Hybrid Cloud Console notification. For example, run insights-client on a system that will trigger a policy event.
2. Wait a few minutes, and then navigate to Google Chat.
3. In your Google Space, check for notifications from the Hybrid Cloud Console.

4. In the Hybrid Cloud Console, go to Settings > Notifications > Event Log and check for an event that shows the label Integration: Google Chat.

   • If the label is green, the notification succeeded.
   • If the label is red, the integration might need to be adjusted.
5. If the integration is not working as expected, verify that the incoming webhook connector was properly created in Google Chat, and that the correct incoming webhook URL is added in the Hybrid Cloud Console integration configuration.

Procedure

1. Create a Slack app:

   1. Go to the Slack API web page and click the Create your Slack app button. This opens the Create an app dialog.
   2. Select From scratch to use the Slack configuration UI to create your app.

   3. Enter a name for your app and select the workspace where you want to receive notifications.

      Note

      If you see a message that administrator approval is required, you can request approval in the next step.

   4. Click Create App to finish creating the Slack app.

2. Enable incoming webhooks:

   1. Under the Features heading in the navigation panel, click Incoming Webhooks.
   2. Toggle the Activate Incoming Webhooks switch to On.
   3. Click the Request to Add New Webhook button. If required, enter a message to your administrators to grant access to your app and click Submit Request. A success message confirms you have configured this correctly.

3. Create an incoming webhook:

   1. Under Settings in the navigation panel, click Install App.
   2. In the Install App section, click the Install to workspace button.
   3. Select the channel where you want your Slack app to post notifications, or select a user to send notifications to as direct messages.
   4. Click Allow to save changes.

4. Optional: Configure how your Hybrid Cloud Console notifications appear in Slack:

   1. Under Settings in the navigation panel, click Basic Information.
   2. Scroll down to Display Information.
   3. Edit your app name, description, icon, and background color as desired.
   4. Click Save Changes.

5. Copy the webhook URL:

   1. Under Features, click Incoming Webhooks.
   2. Click the Copy button next to the webhook URL. You will use the URL to set up the integration in the Hybrid Cloud Console in Section 1.3.2, “Configuring the Slack integration in the Red Hat Hybrid Cloud Console”.

Procedure

1. If necessary, go to the Slack API web page and copy the webhook URL that you configured.

   Note

   See Section 1.3.1, “Configuring incoming webhooks in Slack” for the steps to create a Slack webhook URL.

2. In the Hybrid Cloud Console, navigate to Settings > Integrations.
3. Select the Communications tab.
4. Click Add integration.
5. Select Slack as the integration type and click Next.
6. Enter a name for the integration (for example, My Slack notifications).
7. Paste the Slack webhook URL that you copied from Slack into the Workspace URL field and click Next.

8. Optional: Associate events with the integration. Doing this automatically creates a behavior group.

   Note

   You can skip this step and associate the event types later.

   1. Select a product family, for example OpenShift, Red Hat Enterprise Linux, or Console.
   2. Select the event types you want your integration to react to and click Next.
9. To enable the integration, review the integration details and click Submit.
10. Refresh the Integrations page to show the Slack integration in the Integrations > Communications list. Under Last connection attempt, the status is Ready to show the connection can accept notifications from the Hybrid Cloud Console.

1. Next to your Slack integration on the Integrations > Communications page, click the options icon (⋮) and click Test.
2. In the Integration Test screen, enter a message and click Send. If you leave the field empty, the Hybrid Cloud Console sends a default message.
3. Open the Slack channel you configured and check for the message sent from the Hybrid Cloud Console.
4. In the Hybrid Cloud Console, go to Notifications > Event Log and check that the Integration: Slack event is listed with a green label.

Procedure

1. In the Hybrid Cloud Console, navigate to Settings > Notifications.
2. Under Notifications, select Configure Events.
3. Select the application bundle tab you want to configure event notification behavior for: Red Hat Enterprise Linux, Console, or OpenShift.
4. Click the Behavior Groups tab.
5. Click Create new group to open the Create behavior group wizard.
6. Enter a name for the behavior group and click Next.
7. In the Actions and Recipients step, select Integration: Slack from the Actions drop-down list.

8. From the Recipient drop-down list, select the name of the integration you created (for example, My Slack notifications) and click Next.

   

9. In the Associate event types step, select one or more events for which you want to send notifications (for example, Policies: Policy triggered) and click Next.

10. Review your behavior group settings and click Finish. The new behavior group appears on the Notifications > Configure Events page in the Behavior Groups tab.

    Note

    You can create and edit multiple behavior groups to include any additional platforms that the notifications service supports.

11. Select Settings > Integrations and click the Communications tab. When the Slack integration is ready to send events to Slack, the Last connection attempt column shows Ready. If the notification reached Slack successfully, the Last connection attempt column shows Success.

    

Verification

1. Create an event that will trigger a Hybrid Cloud Console notification. For example, run insights-client on a system that will trigger a policy event.
2. Wait a few minutes, and then navigate to Slack.
3. In your Slack channel, check for notifications from the Hybrid Cloud Console.

4. In the Hybrid Cloud Console, go to Settings > Notifications > Event Log and check for an event that shows the label Integration: Slack.

   • If the label is green, the notification succeeded.
   • If the label is red, the integration might need to be adjusted.

5. If the integration is not working as expected, verify that the incoming webhook connector was properly created in Slack, and that the correct incoming webhook URL is added in the Hybrid Cloud Console integration configuration.

   Note

   See Troubleshooting notification failures in the notifications documentation for more details.