This guide provides step-by-step instructions to connect your GOV.UK Notify account to Flow and send a welcome email or text message when a customer is created.
Time required: 15 minutes
User role: Administrator
Module: Integrations
Overview
The GOV.UK Notify integration sends a message from your own Notify service when a customer is created in Flow. You choose the template in Notify, and whether it goes by email, text message or both.
Your message wording lives in Notify, not in Flow. To change what customers receive, edit the template in Notify. Flow fills in the customer's details and sends it.
Before You Start
The following will need to be completed before connecting GOV.UK Notify:
| Prerequisite | Details |
|---|---|
| ✅ Eligibility for GOV.UK Notify | Notify is for public sector organisations, such as local authorities. If you deliver services for a public sector organisation, someone at that organisation must create the Notify service and invite you to it. Charities and housing associations cannot use Notify in their own right. See Who can use GOV.UK Notify |
| ✅ A GOV.UK Notify service | Your organisation's own Notify service, with you as a team member |
| ✅ A live Notify service | New services start in trial mode and can only send to team members and the guest list. Request to go live from your service's Settings page before sending to customers |
| ✅ Administrator access in Flow | Required to manage integrations |
Important: Notify's terms allow only messages related to a transaction, or to something the recipient has subscribed to be updated about. Do not use it for marketing or promotional messages. A welcome message to a new customer is a service message. See the GOV.UK Notify terms of use.
Steps
1. Create Your Templates in Notify
- Sign in to GOV.UK Notify and open your service
- Go to Templates and create an email template, a text message template, or one of each
- Add any of the placeholders listed in What Data is Sent below, in double brackets, for example Hello ((first_name))
- Open each template and make a note of its template ID, shown on the template page
Important: Use only the placeholders listed below. If a template uses a placeholder Flow does not send, Notify rejects the message.
2. Create an API Key in Notify
- In your Notify service, go to API integration > API keys
- Click Create an API key
- Name: Enter a name you will recognise, for example OpenPlay Flow
- Type of key: Select Live to send to customers. Use Team and guest list while you are testing
- Click Continue, then copy the key. Notify only shows it once
3. Connect GOV.UK Notify in Flow
- Go to System Configuration > Data streams > Integrations > Third-Party Integrations
- Select GOV.UK Notify
- Click Connect
- API Key: Paste the key from step 2
- Click Save
Note: The key is checked the first time a message is sent, not when you save. If it is wrong, the first send fails with a message saying Notify rejected the key.
4. Configure the New Customer Workflow
This workflow sends your template when a customer is created in Flow.
- In the GOV.UK Notify integration settings, open New Customer
- Send by: Select Email, Text message (SMS) or Email and text message. If left blank, it sends email only
- Email template ID: Enter the ID of your email template, if sending by email
- Text message template ID: Enter the ID of your text message template, if sending by text message
- Toggle the workflow on
| Channel | Cost | Sent to |
|---|---|---|
| Free with Notify | The customer's email address | |
| Text message | Charged by Notify once your free allowance is used. See Notify pricing | The customer's mobile number. UK mobiles only, written in any common format, such as 07700 900123, +44 7700 900123 or +44 (0)7700 900123 |
What Data is Sent?
These placeholders can be used in any template. Every message includes all of them, so a template can use any combination.
| Placeholder | Flow field |
|---|---|
| ((first_name)) | First name |
| ((last_name)) | Last name |
| ((full_name)) | Full name |
| ((username)) | Username |
| ((home_venue)) | Preferred home venue |
Each message carries a reference, flow-user-created- followed by the customer's Flow ID, so you can find a customer's message in Notify.
Note: Staff accounts are never sent a message. Data flows one way, from Flow to Notify.
Result
New customers receive your Notify template within a few minutes of being created in Flow. You can see each message and its delivery status in Notify under API integration. Notify keeps messages for 7 days.
Troubleshooting
The workflow fails saying the template uses a placeholder Flow does not send?
Your template contains a placeholder that is not in the table above. Edit the template in Notify to use only the listed placeholders. The error names the placeholder.
The workflow fails saying the key can only send to team members or the guest list?
Your service is in trial mode, or you used a Team and guest list key. Request to go live in Notify, then create a Live key and paste it into the connection in Flow.
The workflow fails saying Notify rejected the API key?
The key is wrong or has been revoked in Notify. Create a new key in Notify and paste it into the connection in Flow.
The workflow fails saying Notify could not use the template?
Check the template ID in the workflow settings matches the template in Notify, and that the template is the right type for the channel: an email template for email, a text message template for text messages.
A customer did not receive a text message?
Text messages are only sent to valid UK mobile numbers. Common formats are all accepted, including 07700 900123, +44 7700 900123, +44 (0)7700 900123 and 0044 7700 900123. Landlines, international numbers and incomplete numbers are skipped, and the customer is still sent the email if you send both. Check the customer's mobile number in Flow.
A customer did not receive an email?
Customers without an email address are skipped. Check the customer's email address in Flow, then search for their reference in Notify to see the delivery status.