GDS updates Notify API

The Government Digital Service has upgraded the public Application Programming Interface for GOV.UK Notify based on the results of user research carried out during its private beta.

Notify allows government departments to send citizens alerts straight to their phones – Photo credit: GDS

The notification service, which allows government to send text messages, emails and letters to citizens using a set of templates, sent its first messages to real users in May last year. GDS funds an allowance of email, text messages and letters for each service, which the team has previously said should cover most services’ needs.

The public API for GOV.UK Notify allows government services to use the system and get information on the progress of those notifications.

GDS has now upgraded this API, ahead of its move to public beta, with Notify technical lead Rebecca Laws saying the changes have been made to improve functionality following user research with service teams during the private beta.


Related content

GDS to cut GOV.UK frontend templates from 140 to 10
GDS to launch text notification service


The changes include more concise responses that are focused on the information service teams need, more filters to choose from when using the ‘get all notifications’ function on the API, and the ability to filter notifications by status and type.

In addition, the Notify team has updated error response formats so they are more informative and easier to understand, and now include the error name, status code and error message to help link error messages to relevant documentation.

There is also a new, optional input parameter for sending an email or text, ‘reference’, which allows teams to use their own unique identifiers for a notification or batch of notifications

Laws said that the team has also improved pagination by adding an ‘older than’ ID filter to get the next page of notifications to make sure pagination URLs are more consistent.

“Making changes to our API is not something we take lightly,” Laws wrote in a blogpost setting out the changes.

She said that all the client libraries had been updated to use version 2 of the API and were now available. Although older versions are still available, the latest client libraries will not be backwards-compatible due to the updates to the API responses.

“Upgrading to the latest version of the client libraries will take a small amount of work to make sure they integrate correctly with your service,” Laws said, adding that there was a CHANGEME file in the client library setting out the changes.

Laws said that new users should start with the latest client libraries, but that the old version would be maintained while existing client libraries are migrated.

The Notify team will also monitor the use of the old API, as well as helping service teams with their migration, to “ensure a smooth transition”.

At its launch in July 2016, GDS said that more than 70 service teams across central government were interested in using Notify, with the private beta involving HM Passport Office sending messages for passport applications and Lasting Power of Attorney deputy reports for the Office of the Public Guardian.

Rebecca.Hill

Learn More →

7 thoughts on “GDS updates Notify API

  1. Beauty Fashion December 6, 2024 at 11:03 pm

    Thanks for another fantastic article. Where else could anyone get that kind of information in such an ideal way of writing? I’ve a presentation next week, and I am on the look for such info.

  2. Hairstyles December 12, 2024 at 6:22 am

    you’ve got an excellent weblog right here! would you wish to make some invite posts on my blog?

  3. Hairstyles December 12, 2024 at 4:53 pm

    Based on my observation, after a property foreclosure home is offered at a bidding, it is common for the borrower to be able to still have a remaining unpaid debt on the personal loan. There are many creditors who make an effort to have all expenses and liens repaid by the following buyer. Having said that, depending on certain programs, polices, and state legislation there may be several loans that aren’t easily solved through the transfer of loans. Therefore, the duty still falls on the borrower that has received his or her property foreclosed on. Thank you sharing your thinking on this website.

  4. Beauty Fashion December 13, 2024 at 9:13 am

    One thing I’d prefer to reply to is that weightloss program fast can be achieved by the right diet and exercise. Your size not only affects the look, but also the actual quality of life. Self-esteem, depressive disorders, health risks, and physical abilities are impacted in weight gain. It is possible to do everything right but still gain. If this happens, a medical problem may be the perpetrator. While a lot of food instead of enough exercise are usually guilty, common health conditions and widespread prescriptions could greatly enhance size. Many thanks for your post in this article.

  5. Hairstyles December 31, 2024 at 11:12 pm

    Can I just say what a relief to search out somebody who really is aware of what theyre speaking about on the internet. You positively know easy methods to bring a problem to light and make it important. Extra people have to learn this and perceive this aspect of the story. I cant consider youre no more fashionable because you definitely have the gift.

  6. Hairstyles Color January 2, 2025 at 12:12 am

    Thanks for these tips. One thing I should also believe is the fact credit cards giving a 0 rate of interest often entice consumers together with zero monthly interest, instant approval and easy internet balance transfers, nevertheless beware of the number one factor that is going to void the 0 easy neighborhood annual percentage rate and also throw one out into the bad house quickly.

  7. Noel Little January 16, 2025 at 4:59 am

    Hi, yup this post is really nice and I have learned lot of things from it regarding blogging. thanks.

Leave a Reply

Your email address will not be published. Required fields are marked *