Webhooks
Events
Here is a list of the different webhook schemas fired your way in different cases.
Explanation of terms
Possible outputs from webhooks
Possible outputs from webhooks
Here is a list of possible outputs sent to you by webhooks and what they mean.
For more details, refer to the API reference.
| Output Field | Description |
|---|---|
connection_id | Unique identifier for the connection |
environment | Environment in which the action was made (sandbox or production) |
message | Instructions or explanations for the user |
webhook_code | Code for debugging |
webhook_type | Category of webhook |
Possible events
ConnectionCreated
ConnectionCreated
Fired when a user successfully adds a Deck connection during a Link session. Contains the public token for the connection.Suggested action: None. The session is initializing and connecting to the source. A webhook should be coming soon.
InvalidCredentials
InvalidCredentials
Fired when credentials provided were unsuccessful in authenticating with the source.Suggested action: Double-check that the credentials are valid and spelled correctly.
MfaQuestion
MfaQuestion
Fired when an MFA code is required during sign-in.Suggested action: Call the
jobs/mfa/answer endpoint with your answer.DefaultUpdate
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.Suggested action: Go and fetch that juicy new data!
Error
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.Suggested action: Read the error message and try to fix it. If it doesn’t work, contact us.
ConnectionCompleted
ConnectionCompleted
Fired after all data is retrieved and processed for a connection.Suggested action: None. Once this webhook is received, the connection is considered completed. No additional events are expected after this.