v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

connectionManagement

Test a new connection url.

Test a new connection url is valid and can connect.

post/v1/connections/test

Query parameters

functionalitiesstring[]

A comma-separated functionalities of webhook payload to test. Acceptable values: alert, resolution.

connectionIdstring

Unique identifier of an existing connection to test. It should be provided when the request body of an existing connection contains masked authorization headers. If not provided, the authorization headers will not be correctly unmasked, and the test may fail due to unauthorized access.

Request body

typestring required

Type of connection. Valid values are WebhookDefinition, ServiceNowDefinition.

namestring required

Name of the connection.

descriptionstring

Description of the connection.

Response

The connection url has been tested.

statusCodeinteger required

Status code of the response of the connection test.

responseContentstring required

Content of the response of the connection test.

alertStatusCodeinteger

Status code of the response of alert payload test.

alertResponseContentstring

Content of the response of alert payload test.

resolutionStatusCodeinteger

Status code of the response of resolution payload test.

resolutionResponseContentstring

Content of the response of resolution payload test.

Example response

{
  "alertStatusCode": 200,
  "alertResponseContent": "ok",
  "resolutionStatusCode": 200,
  "resolutionResponseContent": "ok"
}