Link Connected
Sample webhook 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"
}
The link-connected
event occurs whenever the Link object is created and the status
of the first related Task is set to done
.
Link Disconnected
Sample webhook payload 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"
}
Event link-disconnected
occurs whenever any Refresh Task related to the Link fails with an error.
Link Deleted
Sample webhook payload for "link-deleted":
{
"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"
}
The link-deleted
event occurs whenever a Link is deleted and all personal data from the link (including credentials) are removed.