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 an Alert Integration

  • Capella Operational
      +
      Send Capella metric-based notifications to a third-party tool using an alert integration.

      If your organization uses a third-party tool to receive, assign, and monitor service issues, you can configure an alert integration to send notifications from Capella to that third-party tool automatically. You can then use workflows defined in the third-party tool to route information about metric-derived critical- and warning-level events when they occur in Capella.

      Prerequisites

      For full access to Capella alert integrations, you must have 1 of the following roles:

      In addition, users with the following roles have read-only access to Capella alert integrations:

      When you add an alert integration, you must supply:

      • An identifying name.

      • The URL that uniquely identifies the destination for the alert integration’s notifications.

        The destination Webhook URL must be publicly accessible for Capella to add alert integrations.

      • An authentication and authorization method and credentials:

        • Basic auth requires a username and password.

        • Bearer token auth requires an access token.

      Use your third-party tool to obtain the URL and credentials.

      Add an Alert Integration

      To use the Capella Management API to create and configure an alert integration, see Create Alert Integration.

      You can add 1 alert integration for each project.

      To add an alert integration using the Capella UI:

      1. Go to Projects.

      2. In the list of projects, click the name of the project where you want to create your alert integration.

      3. Go to Alerts.

      4. Select Add Integrations.

      5. Enter an identifying Display Name. Display Names can only include the alphanumeric characters A-Z, a-z, and 0-9, spaces, and the hyphen - and underscore _ special characters.

      6. Enter the publicly accessible destination Webhook URL for the notifications sent by this alert integration. For a secure connection with Capella, the URL must begin with https://. You obtain this URL from the third-party tool you’re integrating with.

      7. Specify an Authentication method:

        • Basic: Supply the username and password established with the third-party tool.

        • Bearer Token: Supply the access token generated by the third-party tool.

      8. To add HTTP headers or filtering, click Show Advanced Settings.

        1. To add an HTTP header, select Add Custom HTTP Header and then enter a Key and a Value.

          Key names can only include the alphanumeric characters A-Z, a-z, and 0-9, and the hyphen - and underscore _ special characters.

          Values can include all of the characters that a key name can contain plus the following special characters: : ; . , \ / " ' ? ! ( ) { } [ ] @ < > = + * # $ & ` | ~ ^ %.

        2. To prevent the alert integration from sending messages for certain clusters or App Services, use the drop-down lists to choose which resources to exclude.

      9. Click Test Connection. You cannot save the alert integration until the URL destination and auth credentials are accurately configured and the connection test succeeds.

      10. Click Add Integration.

      Edit an Alert Integration

      To use the Capella Management API to edit an alert integration, see Update Alert Integration.

      To edit an alert integration using the Capella UI:

      1. Go to Projects.

      2. In the list of projects, click the name of the project where you created your alert integration.

      3. Go to Alerts.

      4. Click the Name of the alert integration you want to edit.

      See the steps for adding an alert integration for information about the settings you can configure.

      Delete an Alert Integration

      To use the Capella Management API to delete an alert integration, see Delete Alert Integration.

      To delete an alert integration using the Capella UI:

      1. Go to Projects.

      2. In the list of projects, click the name of the project where you created your alert integration.

      3. Go to Alerts.

      4. Locate the alert integration you want to delete.

      5. Click Delete () at the end of the row to delete the alert integration.

      Troubleshooting

      • Message Queuing and Delivery

        Capella applies a first in/first out queue to send one alert notification at a time. Typically, Capella sends alert notifications within milliseconds of creation. After Capella sends a notification, the third-party tool controls queuing and the timing of delivery via the incoming webhook.

      See Also