Webhooks

Bank Account Created

Sample webhook payload for bank-accounts-created:

{
   "webhook_id":"3cc6a3e58cbe4b71bbbe8b821d2242b8",
   "task_id":"c32fb957ec7246828da56be7516da765",
   "link_id":"9915c50cc047413bb810767f218390f8",
   "product":"employment",
   "tracking_info":null,
   "event_type":"bank-accounts-created",
   "event_created_at":"2022-08-23T17:32:19.269355Z",
   "objects_count":2,
   "employment_id":"427abebd8590457e8332fdff77fc412f",
   "user_id": "88fef4cea64c40b5ad6727cc9b0b9fdc"
}

The bank-accounts-created events will only be sent when any non-refresh task is successful and complete with new objects. If there are multiple shifts or bank accounts, we will send a webhook for each object created.

Bank Account Updated

Sample webhook payload for bank-accounts-updated:

{
   "webhook_id":"3cc6a3e58cbe4b71bbbe8b821d2242b8",
   "task_id":"c32fb957ec7246828da56be7516da765",
   "link_id":"9915c50cc047413bb810767f218390f8",
   "product":"employment",
   "tracking_info":null,
   "event_type":"bank-accounts-updated",
   "event_created_at":"2022-08-23T17:32:19.269355Z",
   "objects_count":2,
   "employment_id":"427abebd8590457e8332fdff77fc412f",
   "user_id": "88fef4cea64c40b5ad6727cc9b0b9fdc"
}

The bank-accounts-updated events will only be sent when any refresh task is successful and complete with a different number bank accounts from a previous task (e.g., if a person had 3 bank accounts and now has 4).