Chapter 1. Integrating communications applications with the Hybrid Cloud Console Receive event notifications in your preferred communications application by connecting the Hybrid Cloud Console with Microsoft Teams, Google Chat, or Slack. 1.1. Integrating Microsoft Teams with the Hybrid Cloud Console You can configure the Red Hat Hybrid Cloud Console to send event notifications to all users on a new or existing channel in Microsoft Teams. The Microsoft Teams integration supports events from all services in the Hybrid Cloud Console. The Microsoft Teams integration uses incoming webhooks to receive event data. Contacting support If you have any issues with integrating the Hybrid Cloud Console with Microsoft Teams, contact Red Hat for support. You can open a Red Hat support case directly from the Hybrid Cloud Console by clicking Help ( ? icon) > Open a support case , or view more options from ? > Support options . Microsoft will not provide troubleshooting. The Hybrid Cloud Console integration with Microsoft Teams is fully supported by Red Hat. 1.1.1. Configuring Microsoft Teams for integration with the Hybrid Cloud Console You can use incoming webhooks to configure Microsoft Teams to receive event notifications from the Red Hat Hybrid Cloud Console or a third-party application. Prerequisites You have admin permissions for Microsoft Teams. You have Organization Administrator or Notifications administrator permissions for the Hybrid Cloud Console. Procedure Create a new channel in Microsoft Teams or select an existing channel. Navigate to Apps and search for the Incoming Webhook application. Select the Incoming Webhook application and click Add to a team . Select the team or channel name and click Set up a connector . 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. 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. Click Create to complete creation and display the webhook URL. Copy the URL to your clipboard. You need the URL to configure notifications in the Hybrid Cloud Console. Click Done . The Microsoft Teams page displays the channel and the incoming webhook. In the Hybrid Cloud Console, navigate to Settings > Integrations . Click the Communications tab. Click Add integration . Select Microsoft Office Teams as the integration type, and then click . In the Integration name field, enter a name for your integration (for example, console-teams ). Paste the incoming webhook URL that you copied from Microsoft Teams into the Endpoint URL field. Click . 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. Select a product family, for example OpenShift , Red Hat Enterprise Linux , or Console . Select the event types you would like your integration to react to. To enable the integration, review the integration details and click Submit . 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. Verification Create a test notification to confirm you have correctly connected Microsoft Teams to the Hybrid Cloud Console: to your Microsoft Teams integration on the Integrations > Communications page, click the options icon (...) and click Test . 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. Open your Microsoft Teams channel and check for the message sent from the Hybrid Cloud Console. In the Hybrid Cloud Console, go to Notifications > Event Log and check that the Integration: Microsoft Teams event is listed with a green label. Additional resources For more information about setting up Notifications administrator permissions, see Configure User Access to manage notifications in the notifications documentation. 1.1.2. Creating the behavior group for the Microsoft Teams integration A behavior group defines which notifications will be sent to external services such as Microsoft Teams when a specific event is received by the notifications service. You can link events from any Red Hat Hybrid Cloud Console service to your behavior group. For more information about behavior groups, see Configuring Hybrid Cloud Console notification behavior groups . Prerequisites You are logged in to the Hybrid Cloud Console as an Organization Administrator or as a user with Notifications administrator permissions. The Microsoft Teams integration is configured. For information about configuring Microsoft Teams integration, see Section 1.1.1, "Configuring Microsoft Teams for integration with the Hybrid Cloud Console" . Procedure In the Hybrid Cloud Console, navigate to Settings > Notifications . Under Notifications , select Configure Events . Select the application bundle tab you want to configure event notification behavior for: Red Hat Enterprise Linux , Console , or OpenShift . Click the Behavior Groups tab. Click Create new group to open the Create behavior group wizard. Type a name for the behavior group and click . In the Actions and Recipients step, select Integration: Microsoft Teams from the Actions drop-down list. From the Recipient drop-down list, select the name of the integration you created (for example, console-teams ) and click . 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 . 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 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. Wait a few minutes, and then navigate to Microsoft Teams. 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. 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. 1.1.3. Additional resources For information about troubleshooting your Microsoft Teams integration, see Troubleshooting Hybrid Cloud Console integrations . For more information about webhooks, see Create an Incoming Webhook and Webhooks and Connectors in the Microsoft Teams documentation. 1.2. Integrating Google Chat with the Red Hat Hybrid Cloud Console You can configure the Red Hat Hybrid Cloud Console to send event notifications to a new or existing Google space in Google Chat. The Google Chat integration supports events from all Hybrid Cloud Console services. The integration with the Hybrid Cloud Console notifications service uses incoming webhooks to receive event data. Each Red Hat account configures how and who can receive these events, with the ability to perform actions depending on the event type. Contacting Support If you have any issues with the Hybrid Cloud Console integration with Google Chat, contact Red Hat for support. You can open a Red Hat support case directly from the Hybrid Cloud Console by clicking Help > Open a support case , or view more options from Help > Support options . Google will not provide troubleshooting. The Hybrid Cloud Console integration with Google Chat is fully supported by Red Hat. 1.2.1. Configuring incoming webhooks in Google Chat In Google spaces, create a new webhook to connect with the Hybrid Cloud Console. Prerequisites You have a new or existing Google space in Google Chat. Procedure In your Google space, click the arrow on the space name to open the dropdown menu: Select Apps & Integrations . Click Webhooks . Enter the following information in the Incoming webhooks dialog: Enter a name for the integration (for example, Engineering Google Chat ). Optional: To add an avatar for the notifications, enter a URL to an image. Click Save to generate the webhook URL. Copy the webhook URL to use for configuration in the Hybrid Cloud Console. Additional resources See Send messages to Google Chat with incoming webhooks in the Google Chat documentation for more detailed information about Google Chat configuration. 1.2.2. Configuring the Google Chat integration in the Red Hat Hybrid Cloud Console Create a new integration in the Hybrid Cloud Console using the webhook URL from Google Chat. Prerequisites You are logged in to the Hybrid Cloud Console as an Organization Administrator or as a user with Notifications administrator permissions. You have a Google Chat incoming webhook. Procedure In the Hybrid Cloud Console, navigate to Settings > Integrations . Select the Communications tab. Click Add integration . Select Google Chat as the integration type, and then click . In the Integration name field, enter a name for your integration (for example, console-gchat ). Paste the incoming webhook URL that you copied from your Google space into the Endpoint URL field, and click . 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. Select a product family, for example OpenShift , Red Hat Enterprise Linux , or Console . Select the event types you would like your integration to react to. To enable the integration, review the integration details and click Submit . 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. Verification Create a test notification to confirm you have successfully connected Google Chat to the Hybrid Cloud Console: to your Google Chat integration on the Integrations > Communications page, click the options icon (...) and click Test . 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. Open your Google space and check for the message sent from the Hybrid Cloud Console. In the Hybrid Cloud Console, go to Notifications > Event Log and check that the Integration: Google Chat event is listed with a green label. Additional resources For more information about setting up Notifications administrator permissions, see Configure User Access to manage notifications in the notifications documentation. 1.2.3. Creating the behavior group for the Google Chat integration A behavior group defines which notifications will be sent to external services such as Google Chat when a specific event is received by the notifications service. You can link events from any Red Hat Hybrid Cloud Console service to your behavior group. Prerequisites You are logged in to the Hybrid Cloud Console as an Organization Administrator or as a user with Notifications administrator permissions. You have configured the Google Chat integration. Procedure In the Hybrid Cloud Console, navigate to Settings > Notifications . Under Notifications , select Configure Events . Select the application bundle tab you want to configure event notification behavior for: Red Hat Enterprise Linux , Console , or OpenShift . Click the Behavior Groups tab. Click Create new group to open the Create behavior group wizard. Type a name for the behavior group and click . In the Actions and Recipients step, select Integration: Google Chat from the Actions drop-down list. From the Recipient drop-down list, select the name of the integration you created (for example, console-gchat ) and click . 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 . Review your behavior group settings and click Finish . The new behavior group is listed on the Notifications page. Verification 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. Wait a few minutes, and then navigate to Google Chat. In your Google Space, check for notifications from the Hybrid Cloud Console. 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. 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. Note See Troubleshooting notification failures in the notifications documentation for more details. 1.2.4. Additional resources For information about troubleshooting your Google Chat integration, see Troubleshooting Hybrid Cloud Console integrations . See the Google Chat documentation about incoming webhooks for more detailed information about Google Chat configuration. For more information about behavior groups, see Configuring Hybrid Cloud Console notification behavior groups . 1.3. Integrating Slack with the Hybrid Cloud Console You can configure the Hybrid Cloud Console to send event notifications to a Slack channel or directly to a user. The Slack integration supports events from all Hybrid Cloud Console services. Note The Slack integration in this example is configured for Red Hat Enterprise Linux. The integration also works with Red Hat OpenShift and Hybrid Cloud Console events. The Slack integration uses incoming webhooks to receive event data. For more information about webhooks, see Sending messages using incoming webhooks in the Slack API documentation. Contacting support If you have any issues with the Hybrid Cloud Console integration with Slack, contact Red Hat for support. Slack will not provide troubleshooting. The Hybrid Cloud Console integration with Slack is fully supported by Red Hat. You can open a Red Hat support case directly from the Hybrid Cloud Console by clicking Help > Open a support case , or view more options from Help > Support options . 1.3.1. Configuring incoming webhooks in Slack To prepare Slack for integration with the Hybrid Cloud Console, you must configure incoming webhooks in Slack. Prerequisites You have owner or admin permissions to the Slack instance where you want to add incoming webhooks. You have App Manager permissions to add Slack apps to a channel. You have a Slack channel or user to receive notifications. Procedure Create a Slack app: Go to the Slack API web page and click the Create your Slack app button. This opens the Create an app dialog. Select From scratch to use the Slack configuration UI to create your app. 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 step. Click Create App to finish creating the Slack app. Enable incoming webhooks: Under the Features heading in the navigation panel, click Incoming Webhooks . Toggle the Activate Incoming Webhooks switch to On . 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. Create an incoming webhook: Under Settings in the navigation panel, click Install App . In the Install App section, click the Install to workspace button. Select the channel where you want your Slack app to post notifications, or select a user to send notifications to as direct messages. Click Allow to save changes. Optional: Configure how your Hybrid Cloud Console notifications appear in Slack: Under Settings in the navigation panel, click Basic Information . Scroll down to Display Information . Edit your app name, description, icon, and background color as desired. Click Save Changes . Copy the webhook URL: Under Features , click Incoming Webhooks . Click the Copy button 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" . Verification Open the Slack channel or user you selected during configuration, and check for a message confirming you have added the integration. Additional resources For information about webhooks in Slack, see Sending messages using incoming webhooks . For information about workflows, see Build a workflow: Create a workflow that starts outside of Slack . For information about managing app approvals, see Managing app approvals in Enterprise Grid workspaces . For general help with Slack, see the Slack Help Center . 1.3.2. Configuring the Slack integration in the Red Hat Hybrid Cloud Console After you have configured an incoming webhook in Slack, you can configure the Hybrid Cloud Console to send event notifications to the Slack channel or user you configured. Prerequisites You have Organization Administrator or Notifications administrator permissions for the Red Hat Hybrid Cloud Console. Procedure 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. In the Hybrid Cloud Console, navigate to Settings > Integrations . Select the Communications tab. Click Add integration . Select Slack as the integration type and click . Enter a name for the integration (for example, My Slack notifications ). Paste the Slack webhook URL that you copied from Slack into the Workspace URL field and click . 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. Select a product family, for example OpenShift , Red Hat Enterprise Linux , or Console . Select the event types you want your integration to react to and click . To enable the integration, review the integration details and click Submit . 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. Verification Create a test notification to confirm you have successfully connected Slack to the Hybrid Cloud Console: to your Slack integration on the Integrations > Communications page, click the options icon (...) and click Test . 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. Open the Slack channel you configured and check for the message sent from the Hybrid Cloud Console. In the Hybrid Cloud Console, go to Notifications > Event Log and check that the Integration: Slack event is listed with a green label. Additional resources For more information about setting up Notifications administrator permissions, see Configure User Access to manage notifications in the notifications documentation. 1.3.3. Creating the behavior group for the Slack integration A behavior group defines which notifications will be sent to external services such as Slack when a specific event is received by the notifications service. You can link events from any Red Hat Hybrid Cloud Console service to your behavior group. Prerequisites You are logged in to the Hybrid Cloud Console as an Organization Administrator or as a user with Notifications administrator permissions. You have configured the Slack integration. Procedure In the Hybrid Cloud Console, navigate to Settings > Notifications . Under Notifications , select Configure Events . Select the application bundle tab you want to configure event notification behavior for: Red Hat Enterprise Linux , Console , or OpenShift . Click the Behavior Groups tab. Click Create new group to open the Create behavior group wizard. Enter a name for the behavior group and click . In the Actions and Recipients step, select Integration: Slack from the Actions drop-down list. From the Recipient drop-down list, select the name of the integration you created (for example, My Slack notifications ) and click . 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 . 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. 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 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. Wait a few minutes, and then navigate to Slack. In your Slack channel, check for notifications from the Hybrid Cloud Console. 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. 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. 1.3.4. Additional resources For detailed information about Slack configuration, see Sending messages using incoming webhooks in the Slack documentation. For more information about behavior groups, see Configuring Hybrid Cloud Console notification behavior groups . For information about troubleshooting your Slack integration, see Troubleshooting Hybrid Cloud Console integrations .

Commands: