With Yodlee webhooks, developers don't have to poll an API every second to know the status of an async process. Instead, Yodlee will keep customers informed about the relevant stages the process has reached.

In Details

Webhook APIs

Webhooks Supported Events

Assets

Webhooks APIs

Customers can use the following webhooks services under the configs\notifications\events endpoint:

• Event subscription – Subscribing to the event
• Update subscription – Updating the callback URL
• Get event subscriptions – Retrieve events
• Remove subscription – Unsubscribe from an event

Webhooks Supported Events

Yodlee supports webhooks for the following events:

• REFRESH
• DATA_UPDATES
• AUTO_REFRESH_UPDATES

Event Payload Information

The payload sent to the customer-provided URL has a common structure; the data attribute within the structure varies for every notification event.

The following JSON payload gets posted to the callback URL and the content type will be application/json:

"event":{  
   "info":"REFRESH.PROCESS_COMPLETED",
   "data":{  
      <"Data varies from event to event">
   }
}

Note: loginName is an optional field and is available only for REFRESH webhooks event.

Best Practices