Item webhooks communicate changes or errors with Items. Often, errors with item webhooks describe account linking problems that the end user must take action to remediate.

Item webhooks also communicate changes with particular items that are not erroneous, such as intentional unlinking of accounts.


An Item Has Encountered An Error.

The developer can subscribe to receive a notification whenever there is a problem with an Item that the developer has access to.

Subscribing

Receiving

Parameters

Webhook

Example Webhook

{
  "webhook_type": "ITEM",
  "webhook_code": "ERROR",
  "item_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",
  "error": {
    "display_message": null,
    "error_code": "ITEM_LOGIN_REQUIRED",
    "error_message": "the login details of this item have changed (credentials, MFA, or required user action) and a user login is required to update this information. use Link's update mode to restore the item to a good state",
    "error_type": "ITEM_ERROR",
    "status": 400
  }
}

An Item Is Approaching Expiration

Some institutions require users coming from the LinkMoney experience to periodically resupply their credentials to keep an account connection active. LinkMoney supplies developers with advance warning that such an expiration is approaching.

Subscribing

Receiving

Parameters

Webhook

Example Webhook