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 log in 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 APIs

Webhooks APIs

Customers can use the following webhooks services under cobrand\config\notifications\events end point:

Webhooks Supported Events

Yodlee supports webhooks for the following events:

  1. REFRESH

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.

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

  1. Is webhooks support available for the legacy SOAP and REST APIs?
    No. Webhooks support is available only on the new RESTful Yodlee APIs.
  2. 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.