Skip to main content
Dismiss an alert

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Path Parameters

id
string<uuid>
required

Body

application/json
category
enum<string> | null
Available options:
wrong_alert,
valid_not_actioning,
already_handled,
duplicate_covered,
other,
null
note
string | null
Maximum string length: 2000

Response

The alert with its current edit revision.

id
string<uuid>
required
title
string | null
required
explanation
string | null
required
status
enum<string>
required
Available options:
pending,
claimed,
dismissed,
credited
correction_type
enum<string>
required
Available options:
modify_item,
modify_invoice,
add_item
confidence
object
required
impact_amount
string | null
required
Pattern: ^-?\d+(?:\.\d+)?$
currency_code
string
required
organization_currency
object
required

The impact converted with the rate stored on the alert.

freshness
enum<string>
required
Available options:
current,
outdated,
unknown
invoice
object | null
required
invoice_item
object | null
required
read-only

Current linked invoice line details, not a snapshot at alert creation. Null when no accessible line is linked.

agreement
object | null
required
supplier
object | null
required
recipient
object | null
required
topic
object | null
required
claim
object | null
required

The claim this alert is currently attached to, if any.

provenance
object
required
correction_relationships
object[]
required

Links between an added-item alert and the line alerts it replaces. Alerts connected by these links form one replacement set.

Maximum array length: 100
correction_relationships_truncated
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
questions
string[]
required
price_item_ids
string<uuid>[]
required

Agreement price items the finding relies on. Read them with GET /v1/agreements/{id}/price-items?ids=.

expected
object
required
invoiced
object
required
read-only

Pricing values captured when the alert was created.

evidence
object
required