Skip to main content
WEBHOOK

Authorizations

Authorization
string
header
required

API key issued from the developer dashboard. Pass as Authorization: Bearer vq_key_... (preferred).

Body

application/json

Body of a board.updated delivery: a watched board refreshed with real changes.

event
string
required
Allowed value: "board.updated"
firedAt
string
required

ISO 8601 time the delivery was built.

corpusType
string
required
boardLabel
string
required
rowsAdded
integer
required

Stored rows (chunks), not sections.

rowsUpdated
integer
required

Stored rows (chunks), not sections.

rowsDeleted
integer
required

Stored rows (chunks), not sections.

changes
BoardWebhookChange · object[]
required

Up to 10 changed sections. See changesOverflowCount for the rest.

changesOverflowCount
integer
required

Changed sections beyond the ones in changes; page GET /watches/{watchId}/changes for them.

state
string | null

Null for a federal board.

scope
Scope · object | null

The watch's scope, echoed so section counts can be read against it.

refreshLogId
integer | null
sectionsAdded
integer | null

Sections added. Absent when not counted.

sectionsAmended
integer | null
sectionsRemoved
integer | null

Response

204

Acknowledge with any 2xx status.