Configure a Microsoft Teams Alert Integration
- Capella Operational
Send Capella metrics-based alerts to your Microsoft Teams channel with an alert integration.
If your organization uses Microsoft Teams to receive, assign, and monitor service issues, you can configure an alert integration to send alerts from Capella to Teams automatically.
Configure an alert integration for each project where you want to send alerts, using either the Capella UI or the Capella Management API.
Prerequisites
-
For full access to Capella alert integrations, you must have 1 of the following roles:
-
For read-only access, you must have 1 of the following roles:
-
Organization Memberwith Read access to the project
-
-
You have deployed an operational cluster or App Service linked to an operational cluster on the Enterprise or the Developer Pro Support Plans.
For analytics clusters, AI Services, and operational clusters and App Services on the Basic plan, monitor alerts in the Capella UI or by email. -
You have configured your network firewall to allow inbound traffic from the following IP addresses for Capella alert integrations:
-
54.236.200.31
-
3.230.238.38
-
54.156.132.156
These IP addresses are static, but are subject to change based on Capella system updates. Capella provides a 30-60 day notice prior to any scheduled IP address rotations.
-
-
You have obtained your connection details from your Workflows app in Microsoft Teams. Copy your Webhook URL, a user-defined HTTP callback mechanism that uniquely identifies the destination for the alert integration’s notifications.
For more information about incoming webhooks and how to find the URL in the Workflows app, see the Microsoft Teams documentation on incoming webhooks.
Add a Microsoft Teams Alert Integration
| You can add up to 5 alert integrations for each project. |
To create and configure an alert integration with the Management REST API, see Create Alert Integration.
To add an alert integration with the Capella UI:
-
In the navigation breadcrumbs in the Capella UI, do 1 of the following:
-
Click your organization name and go to Projects. Select the project where you want to add an alert integration.
-
Click your current project name or expand the project breadcrumb to select another project.
-
-
Go to Alerts.
-
In Microsoft Teams, click Add Integration.
-
Enter an identifying Integration Name. It can include only alphanumeric characters (
A-Z,a-z,0-9), spaces, hyphens (-), and underscores (_). -
Enter the Webhook URL. For a secure connection with Capella, the URL must begin with
https://.-
(Optional) To add an additional Webhook URL, click .
-
-
Test the connection:
-
Enter the Channel Name of the Microsoft Teams channel where you want to send the test alert.
-
Click Test Connection. You cannot continue until your connection details are accurately configured and the connection test succeeds.
-
Confirm that the test alert appears in the designated Microsoft Teams channel.
-
-
To map alerts to specific Microsoft Teams channels, select the relevant clusters or App Services in Resources and assign the MS Teams Channel that should receive their alerts.
-
(Optional) To add additional mappings, click Add More and repeat the mapping process for each additional channel you want to send alerts to.
You must have at least 1 mapping to connect your integration. You can edit your mappings once your integration is created. -
-
Click Next.
-
Select an Alert Name to customize the payload for that alert.
You can customize multiple alert payloads in the same integration, and Capella saves each edit so you can configure alerts sequentially without losing previous changes.
-
Choose between a Standard template or an Advanced template for your alert:
-
Select Standard Template to use a pre-built template with no customizations.
-
Select Advanced Template to customize the payload.
-
Customize your alert payload in the JSON editor:
-
Add or remove variables to tailor the alert data you want in the payload. For a list of all the variables that Capella supports, see Microsoft Teams Alert Payload.
-
Add custom static values to specify additional information. For example, you can label the alert’s environment by adding an object such as
{"title": "Environment:", "value": "Production"}to an Adaptive Card FactSet element. -
Customize the Adaptive Card elements to adjust the layout and appearance of the alert in Microsoft Teams.
Any changes to the payload must follow the Adaptive Cards JSON format required by Microsoft Teams. For more information about the Adaptive Card structure and elements, see Getting Started with Adaptive Cards.
Capella does not mask or sanitize personally identifiable information (PII) or other sensitive data in advanced alert templates. Review your templates and, if necessary, implement the appropriate safeguards to protect your data before sending it to any third-party tool. -
-
Click Update Preview.
-
Review your alert payload format in the Message Preview. Capella flags any issues with your JSON formatting. If you receive an error message, confirm your edits follow the required JSON format and try again.
-
-
-
(Optional) To customize the payload for additional alerts, select another Alert Name and repeat the payload customization steps above.
-
Click Create Integration.
View a Microsoft Teams Alert Integration
| The activity log records all add, edit, and delete events for alert integrations. It also records any connection failure events that occur for an alert integration. |
To view a list of your alert integrations with the Capella Management API, see List Alert Integrations. To view details about a specific alert integration with the Capella Management API, see Get Alert Integration.
To view an alert integration with the Capella UI:
-
In the navigation breadcrumbs in the Capella UI, do 1 of the following:
-
Click your organization name and go to Projects. Select the project where you want to add an alert integration.
-
Click your current project name or expand the project breadcrumb to select another project.
-
-
Go to Alerts.
-
In Microsoft Teams, click Manage Integrations.
A Microsoft Teams alert integration in Capella can have 1 of the following statuses:
| Status | Description |
|---|---|
Active |
Your alert integration is active. |
Disabled |
Your alert integration is disabled. Enable your integration to continue receiving alerts. |
Edit a Microsoft Teams Alert Integration
To edit an alert integration with the Capella Management API, see Update Alert Integration.
To edit an alert integration with the Capella UI:
-
In the navigation breadcrumbs in the Capella UI, do 1 of the following:
-
Click your organization name and go to Projects. Select the project where you want to add an alert integration.
-
Click your current project name or expand the project breadcrumb to select another project.
-
-
Go to Alerts.
-
In Microsoft Teams, click Manage Integrations.
-
Click .
-
Return to the steps for adding an alert integration and make your changes.
| You cannot edit your Webhook URL details. To change your Webhook URL, you must delete your existing alert integration and create a new one with the updated details. |
Disable or Enable a Microsoft Teams Alert Integration
Disabling an alert integration pauses it temporarily without deleting it. You can re-enable it when needed.
To disable or enable your alert integrations with the Capella Management API, see Update Alert Integration.
To disable or enable an alert integration with the Capella UI:
-
In the navigation breadcrumbs in the Capella UI, do 1 of the following:
-
Click your organization name and go to Projects. Select the project where you want to add an alert integration.
-
Click your current project name or expand the project breadcrumb to select another project.
-
-
Go to Alerts.
-
In Microsoft Teams, click Manage Integrations.
-
Find your alert integration and click or .
-
Confirm that you want to disable or enable your alert integration and click Confirm Disable or Confirm Enable.
Delete a Microsoft Teams Alert Integration
To delete an alert integration with the Capella Management API, see Delete Alert Integration.
To delete an alert integration with the Capella UI:
-
In the navigation breadcrumbs in the Capella UI, do 1 of the following:
-
Click your organization name and go to Projects. Select the project where you want to add an alert integration.
-
Click your current project name or expand the project breadcrumb to select another project.
-
-
Go to Alerts.
-
In Microsoft Teams, click Manage Integrations.
-
Find your alert integration and click .
-
Confirm that you want to delete your alert integration and click Disable and Delete.