COcouchbase
Alert Integration

Test Alert Integration

Changed on

Tests a new alert integration for a project.

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

  • Organization Owner
  • Project Owner
  • Project Manager

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

post/v4/organizations/{organizationId}/projects/{projectId}/alertIntegrationTest

Request

Request body

OR
OR

Example request

{
  "kind": "slack",
  "config": {
    "webhook": {
      "method": "POST",
      "url": "https://company.servicenow.com",
      "token": "QktxVUtFU1dKV1FlJBYXdnTVlRemFZdlRDZTg6eFh4dzU4JUYjqdUwwYkJoTjZSTmlzRWFIRHF0b1h4a08yazBpQjJ1bms1OW4yTUhdsfRib3IhVQ==",
      "basicAuth": {
        "user": "username80085",
        "password": "yed69khj420_i"
      },
      "exclude": {
        "clusters": [
          "ffffffff-aaaa-1414-eeee-000000000000",
          "..."
        ],
        "appServices": [
          "ffffffff-aaaa-1414-eeee-000000000000",
          "..."
        ]
      }
    },
    "slack": {
      "channelName": "#alerts",
      "channel": "#alerts"
    }
  }
}

Response

Successfully tested an alert integration.

Changes

  • e67df5d1f74eRevision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property //

    • info

      added subschema #1 subschema #2 subschema #3 to the request body oneOf list

    • info

      the request property / became optional

    • info

      added the new slack enum value to the request property

    • info

      added the new teams enum value to the request property

    • info

      added subschema #1 subschema #2 subschema #3 to the request property oneOf list

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status