staqlydocs
REST APIAPI referenceAlerts

Send a test message now

Send a test message now

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

POST
/v1/alerts/{id}/test

Rate-limited per principal (burst 5, then 10 per minute).

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Path Parameters

id*string

Header Parameters

Idempotency-Key?string

Replays the stored response when the same key is repeated with the same method, path, query string and body within 24 hours (422 idempotency_mismatch with a different request, 409 idempotency_in_progress while the first one runs). Not applied to multipart uploads or to responses that carry a secret.

Lengthlength <= 200

Response Body

Result of the attempt (delivery errors are reported, not raised)

application/json
  1. response
ok*boolean
error?string
curl -X POST 'https://staqly.example.com/v1/alerts/string/test'
{  "ok": true,  "error": "string"}