Webhooks

Pay Statement Created

Sample webhook payload for statements-created:

{
   "webhook_id":"f82ab0a92ddd4bb7b6117635159b366a",
   "task_id":"c32fb957ec7246828da56be7516da765",
   "link_id":"9915c50cc047413bb810767f218390f8",
   "product":"employment",
   "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"
}

The statements-created events will only be sent when the initial task is successful and complete with new objects.

Pay Statement Updated

Sample webhook payload for statements-updated:

{
   "webhook_id":"f82ab0a92ddd4bb7b6117635159b366a",
   "task_id":"c32fb957ec7246828da56be7516da765",
   "link_id":"9915c50cc047413bb810767f218390f8",
   "product":"employment",
   "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"
}

The statements-updated events will only be sent when any refresh task is successful and complete with a different number of statements from a previous task (e.g., if a person had 31 pay stubs and now has 32).