Swift provides a notification platform for notification providers to send timely and relevant notification events to subscribers who want to receive them. Here are the APIs that support notifications:
Follow the steps below to subscribe notification events of a service as well as providing notification events to your subscriber.
Set up your web server to process inbound notification events with TLS certificate and configure the server to be activated on port 443. Choose from the connectivity options to help you process inbound notification events. Then, follow the steps below to receive notification events from the service provider.
The web server used to receive and handle notification events needs to be registered as a trusted server in order for the notitificatin events to be successfully delivered. This web server should be connected to the multi-vendor secure IP network (MV-SIPN)The Swift architecture based on a network model that uses state-of-the-art security (secure IP network). The multi-vendor secure IP network also improves resilience and capacity, while avoiding dependency on a single network supplier. through a VPN box. The registration process involves sending us some information about your web server in exchange for a unique domain address that is issued by Swift. We provide an API for you to manage the registration programmatically.
Refer to Domain Registration API for adding, updating, removing and listing of domains. The Domain Registration API is only available through MV-SIPN and you are required to use the same web server to make the API call. /swift-notifications-apis
Notification subscribers are responsible for load balancing among servers dedicated to receive and process notification events if multiple servers are involved. Swift delivers notifications to the above mentioned registered server only.
After successfully registering your web server, you can subscribe to the specific notification events of your choice. Here are the APIs that support notifications:
Refer to Notification Subscription API for creating, retrieving, modifying and deleting subscriptions.
After successfully subscribed to notifications, you can expect to receive notification events from the provider. Ensure the server is activated on port 443. All notification events inherits the same structure in CloudEvents specification. CloudEvents is a standardised way to describe event data, making it easier to handle and integrate events across business use cases. The format enhances interoperability between different event generating applications.
Refer to Swift Notifications API as the parent specification for notification events, the event data schema will be defined by the notification service.
Swift notification platform mandates its providers to adopt CloudEvents specification to ensure standardisation and interoperability across the notification services by providing a consistent format for event data.
Follow the steps below if you are generating and publishing the notification events to your subscribers.
Do not include sensitive information in notification events.