Skip to main content
Here is a list of the different webhook schemas fired your way in different cases.

​
Explanation of terms

Here is a list of possible outputs sent to you by webhooks and what they mean.
Output FieldDescription
connection_idUnique identifier for the connection
environmentEnvironment in which the action was made (sandbox or production)
messageInstructions or explanations for the user
webhook_codeCode for debugging
webhook_typeCategory of webhook
For more details, refer to the API reference.

​
Possible events

​
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"
}
Suggested action: None. The session is initializing and connecting to the source. A webhook should be coming soon.

​
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":"Sandbox"
  }
Suggested action: Call the jobs/mfa/answer endpoint with your answer.

​
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": "Jobs",
      "webhook_code": "DefaultUpdate",
      "connection_id": "a8e32986-7023-400b-1ea6-08dcda78a78a",
      "environment": "Production"
    }
Suggested action: Go and fetch that juicy new data!

​
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"
   }
Suggested action: Read the error message and try to fix it. If it doesn’t work, contact us.

​
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": "Sandbox"
  }
Suggested action: None. Once this webhook is received, the connection is considered completed. No additional events are expected after this.
⌘I