Skip to main content
Test Destination

Authorizations

Authorization
string
header
required

API key authentication

Body

application/json

Request for testing a notification destination.

connectorConfigFields
object[]

The connector config fields.

Maximum array length: 100
connectorId
string

The connector id.

Required string length: 1 - 128
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
entitySubType
string

Entity sub-type to use when testing the destination.

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

"logsImmediateResolved"

entityType
enum<string>

Entity type.

Available options:
ENTITY_TYPE_UNSPECIFIED,
ALERTS,
TEST_NOTIFICATIONS,
CASES
messageConfigFields
Message Config Field · object[]

The message config fields.

Maximum array length: 100
payloadType
string

Payload type to use when testing the destination.

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

"default"

presetId
string

The preset id.

Required string length: 1 - 128
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$

Response

200 - application/json

Response containing the results of a notification destination test.

result
object

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