What Are Webhooks?
Webhooks are notifications (HTTP callbacks) to customers that let them know an event has occurred. They can take relevant/useful actions as needed.
Benefits of Webhooks
With webhooks developers don't have to poll continuously to know the status of a process. Yodlee will keep customers informed about the event. Yodlee webhooks let customers know:
- the MFA information is requested by the provider site to login for aggregating data
- the Yodlee system has performed the login on the provider site successfully
- the Yodlee system has retrieved the account summary information from the provider site successfully
- the final status of account addition or update account calls
Webhooks Requests
Customers can use the following webhooks services under cobrand\config\notifications\events end point:
- event subscription – Subscribing for the event
- update subscription – Updating the callback URL
- get event subscriptions – Retrieve events
- remove subscription – Unsubscribe from event
Webhooks Supported Events
Yodlee supports webhooks for the following events:
Event Payload Information
The payload sent to the customer-provided URL has a common structure, wherein the data attribute within the structure varies for every notification event.
"event": {
"info": "REFRESH.PROCESS_COMPLETED",
"loginName": "yodleeuser", <"optional. The same will be provided based on ">
"data": {
<"Data varies from event to event">
}
}
Best Practices
- Customers should ensure that they whitelist the Yodlee IP addresses from which the notifications are sent.
- Customers should ensure that the URL has the default port (HTTPS–443, HTTP–80).
FAQs
- Is webhooks support available for the legacy SOAP and REST calls?
No. Webhooks support is available only on the new RESTful Yodlee calls. - Is Yodlee webhooks the same as alerts?
No. Yodlee webhooks are not alerts. Webhooks are the notifications sent to customers and not to the users. Customers are expected to take relevant actions as needed.