This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, go to https://wso2.com/documentation/.

Event Notification API

Owned by Former user (Deleted)
Last updated: Oct 12, 2020

Some content in this documentation is subject to the MIT Open Licence.

The Event Notification API specification describes the flows and payloads to allow ASPSPs to deliver event notifications to TPPs. The specification has four sub-specifications:

  • Event Notification Subscription API 
  • Callback URL API 
  • Real Time Event Notification API 
  • Aggregated Polling 

WSO2 Open Banking currently supports the following APIs.

The Event Notification Subscription API and the Callback URL API provide alternative mechanisms for TPPs to register for event notifications.

  • The Event Notification Subscription API allows TPPs to register to receive all or specific event types via the Real Time Event Notification API and/or the Aggregated Polling API.
  • The Callback URL API allows TPPs to register to receive a urn:uk:org:openbanking:events:resource-update event notification via the Real Time Event Notification API.

If the ASPSP chooses to provide both APIs for event notification registrations, any registration made using the Event Notification Subscription API replaces a registration made using the Callback URL API. Implementation of the Event Notification API specification and its individual sub-specifications are optional for both ASPSPs and TPPs. 

Basic flow

The steps and sequence diagram below provide a general outline of a notification flow for all resources in the read write APIs. In this sample flow, TPP registration for event notifications is performed using the Event Notification Subscription API.

  1. Setup Event Notification Subscription -  This flow begins with a TPP creating an event-subscription resource with an ASPSP. 
  2. Deliver Event Notification - An event corresponding to one of an ASPSP's event types occurs on a resource.
    1. ASPSP Sends Real Time Event Notification
      • A TPP provides a callback URL with the event-subscription resource to receive the real time event notification.
      • The ASPSP sends a signed event notification to the callback URL, detailing the nature of the event and identifying the affected resource.
      • The TPP may optionally initiate a client credential grant to retrieve the resource using the details contained in the event notification.
    2. TPP Requests Event Notifications
      • A TPP may request event notifications using aggregated polling.
  3. A TPP may Retrieve/Update/Delete the event notification subscription.

Sequence diagram