Skip to main content
Test Connector Config

Authorizations

Authorization
string
header
required

API key authentication

Body

application/json

Request to test a connector configuration

entityType
enum<string>

Entity type.

Available options:
ENTITY_TYPE_UNSPECIFIED,
ALERTS,
TEST_NOTIFICATIONS,
CASES
fields
object[]

Fields.

Maximum array length: 100
payloadType
string

Payload type to use when testing the connector.

Required string length: 1 - 100
Pattern: ^[\s\S]*$
Example:

"default"

type
enum<string>

Connector type.

Available options:
CONNECTOR_TYPE_UNSPECIFIED,
SLACK,
GENERIC_HTTPS,
PAGERDUTY,
IBM_EVENT_NOTIFICATIONS,
SERVICE_NOW,
EMAIL,
PAGERDUTY_INCIDENTS,
MICROSOFT_TEAMS

Response

200 - application/json

Response containing the results of a connector configuration test.

result
object

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