Events

Here is a list of the different webhook schemas fired your way in different cases.

ConnectionCreated

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"
}

InvalidCredentials

Fired when credentials provided were unsuccessful in authenticating with the source.

{
"connection_id":"ecaa8578-32cd-4a88-359c-08dd0772ccbe",
"webhook_type":"Connection",
"webhook_code":"InvalidCredentials",
"environment":"Development"
}

MfaQuestion

Fired when an MFA code is required during sign-in.

{
"message":"Enter MFA Code",
"connection_id":"ecaa8578-32cd-4a88-359c-08dd0772ccbe",
"webhook_type":"Connection",
"webhook_code":"MfaQuestion",
"environment":"Development"
}

DefaultUpdate

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.

{
"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"
}

ConnectionCompleted

Fired after all data is retrieved and processed for a connection.

{
"connection_id": "b4b29816-a933-4861-65d0-08dd6aef20d8",
"webhook_type": "Connection",
"webhook_code": "ConnectionCompleted",
"environment": "Development"
}