COcouchbase
Alert Integration

Get Alert Integration

Changed on

Fetches the details of the given alert integration.

In order to access this endpoint, the provided API key must have at least one of the following roles:

  • Organization Owner
  • Organization Member
  • Project Owner
  • Project Manager
  • Project Viewer

To learn more, see Organization, Project, and Database Access Overview.

get/v4/organizations/{organizationId}/projects/{projectId}/alertIntegrations/{alertIntegrationId}

Request

Response

Successfully fetched the alert integration based on the alertIntegrationId.

idstring uuid required

The ID of the alert integration created.

namestring required

Name of the alert integration (up to 1024 characters).

tenantIdstring uuid required

The tenant ID to which the alert integration belongs to.

projectIdstring uuid

The project ID to which the alert integration belongs to.

kind'webhook' | 'slack' | 'teams' required

Type of alert integration.

configKeystring required

ConfigKey is the key that was used to store the alert integration config and secrets.

statusstring required

Status is either healthy or unhealthy showing if the integration is functional or not.

enabledboolean required

Enables or disables the integration. Only 1 integration can be active at any time.

Example response

{
  "id": "ffffffff-aaaa-1414-eeee-000000000000",
  "name": "test alert 1",
  "tenantId": "ffffffff-aaaa-1414-eeee-000000000000",
  "projectId": "ffffffff-aaaa-1414-eeee-000000000000",
  "kind": "teams",
  "configKey": "ffffffff-aaaa-1414-eeee-000000000000-alert-integration",
  "status": "healthy",
  "config": {
    "webhook": {
      "method": "POST",
      "url": "https://company.servicenow.com",
      "exclude": {
        "clusters": [
          "ffffffff-aaaa-1414-eeee-000000000000",
          "..."
        ],
        "appServices": [
          "ffffffff-aaaa-1414-eeee-000000000000",
          "..."
        ]
      }
    },
    "slack": {
      "channel": "#alerts"
    }
  },
  "audit": {
    "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
    "createdAt": "2021-09-01T12:34:56Z",
    "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
    "modifiedAt": "2021-09-01T12:34:56Z",
    "version": 1
  }
}

Changes

  • e67df5d1f74eRevision changes
    • breaking

      the response property / became optional for the status

    • breaking

      added subschema #1 subschema #2 subschema #3 to the response property oneOf list for the response status

    • warning

      added the new slack enum value to the response property for the response status

    • warning

      added the new teams enum value to the response property for the response status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status