Send a test notification to a rule’s targets

POST

/api/v1/alert-rules/{id}/test-fire

const url = 'http://localhost:3000/api/v1/alert-rules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/test-fire';
const options = {method: 'POST', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:3000/api/v1/alert-rules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/test-fire \
  --header 'X-API-Key: <X-API-Key>'

Dispatches a test notification through each configured target so an operator can confirm delivery actually works before relying on it. Creates no AlertDelivery record, so a test never consumes the rule’s open-alert slot and cannot suppress a subsequent real alert. Per-target outcomes are reported individually — one broken endpoint does not hide the rest.

Authorizations

api-key
bearer

Parameters

Path Parameters

required

string format: uuid

Responses

200

application/json

object

ruleId

required

string format: uuid

conditionCurrentlyMet

required

What the rule evaluates to against current data right now. Independent of whether the test notification was delivered — a rule can be not-currently-matching and still have perfectly working targets.

boolean

matchedDeviceCount

required

Number of devices the rule’s scope currently resolves to.

number

condition

required

Human-readable rendering of the condition, as the evaluator sees it.

string

results

required

Array<object>

object

notificationTargetId

required

string format: uuid

name

required

string

channel

required

string

delivered

required

Whether the transport accepted the test notification

boolean

error

required

Failure detail when delivered is false; empty otherwise.

string

Example

{
  "matchedDeviceCount": 12,
  "condition": "cpu > 80 for 300s",
  "results": [
    {
      "name": "Ops on-call email",
      "channel": "EMAIL",
      "error": ""
    }
  ]
}

404

No such rule in the caller’s organization