Skip to main content
POST
SendTestAlert

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

SendTestAlertRequest delivers a static test message to the given targets.

name
string

Alert name shown in the test message. Optional — leave empty while an alert is still being created; the message then omits the name.

Maximum string length: 255
kind
enum<string>

The alert kind the test stands in for. Optional; selects the message wording only, so an unspecified kind produces a generic test message.

Available options:
TEST_ALERT_KIND_UNSPECIFIED,
TEST_ALERT_KIND_ISSUE_LIFECYCLE,
TEST_ALERT_KIND_SCHEMA_CHANGE,
TEST_ALERT_KIND_INCIDENT_LIFECYCLE
targets
(email · object | ms_teams · object | owner · object | slack · object | webhook · object)[]

The targets to deliver the test message to. At least one is required. Owner targets are expanded to each owner's configured channels.

Minimum array length: 1

AlertingTarget represents a destination where alert notifications will be sent. Each target type has its own specific configuration requirements.

Response

200 - application/json

Success

SendTestAlertResponse reports the per-target outcome of the test send.

dispatches
TestAlertDispatch · object[]

One entry per delivered target, in the order they were resolved. Owner targets contribute one entry per resolved channel.