Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

Configure a Slack Alert Integration

  • Capella Operational
    Send Capella metrics-based alerts to your Slack workspace with an alert integration.

    If your organization uses Slack to receive, assign, and monitor service issues, you can configure an alert integration to send alerts from Capella to Slack 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:

    • 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 Slack app. Copy either 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 Slack app, see the Slack documentation on incoming webhooks.

      • Bot Token: authenticates Capella as a bot user so it can send messages to your Slack workspace.

        For more information about bot tokens and how to find your bot token in the Slack app, see the Slack documentation on bot tokens.

        Bot Token Settings in Your Slack App

        For Capella to connect using a bot token, you must have:

        • Enabled the following bot token scopes to grant your Slack app the permissions Capella needs to interact with your Slack workspace:

          • chat:write: send messages to channels your Slack app has been invited to.

          • channels:read: view the list of public channels.

          • groups:read: view the list of private channels your Slack app has been invited to.

          • (Optional) chat:write.public: post to any public channel without requiring a manual channel invitation.

          For more information about enabling bot token scopes, see the Slack documentation on scopes.

        • Authorized your Slack app’s access to the specific workspace channels you want Capella to interact with. For more information, see the Slack documentation on authorization.

    Add a Slack 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:

    1. 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.

    2. Go to Alerts.

    3. In Slack, click Add Integration.

    4. Enter an identifying Integration Name. It can include only alphanumeric characters (A-Z, a-z, 0-9), spaces, hyphens (-), and underscores (_).

    5. To connect your integration, enter a Bot Token or a Webhook URL:

      Connecting your integration with 1 Webhook URL allows you to send alerts to a single channel only. To send alerts to multiple channels, use a Bot Token, or configure additional Webhook URLs.

      • Bot Token: For a secure connection with Capella, the bot token must begin with xoxb-.

      • Webhook URL: For a secure connection with Capella, the URL must begin with https://.

        1. (Optional) To add an additional Webhook URL, click .

    6. Test the connection:

      1. Enter the Channel Name of the Slack channel where you want to send the test alert.

      2. Click Test Connection. You cannot continue until your connection details are accurately configured and the connection test succeeds.

      3. Confirm that the test alert appears in the designated Slack channel.

    7. To map alerts to specific Slack channels, select the relevant clusters or App Services in Resources and assign the Slack Channel that should receive their alerts.

      1. (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 an integration. You can edit your mappings once your integration is created.

    8. Click Next.

    9. 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.

    10. 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.

        1. Customize your alert payload in the JSON editor:

          1. 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 Slack Alert Payload.

          2. Add custom static values to specify additional information. For example, you can label the alert’s environment by adding a key-value pair such as "text": "Environment: Production" inside a section block’s text object.

          3. Customize the block elements to adjust the layout and appearance of the alert in Slack.

          Any changes to the payload must follow the Slack Block Kit JSON format. For more information about the Slack block structure, types, and fields, see the Slack documentation.

          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.

        2. Click Update Preview.

        3. 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.

    11. (Optional) To customize the payload for additional alerts, select another Alert Name and repeat the payload customization steps above.

    12. Click Create Integration.

    View a Slack 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:

    1. 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.

    2. Go to Alerts.

    3. In Slack, click Manage Integrations.

    A Slack 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 Slack 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:

    1. 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.

    2. Go to Alerts.

    3. In Slack, click Manage Integrations.

    4. Click More Options (⋮)  Edit.

    5. Return to the steps for adding an alert integration and make your changes.

    You cannot edit your Bot Token or Webhook URL details. To change your Bot Token or Webhook URL, you must delete your existing alert integration and create a new one with the updated details.

    Disable or Enable a Slack 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:

    1. 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.

    2. Go to Alerts.

    3. In Slack, click Manage Integrations.

    4. Find your alert integration and click More Options (⋮)  Disable or More Options (⋮)  Enable.

    5. Confirm that you want to disable or enable your alert integration and click Confirm Disable or Confirm Enable.

    Delete a Slack 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:

    1. 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.

    2. Go to Alerts.

    3. In Slack, click Manage Integrations.

    4. Find your alert integration and click More Options (⋮)  Delete.

    5. Confirm that you want to delete your alert integration and click Disable and Delete.

    See Also