Preview — pending review
This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.
Send a test notification through a channel
Delivers a test notification through the channel synchronously. status is sent only
when the destination accepted it; skipped when an email channel is not verified yet;
otherwise failed with a machine error (e.g. smtp_not_configured,
webhook_target_blocked, webhook_http_500).
At most one test send per channel per 60 seconds (429 RATE_LIMITED).
bearerTokenAuthorizationBearer <token>An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.
scopeId*stringOpaque ownership+authorization scope resolving to tenant + subscription + project.
notificationChannelId*stringThe delivery outcome.
application/json- response
Outcome of a test notification.
status*NotificationDeliveryOutcomeResult of one delivery attempt.
"sent""failed""skipped"error*|Machine reason when status is not sent.
curl -X POST "https://example.com/scopes/string/observability/notification-channels/string/actions/test"{ "status": "sent", "error": "string"}