Skip to main content
Subscribe to these events via Webhooks to receive notifications when pay statements become available or change during a refresh. All webhook payloads include the common fields plus the event-specific fields below.

​
statements-created

Fires when pay statements have been retrieved. This occurs once per Link for each non-refresh Task completion. Additional fields:
FieldDescription
employment_idThe associated employment record
task_idThe associated Task
objects_countNumber of statements retrieved
{
  "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",
  "template_id": null
}

​
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. Additional fields: Same as statements-created (employment_id, task_id, objects_count). 
{
  "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",
  "template_id": null
}