Skip to main content
Theme
Home

Test Connector Config

POSThttps://api.coralogix.com/mgmt/openapi/5/notifications/notification-center/v1/connectors:testConfig

Tests a notification connector configuration.

Authorizations

Authorizationstringheaderrequired
API key authentication
The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request​

Body

application/json

Request to test a connector configuration

    entityType#notification_center.EntityType

    Entity type.

    Possible values: [ENTITY_TYPE_UNSPECIFIED, ALERTS, TEST_NOTIFICATIONS, CASES]

    Fields.

    Possible values: <= 100

    payloadType#string

    Payload type to use when testing the connector.

    Possible values: non-empty and <= 100 characters, Value must match regular expression ^[\s\S]*$

    Example: default
    type#notification_center.ConnectorType

    Connector type.

    Possible values: [CONNECTOR_TYPE_UNSPECIFIED, SLACK, GENERIC_HTTPS, PAGERDUTY, IBM_EVENT_NOTIFICATIONS, SERVICE_NOW, EMAIL, PAGERDUTY_INCIDENTS, MICROSOFT_TEAMS]

Response

application/json

Response containing the results of a connector configuration test.

    result#object

    Result of a notification test, either a success or failure.

    oneOf
    object

    Failure.

    Indicates the notification test succeeded.