Webhooks

This page covers webhook response for Account Links.

Link connected

The sample webhook below is the payload for link-connected.

{
   "webhook_id":"ae53152c8c4c4636bda7f22f2cf6b0a5",
   "link_id":"9915c50cc047413bb810767f218390f8",
   "user_id": "88fef4cea64c40b5ad6727cc9b0b9fdc",
   "product":"employment",
   "tracking_info":null,
   "event_type":"link-connected",
   "event_created_at":"2022-08-23T17:32:30.217980Z",
   "user_id": "88fef4cea64c40b5ad6727cc9b0b9fdc",
   "template_id": null
}

The link-connected event occurs when the Link object is created. It displays the status of the first related Task when set to done.

Link disconnected

This webhook payload sample is for link-disconnected.

{
   "webhook_id":"ae53152c8c4c4636bda7f22f2cf6b0a5",
   "link_id":"9915c50cc047413bb810767f218390f8",
   "user_id":"88fef4cea64c40b5ad6727cc9b0b9fdc",
   "product":"employment",
   "tracking_info":null,
   "event_type":"link-disconnected",
   "event_created_at":"2022-08-23T17:32:30.217980Z",
   "user_id": "88fef4cea64c40b5ad6727cc9b0b9fdc",
   "template_id": null
}

The link-disconnected event occurs when refresh Tasks related to the Link fail or return with an error.

Link deleted

The payload sample below is for link-deleted webhook.

{
   "webhook_id":"ae53152c8c4c4636bda7f22f2cf6b0a5",
   "link_id":"9915c50cc047413bb810767f218390f8",
   "user_id":"88fef4cea64c40b5ad6727cc9b0b9fdc",
   "product":"employment",
   "tracking_info":null,
   "event_type":"link-deleted",
   "event_created_at":"2022-08-23T17:32:30.217980Z",
   "user_id": "88fef4cea64c40b5ad6727cc9b0b9fdc",
   "template_id": null
}

The link-deleted event occurs when deleting Links and all personal data from the Link, including credentials, are removed.