Alerts

Queue a synthetic alert through a rule's channel

Queues a test event for a rule, like the Send a test action in the app, so you can verify the email address, Slack channel or webhook endpoint (including its signature check) without waiting for a real finding. The alert dispatcher sends it within about 15 minutes; follow it with get_alert_event. It is marked as a test and never counts as a finding. For a summary_digest rule the test carries the real summary of the latest period the schedule covered. Requires the write scope and an idempotency key; a retry with the same key returns the same event without queueing another. Limited to 5 tests per rule per hour and 20 per account per day (rate_limited with Retry-After beyond).

post/alert-rules/{rule_id}/test

Request

  • Base URL: https://adslighthouse.com/api/v1
  • URL: https://adslighthouse.com/api/v1/alert-rules/{rule_id}/test
  • Auth: HTTP bearer

Path parameters

rule_idstring required

The alert rule id from list_alert_rules.

Headers

Idempotency-Keystring required

A unique value you choose for this request, such as a UUID. Repeating the same key returns the first result instead of starting paid work again.

Request body

object required

Response

Queue a synthetic alert through a rule's channel

event_idstring required
createdboolean required

False when this key already queued the event.

request_idstring

Changes

No recorded changes to this operation across all 1 revision of this API.