Webhook schemas
CONNECTION_CREATED
Fired when a user successfully adds a Deck connection during a Link session. Contains the public token for the connection.
{
"webhook_type": "Link",
"webhook_code": "ConnectionCreated",
"link_token": "link-sandbox-af1a0311-da53-4636-b754-dd15cc058176",
"public_token": "public-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce993d",
"environment": "Sandbox"
}
DEFAULT_UPDATE
Fired when new data is available for a connection. The webhook type corresponds to the Product you've enabled. One event per product will be sent when new data becomes available.
Possible webhook types: SUSTAINABILITY, CREDIT_RISK, IDENTITY, BILL, EMPLOYMENT, FREELANCER
{
"webhook_type": "Sustainability",
"webhook_code": "DefaultUpdate",
"connection_id": "a8e32986-7023-400b-1ea6-08dcda78a78a",
"environment": "Production"
}
ERROR
Fired when an error is encountered with a connection. The error can be resolved by having the user go through Link’s update mode.
{
"webhook_type": "Connection",
"webhook_code": "Error",
"connection_id": "a8e32986-7023-400b-1ea6-08dcda78a78a",
"error": {
"error_category": "CONNECTION_ERROR",
"error_code": "INVALID_CREDENTIALS",
"error_message": "The provided credentials were not correct",
"display_message": "The provided credentials were not correct. Please try again."
},
"environment": "Production"
}
Updated 28 days ago