v4

latestOpenAPI 3.0.32026-08-0161180264.4 KB

integrations

testSendNotification

Renders and sends ONE representative notification of the requested kind/type to the CALLING USER ONLY (never any other recipient), so an operator can preview how a notification looks. A test send does NOT write to the notification history. Requires the integration:manage permission on the integration's organization.

post/v2/integrations/{integrationId}/notifications/test

Path parameters

integrationIdstring uuid required

The integration ID

Request body

kind'alert' | 'digest' required

The kind of notification to render and send.

typestring

The alert type to render when kind=alert (e.g. critical_error, error_threshold).

channelsstring[]

Delivery channels to use; defaults to the integration's configured channels.

Response

Test notification accepted for delivery to the calling user (sent is true)

sentboolean required

Whether the test notification was accepted for delivery.

recipientstring required

The calling user id the test was sent to (the only recipient).

channelsstring[] required

The channels the test was delivered on.

notification_idstring nullable

The svc-notification-api message id, or null when not returned.