What is a REFRESH Event?

The event REFRESH refers to notifications that are sent during the stages of the add account and update account processes triggered by users in the FastLink application.

Notifications will be sent while customers edit credentials, add, or refresh/update accounts for the latest information using FastLink. The refresh webhooks notification let customers know:

• The provider site has requested MFA information to log in for aggregating data.
• The Yodlee system has successfully logged in to the provider site.
• The Yodlee system has successfully retrieved the account summary information from the provider site.

Note: Customers using FastLink 2.0 cannot subscribe to REFRESH notifications.

Types of REFRESH Event

There are two refresh-related events for which notifications will be sent to customers.

Interim Progress

The two interim progress events follow:

• Login Success: This notifies customers that the login action has successfully completed in the provider site.
• Account Summary: This notifies customers that the account summary information has been successfully retrieved from the provider site. This event is provider site-specific and will be provided to the customer as applicable.

Process Completed

This notifies customers that the process of adding or updating an account has completed.

Event Payload Information

The payload sent to the customer-provided URL has a common structure whereas the data attribute within the structure varies for every notification. The following JSON payload will be sent to the callback URL and the content type will be application/json:

"event": {
    "info": "REFRESH.PROCESS_COMPLETED",
    "loginName": "fri21",
    "data": {
      "providerAccount": [
        {
          "id": 10995860,
          "providerId": 16441,
          "isManual": false,
          "createdDate": "2017-12-22T05:47:35Z",
          "aggregationSource": "USER",
          "status": "SUCCESS",
         "requestId": "NSyMGo+R4dktywIu3hBIkc3PgWA=",
          "dataset": [
            {
              "name": "BASIC_AGG_DATA",
              "additionalStatus": "AVAILABLE_DATA_RETRIEVED",
              "updateEligibility": "ALLOW_UPDATE",
              "lastUpdated": "2017-12-22T05:48:16Z",
              "lastUpdateAttempt": "2017-12-22T05:48:16Z"
            }
          ]
        }
      ]
    }
  }

Event Attributes