How do I set up GOV.UK - Notify Integration

Created by Ben Hayes, Modified on Wed, 14 Jun, 2023 at 9:46 AM by Ben Hayes

As a Local Authority, you are able to use the Gov.uk Notify service to send text messages.   

This document outlines the configuration settings for the integration of SMS (short message service)  between the My Council Services (MCS) Platform and the Gov.uk Notify service.  This uses the standard Notify APIs and the MCS Enterprise Service Bus (ESB) functionality to achieve integration. At present the integration does not support multiple Gov.uk Notify service accounts.


There are 3 steps to this process:


  1. Notify Account details
  2. SMS Account settings
  3. Testing SMS Service


 

1.  GOV.UK Notify account details

You will need to set up a relevant account with your Gov.uk Notify service and log into the system.

Once signed up and logged into the service for your organisation, you will need to configure the following two items:-

1. Templates


You will need to generate an Template for the integration, this will be used to send the SMS message.. You will need just one Template for your system.  



From the main logon screen, select  Templates and then ‘Add New Template’.  Select ‘Text’   

Enter details as required:-

You can personalise this message, all options are available on this page.   Any text sent as part of an SMS from the MCS Platform will be present in the body of the message when sent. .

Once ‘Saved’ copy the template ID to your clipboard, this will be required as part of your set-up in MCS.


2. Generate an API Key

You will need to generate an API key for the integration.  You will need just one API key for your system.

From the login screen, select ‘API Integration’.  Select API Keys and then ‘Create an API Key’.

Enter an API Key and select the Type of Key.  Click ‘Continue’.  Select ‘Copy API Key to clipboard’, this will be required as part of your set-up in MCS.

2.  SMS Account settings


You will need to configure an SMS account in your system to send SMS messages to the notify.gov.uk service.

Go to Administration > Mail > Accounts > SMS

Select ‘Gov.uk Notify for SMS Service.

Enter the API Key and Template IDs from the previous step.

3.   Testing SMS Service

To test the service from MCS, go to Service Desk. Select a relevant Service Request to test. Within the Service Request, select  



‘Send - SMS’.  Enter the SMS content as required:-



The SMS will be sent to the number specified and will appear with the gov.uk Notify Service Name and content of the SMS.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article