Configure a Webhook Alert Integration for App Services

  • Capella App Services
    Send Capella metric-based alerts to incident management third-party tools with an alert integration.

    If your organization uses a webhook-supported third-party tool to receive, assign, and monitor service issues, you can configure an alert integration to send alerts from Capella to that tool automatically. For example, you can send alerts to ServiceNow, an incident management tool.

    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 third-party tool. 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, see the documentation of the third-party tool you want to connect to.

    Add a Webhooks 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 Webhooks, click Add Integration.

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

    5. Enter the publicly accessible destination Webhook URL.

      For a secure connection with Capella, the URL must begin with https://. For more information about ServiceNow webhooks URLs, see the ServiceNow Webhooks documentation.

    6. Choose an Authentication method:

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

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

    7. (Optional) To add custom HTTP headers or filter out specific clusters or App Services, click Show Advanced Settings:

      1. To add custom HTTP headers, click Add Custom HTTP Header.

        1. Enter a Key and 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. Click Add.

      2. To exclude specific clusters and App Services from the integration, select them in Clusters to Exclude or App Services to Exclude.

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

    9. Click Add Integration.

    View a Webhooks 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 Webhooks, click Manage Integrations.

    Your alert integration will show an Active status.

    Edit a Webhooks 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 Webhooks, click Manage Integrations.

    4. Click your integration’s name.

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

    Delete a Webhooks Alert Integration

    You cannot disable a Webhooks alert integration. You can delete and re-create it when needed.

    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 Webhooks, click Manage Integrations.

    4. Find your alert integration and click Delete ().

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

    For more information about monitoring your App Services, see