Skip to main content
Update alerts: confirm, mark as false alarm, skip, move back to review, add to or remove from a claim, move to another topic

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Body

application/json
alert_ids
string<uuid>[]

Alerts to change. If any is unknown (404) or cannot be changed (409), nothing changes.

Required array length: 1 - 5000 elements
filter
object
excluded_alert_ids
string<uuid>[]

Alerts to leave out of a filter selection. Only valid with filter.

Required array length: 1 - 5000 elements
verdict
enum<string>

Whether the finding is right. pending: still to review. accepted: confirmed, the deviation is real (also when it is too small to pursue or already handled). dismissed: a false alarm, Watchdog was wrong; requires dismissal with a category. skipped (shown as Unsure): nobody can or will judge it; it leaves review without teaching anything. Claim membership and credit are not changed. Leaving dismissed takes the dismissal off the alert; it stays in the history.

Available options:
pending,
accepted,
dismissed,
skipped
dismissal
object

Why the alerts are false alarms. Required with verdict dismissed, and only valid with it. Sending a different reason for an already dismissed alert replaces its reason.

suggest_instructions
boolean

Whether the false alarm should start a run that suggests changes to the agreement's instructions, so later checks avoid the mistake. Defaults to true. Send false when the note explains a cleanup rather than a rule for future checks. Only valid with verdict dismissed; it is not stored on the alert.

claim_id
string<uuid> | null

Put the alerts in this pending or in-progress claim of their agreement, or null to take them out of their claim. Verdicts are not changed: send verdict accepted to accept them too. Alerts move out of a cancelled claim; out of another open claim only with move_from_open_claims. Alerts in completed claims cannot be changed. POST /v1/claims/alerts/preview says first which alerts would join and why the others would not.

move_from_open_claims
boolean

Move alerts out of other pending or in-progress claims. Only valid with a claim_id.

topic_id
string<uuid> | null

Move the alerts into this topic of their agreement, out of any other topic, or null to take them out of their topic. Categorization may later place an alert without a topic in one again.

Response

How many alerts changed and how many matching alerts were left alone.

changed_count
integer
required

Alerts the command changed. Alerts already in the requested state are not counted.

skipped_count
integer
required

Matching alerts a filter left unchanged. Always 0 for alert_ids.