Skip to main content
Subscribe to these events via Webhooks to track Account Link state changes in real time. All webhook payloads include the common fields (webhook_id, event_type, event_created_at, updated_at, user_id, template_id) plus the event-specific fields below.
Fires when a Link connection is successfully established. Additional fields:
FieldDescription
link_idThe Link identifier
data_sourcepayroll, docs, insurance, financial_accounts, or tax
tracking_infoCustom metadata passed via bridge_token (nullable)
{
  "webhook_id": "e5f6a7b8c9d0e1f2a3b4c5d6a7b8c9d0",
  "event_type": "link-connected",
  "event_created_at": "2022-08-24T13:54:00.000000Z",
  "updated_at": "2022-08-24T13:54:00.000000+00:00",
  "link_id": "d39d86dcc20c46e0ae75ba9ab1311a21",
  "product": "income",
  "data_source": "payroll",
  "tracking_info": null,
  "user_id": "88fef4cea64c40b5ad6727cc9b0b9fdc",
  "template_id": null
}
Fires when a Link connection fails during a refresh task. 
{
  "webhook_id": "f6a7b8c9d0e1f2a3b4c5d6a7b8c9d0e1",
  "event_type": "link-disconnected",
  "event_created_at": "2022-08-25T09:31:00.000000Z",
  "updated_at": "2022-08-25T09:31:00.000000+00:00",
  "link_id": "d39d86dcc20c46e0ae75ba9ab1311a21",
  "product": "income",
  "data_source": "payroll",
  "tracking_info": null,
  "user_id": "88fef4cea64c40b5ad6727cc9b0b9fdc",
  "template_id": null
}
Fires when personal data and credentials are removed from a Link. 
{
  "webhook_id": "a7b8c9d0e1f2a3b4c5d6a7b8c9d0e1f2",
  "event_type": "link-deleted",
  "event_created_at": "2022-08-26T10:00:00.000000Z",
  "updated_at": "2022-08-26T10:00:00.000000+00:00",
  "link_id": "d39d86dcc20c46e0ae75ba9ab1311a21",
  "product": "income",
  "data_source": "payroll",
  "tracking_info": null,
  "user_id": "88fef4cea64c40b5ad6727cc9b0b9fdc",
  "template_id": null
}

​
Event summary

EventTriggerKey Fields
link-connectedSuccessful connectionlink_id, data_source
link-disconnectedRefresh connection failurelink_id, data_source
link-deletedData and credentials removedlink_id, data_source