This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:09 UTC.
Identifies the delivery transport for a notification destination.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Webhook
HTTP POST to a configured URL with HMAC signature headers.
Email
Email delivery to the configured recipient addresses.
AmazonSqs
Amazon Simple Queue Service (SQS) message delivery.
AzureServiceBusQueue
Azure Service Bus Queue message delivery.
InApp
In-app notification delivered in-process to connected clients on this instance. Suitable for real-time UI notifications (dropdown, popup, badge).
Slack
Slack message delivery via Block Kit-formatted channel messages. Supports per-destination bot tokens for multi-workspace routing.
Sms
SMS text message delivery to a single recipient phone number via the platform SMS sender. Opt-out compliance is enforced at send time, so an opted-out recipient is blocked before the carrier is contacted.
suppressNullsrequired
query
boolean
If true, omit properties with null values.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
durationrequired
string (date-span)
How long the test took to complete. Written as [-][d.]hh:mm:ss[.fffffff], for example
00:00:01.2500000; the seven-digit fraction of a second appears only when it is non-zero.
Not an ISO 8601 duration.pattern ^-?(\d{1,8}\.)?([01]\d|2[0-3]):[0-5]\d:[0-5]\d(\.\d{7})?$
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This response has no documented body fields.
defaultThe request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This response has no documented body fields.
429The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.