Skip to main content
Back

Notifications API

Use this service to get updates about multiple applications submitted by the same business unit

Version and Status

Overview

The Notifications API provides a way of fetching updates about multiple applications submitted by the same business unit. Currently, this service only supports a pull interaction model, where notifications must be requested periodically. However, more information about a push interaction model will be shared in future.

This API has two endpoints:

  • GET /v1/notifications get all notifications that match the provided filters
  • POST /v1/notifications/acknowledge - notify HMLR that notifications have been received

View the technical guide

View the API specification

How the API works

A diagram showing the interaction of the Notification API.

This diagram demonstrates how the Notifications API works to support users.

A user may send requests to receive notifications about multiple applications at the same time using the Get notifications API. The HMLR system will respond by providing information relevant to the request.

A user can also notify HMLR that it has received notifications using the Acknowledge notifications API. The system will acknolwedge this notification.

How to test this API

HMLR has created a test environment for the Notifications API. We’ve also provided example code to demonstrate what you should expect when developing your own services.

Please note there are also plans to release a sandbox test environment for developers in the future. The exact release date is to be confirmed.

For general testing guidance, visit our guide to testing.