Event Subscription

The Event Subscription API facilitates the ability to subscribe to receive notifications about particular events of interest. Event Subscription endpoints are secured with basic authentication (admin username and password) and accept a JSON payload.

You can subscribe to receive notifications using this API for particular event types. WSO2 Open Banking Accelerator uses six API endpoints to manage event notification subscriptions.

  • Event Subscription Creation

API consumer applications can utilize this API to create event notification subscriptions tailored to their specific needs. By selecting the events they want to be notified about.

  • Event Subscription Retrieval

The API allows API consumer applications to retrieve information about specific event notification subscriptions they have previously established. This feature ensures that TPPs have easy access to their subscribed events and their respective configurations.

  • All Event Subscriptions Retrieval

API consumer applications can access a comprehensive list of all their event notification subscriptions..

  • Event Subscriptions Retrieval by an Subscribed Event Type

The API enables the API users to retrieve event notification subscriptions that have subscribed to a particular event type.

  • Event Subscription Updation

API consumer applications have the flexibility to update the data and configurations of their existing event notification subscriptions. This feature allows them to adapt to changing requirements and preferences seamlessly.

  • Event Subscription Deletion

The API allows API consumer applications to delete specific event notification subscriptions that are no longer required.

You can customize the Event Subscription Flow according to your requirements. For more information, see Customizing Event Notification.

Given below are sample Event Subscription request payloads and their responses:

  • Create an Event Notification Subscription
curl --location 'https://localhost:9446/api/openbanking/event-notifications/subscription/' \
--header 'Authorization: Basic YWRtaW5Ad3NvMi5jb206d3NvMjEyMw==' \
--header 'x-wso2-client_id: L5Ao9g7ZgzBifPSDKyr8vDZlllca' \
--header 'Content-Type: application/json' \
--data '{
        "callbackUrl": "https://tpp.com/open-banking/v3.1/event-notifications",
        "eventTypes":[
            "urn_uk_org_openbanking_events_resource-update",
            "urn_uk_org_openbanking_events_consent-authorization-revoked",
            "urn:ietf:params:scim:event:create"
        ],
        "version": "3.1"
}'
{
        "callbackUrl": "https://tpp.com/open-banking/v3.1/event-notifications",
        "subscriptionId": "77654c28-3c0f-4406-8ff3-7aa04efcbd33",
        "eventTypes": [
            "urn_uk_org_openbanking_events_resource-update",
            "urn_uk_org_openbanking_events_consent-authorization-revoked",
            "urn:ietf:params:scim:event:create"
        ],
        "version": "3.1"
}
  • Retrieve an Event Notification Subscription
curl --location 'https://localhost:9446/api/openbanking/event-notifications/subscription/<SUBSCRIPTION_ID>' \
--header 'Authorization: Basic YWRtaW5Ad3NvMi5jb206d3NvMjEyMw==' \
--header 'x-wso2-client_id: L5Ao9g7ZgzBifPSDKyr8vDZlllca' \
--header 'Content-Type: application/json' \
--data '’
{
   [
        {
            "callbackUrl": "updatedUrl",
            "subscriptionId": "e9125882-66ab-47d7-b9c0-3b55fe98ea84",
            "eventTypes": [
                "urn_uk_org_openbanking_events_resource-update",
                "urn_uk_org_openbanking_events_consent-authorization-revoked",
                "urn:ietf:params:scim:event:create"
            ],
            "version": "3.1"
        }
     ]
}
  • Retrieve All Event Notification Subscriptions
curl --location 'https://localhost:9446/api/openbanking/event-notifications/subscription/' \
--header 'Authorization: Basic YWRtaW5Ad3NvMi5jb206d3NvMjEyMw==' \
--header 'x-wso2-client_id: L5Ao9g7ZgzBifPSDKyr8vDZlllca' \
--header 'Content-Type: application/json' \
--data ''
{
   [
        {
            "callbackUrl": "updatedUrl",
            "subscriptionId": "e9125882-66ab-47d7-b9c0-3b55fe98ea84",
            "eventTypes": [
                "urn_uk_org_openbanking_events_resource-update",
                "urn_uk_org_openbanking_events_consent-authorization-revoked",
                "urn:ietf:params:scim:event:create"
            ],
            "version": "3.1"
        },
        {
            "callbackUrl": "updatedUrl",
            "subscriptionId": "e9125882-66ab-47d7-b9c0-3b55fe98ea84",
            "eventTypes": [
                "urn_uk_org_openbanking_events_resource-update",
                "urn_uk_org_openbanking_events_consent-authorization-revoked"
            ],
            "version": "3.1"
        }

    ]
}
  • Retrieve Event Notification Subscriptions by an Subscribed Event Type
curl --location 'https://localhost:9446/api/openbanking/event-notifications/subscription/type/<SUBSCRIBED_EVENT_TYPE>' \
--header 'Authorization: Basic YWRtaW5Ad3NvMi5jb206d3NvMjEyMw==' \
--header 'x-wso2-client_id: L5Ao9g7ZgzBifPSDKyr8vDZlllca' \
--header 'Content-Type: application/json'
{
   [
        {
            "callbackUrl": "updatedUrl",
            "subscriptionId": "e9125882-66ab-47d7-b9c0-3b55fe98ea84",
            "eventTypes": [
                "urn_uk_org_openbanking_events_consent-authorization-revoked",
                "urn:ietf:params:scim:event:create"
            ],
            "version": "3.1"
        },
        {
            "callbackUrl": "updatedUrl",
            "subscriptionId": "e9125882-66ab-47d7-b9c0-3b55fe98ea84",
            "eventTypes": [
                "urn_uk_org_openbanking_events_resource-update",
                "urn_uk_org_openbanking_events_consent-authorization-revoked"
            ],
            "version": "3.1"
        }

    ]
}
  • Update an Event Notification Subscription
curl --location --request PUT 'https://localhost:9446/api/openbanking/event-notifications/subscription/<SUBSCRIPTION_ID>' \
--header 'Authorization: Basic YWRtaW5Ad3NvMi5jb206d3NvMjEyMw==' \
--header 'x-wso2-client_id: L5Ao9g7ZgzBifPSDKyr8vDZlllca' \
--header 'Content-Type: application/json' \
--data '{
        "test": "updatedValue",
        "eventTypes":[
            "urn_uk_org_openbanking_events_resource-update",
            "urn_uk_org_openbanking_events_consent-authorization-revoked"
        ]
}'
{
        "callbackUrl": "updatedUrl",
        "subscriptionId": "e9125882-66ab-47d7-b9c0-3b55fe98ea84",
        "eventTypes": [
            "urn_uk_org_openbanking_events_resource-update",
             "urn_uk_org_openbanking_events_consent-authorization-revoked"
        ],
        "version": "3.1",
        "test": "updatedValue"
}
  • Delete an Event Notification Subscription
curl --location --request DELETE 'https://localhost:9446/api/openbanking/event-notifications/subscription/<SUBSCRIPTION_ID>' \
--header 'Authorization: Basic YWRtaW5Ad3NvMi5jb206d3NvMjEyMw==' \
--header 'x-wso2-client_id: L5Ao9g7ZgzBifPSDKyr8vDZlllca' \
--header 'Content-Type: application/json' \
--data ''
204 No Content
Top