Pay Statement Webhook Events

Subscribe to these events via Webhooks to receive notifications when pay statements become available or change during a refresh. All webhook payloads include these common fields:

Field	Description
`webhook_id`	Unique identifier for this webhook request
`event_type`	The event classification
`event_created_at`	Timestamp when the event occurred
`user_id`	Associated Truv user identifier

All Pay Statement events on this page also include these fields:

Field	Description
`link_id`	Identifier of the Link
`product`	The product the event relates to, such as `income`, `employment`, or `assets`
`data_source`	Source of data: `payroll`, `docs`, `insurance`, `financial_accounts`, or `tax`
`tracking_info`	Custom metadata passed via `bridge_token` (nullable)
`task_id`	The associated Task
`employment_id`	The associated employment record
`objects_count`	Number of statements retrieved

statements-created

Fires when pay statements have been retrieved. This occurs once per Link for each non-refresh Task completion.

{
  "webhook_id": "f82ab0a92ddd4bb7b6117635159b366a",
  "task_id": "c32fb957ec7246828da56be7516da765",
  "link_id": "9915c50cc047413bb810767f218390f8",
  "product": "employment",
  "data_source": "payroll",
  "tracking_info": null,
  "event_type": "statements-created",
  "event_created_at": "2022-08-23T17:32:24.812306Z",
  "objects_count": 9,
  "employment_id": "427abebd8590457e8332fdff77fc412f",
  "user_id": "88fef4cea64c40b5ad6727cc9b0b9fdc"
}

statements-updated

Fires when the statement count changes during a refresh Task. For example, if a person had 31 pay stubs and now has 32.

{
  "webhook_id": "f82ab0a92ddd4bb7b6117635159b366a",
  "task_id": "c32fb957ec7246828da56be7516da765",
  "link_id": "9915c50cc047413bb810767f218390f8",
  "product": "employment",
  "data_source": "payroll",
  "tracking_info": null,
  "event_type": "statements-updated",
  "event_created_at": "2022-08-23T17:32:24.812306Z",
  "objects_count": 10,
  "employment_id": "427abebd8590457e8332fdff77fc412f",
  "user_id": "88fef4cea64c40b5ad6727cc9b0b9fdc"
}

​statements-created

​statements-updated

statements-created

statements-updated