notifications-node-client
Advanced tools
The notifications-node-client is an npm package designed to interact with the GOV.UK Notify service, which allows you to send emails, text messages, and letters. This package provides a simple interface to integrate these notification services into your Node.js applications.
Send Email
This feature allows you to send an email using a predefined template. You need to provide the template ID, recipient's email address, and any personalisation fields required by the template.
const NotifyClient = require('notifications-node-client').NotifyClient;
const notifyClient = new NotifyClient('your-api-key');
notifyClient.sendEmail('template-id', 'recipient@example.com', {
personalisation: {
name: 'John Doe',
reference: '12345'
},
reference: 'your-reference'
}).then(response => console.log(response)).catch(err => console.error(err));Send SMS
This feature allows you to send an SMS using a predefined template. You need to provide the template ID, recipient's phone number, and any personalisation fields required by the template.
const NotifyClient = require('notifications-node-client').NotifyClient;
const notifyClient = new NotifyClient('your-api-key');
notifyClient.sendSms('template-id', '07123456789', {
personalisation: {
name: 'John Doe',
reference: '12345'
},
reference: 'your-reference'
}).then(response => console.log(response)).catch(err => console.error(err));Send Letter
This feature allows you to send a letter using a predefined template. You need to provide the template ID and the recipient's address details.
const NotifyClient = require('notifications-node-client').NotifyClient;
const notifyClient = new NotifyClient('your-api-key');
notifyClient.sendLetter('template-id', {
personalisation: {
address_line_1: 'John Doe',
address_line_2: '123 Main Street',
postcode: 'AB1 2CD'
},
reference: 'your-reference'
}).then(response => console.log(response)).catch(err => console.error(err));Nodemailer is a module for Node.js applications to allow easy email sending. Unlike notifications-node-client, which is specific to the GOV.UK Notify service, Nodemailer is a more general-purpose email sending library that supports various transport methods including SMTP, AWS SES, and more.
Twilio is a comprehensive communication API that allows you to send SMS, make voice calls, and perform other communication tasks. It is more versatile compared to notifications-node-client, which is focused on the GOV.UK Notify service. Twilio supports a wide range of communication channels and is used globally.
SendGrid is a cloud-based service that provides email delivery and marketing campaigns. It offers a robust API for sending emails, managing lists, and tracking email performance. Unlike notifications-node-client, which is limited to the GOV.UK Notify service, SendGrid provides a broader range of email-related functionalities.
npm install --save notifications-node-client
var NotifyClient = require('notifications-node-client').NotifyClient,
notifyClient = new NotifyClient(apiKey);
Generate an API key by logging in to GOV.UK Notify and going to the API integration page.
notifyClient.setProxy(proxyUrl);
notifyClient
.sendSms(templateId, phoneNumber, personalisation, reference, smsSenderId)
.then(response => console.log(response))
.catch(err => console.error(err))
;
If the request is successful, response will be an object:
{
"id": "bfb50d92-100d-4b8b-b559-14fa3b091cda",
"reference": null,
"content": {
"body": "Some words",
"from_number": "40604"
},
"uri": "https://api.notifications.service.gov.uk/v2/notifications/ceb50d92-100d-4b8b-b559-14fa3b091cd",
"template": {
"id": "ceb50d92-100d-4b8b-b559-14fa3b091cda",
"version": 1,
"uri": "https://api.notifications.service.gov.uk/v2/templates/bfb50d92-100d-4b8b-b559-14fa3b091cda"
}
}
Otherwise the client will return an error err:
| `err.error.status_code` | `err.error.errors` |
|---|---|
429 |
[{
"error": "RateLimitError",
"message": "Exceeded rate limit for key type TEAM of 10 requests per 10 seconds"
}]
|
429 |
[{
"error": "TooManyRequestsError",
"message": "Exceeded send limits (50) for today"
}]
|
400 |
[{
"error": "BadRequestError",
"message": "Can"t send to this recipient using a team-only API key"
]}
|
400 |
[{
"error": "BadRequestError",
"message": "Can"t send to this recipient when service is in trial mode
- see https://www.notifications.service.gov.uk/trial-mode"
}]
|
phoneNumberThe phone number of the recipient, only required for sms notifications.
templateIdFind by clicking API info for the template you want to send.
referenceAn optional identifier you generate. The reference can be used as a unique reference for the notification. Because Notify does not require this reference to be unique you could also use this reference to identify a batch or group of notifications.
You can omit this argument if you do not require a reference for the notification.
personalisationIf a template has placeholders, you need to provide their values, for example:
personalisation={
'first_name': 'Amala',
'reference_number': '300241',
}
If you are not using the smsSenderId argument, this parameter can be omitted. Otherwise undefined should be passed in its place.
smsSenderIdOptional. Specifies the identifier of the sms sender to set for the notification. The identifiers are found in your service Settings, when you 'Manage' your 'Text message sender'.
If you omit this argument your default sms sender will be set for the notification.
If other optional arguments before smsSenderId are not in use they need to be set to undefined.
Example usage with optional reference -
sendSms('123', '+447900900123', undefined, 'your ref', '465')
Example usage with optional personalisation -
sendSms('123', '+447900900123', '{"name": "test"}', undefined, '465')
Example usage with only optional smsSenderId set -
sendSms('123', '+447900900123', undefined, undefined, '465')
notifyClient
.sendEmail(templateId, emailAddress, personalisation, reference, emailReplyToId)
.then(response => console.log(response))
.catch(err => console.error(err))
;
If the request is successful, response will be an object:
{
"id": "bfb50d92-100d-4b8b-b559-14fa3b091cda",
"reference": null,
"content": {
"subject": "Licence renewal",
"body": "Dear Bill, your licence is due for renewal on 3 January 2016.",
"from_email": "the_service@gov.uk"
},
"uri": "https://api.notifications.service.gov.uk/v2/notifications/ceb50d92-100d-4b8b-b559-14fa3b091cd",
"template": {
"id": "ceb50d92-100d-4b8b-b559-14fa3b091cda",
"version": 1,
"uri": "https://api.notificaitons.service.gov.uk/service/your_service_id/templates/bfb50d92-100d-4b8b-b559-14fa3b091cda"
}
}
Otherwise the client will return an error err:
| `err.error.status_code` | `err.error.errors` |
|---|---|
429 |
[{
"error": "RateLimitError",
"message": "Exceeded rate limit for key type TEAM of 10 requests per 10 seconds"
}]
|
429 |
[{
"error": "TooManyRequestsError",
"message": "Exceeded send limits (50) for today"
}]
|
400 |
[{
"error": "BadRequestError",
"message": "Can"t send to this recipient using a team-only API key"
]}
|
400 |
[{
"error": "BadRequestError",
"message": "Can"t send to this recipient when service is in trial mode
- see https://www.notifications.service.gov.uk/trial-mode"
}]
|
emailAddressThe email address of the recipient, only required for email notifications.
templateIdFind by clicking API info for the template you want to send.
referenceAn optional identifier you generate. The reference can be used as a unique reference for the notification. Because Notify does not require this reference to be unique you could also use this reference to identify a batch or group of notifications.
You can omit this argument if you do not require a reference for the notification.
emailReplyToIdOptional. Specifies the identifier of the email reply-to address to set for the notification. The identifiers are found in your service Settings, when you 'Manage' your 'Email reply to addresses'.
If you omit this argument your default email reply-to address will be set for the notification.
If other optional arguments before emailReplyToId are not in use they need to be set to undefined.
Example usage with optional reference -
sendEmail('123', 'test@gov.uk', undefined, 'your ref', '465')
Example usage with optional personalisation -
sendEmail('123', 'test@gov.uk', '{"name": "test"}', undefined, '465')
Example usage with only optional emailReplyToId set -
sendEmail('123', 'test@gov.uk', undefined, undefined, '465')
personalisationIf a template has placeholders, you need to provide their values, for example:
personalisation={
'first_name': 'Amala',
'application_number': '300241',
}
Otherwise the parameter can be omitted or undefined can be passed in its place.
notifyClient
.sendLetter(templateId, personalisation, reference)
.then(response => console.log(response))
.catch(err => console.error(err))
;
where personalisation is
personalisation={
'address_line_1': 'The Occupier', # required
'address_line_2': '123 High Street', # required
'address_line_3': 'London',
'postcode': 'SW14 6BH', # required
... # any other optional address lines, or personalisation fields found in your template
},
If the request is successful, response will be an object:
{
"id": "740e5834-3a29-46b4-9a6f-16142fde533a",
"reference": null,
"content": {
"subject": "Licence renewal",
"body": "Dear Bill, your licence is due for renewal on 3 January 2016.",
},
"uri": "https://api.notifications.service.gov.uk/v2/notifications/740e5834-3a29-46b4-9a6f-16142fde533a",
"template": {
"id": "f33517ff-2a88-4f6e-b855-c550268ce08a",
"version": 1,
"uri": "https://api.notifications.service.gov.uk/v2/template/f33517ff-2a88-4f6e-b855-c550268ce08a"
}
"scheduled_for": null
}
Otherwise the client will raise a HTTPError:
| `error.status_code` | `error.message` |
|---|---|
429 |
[{
"error": "RateLimitError",
"message": "Exceeded rate limit for key type live of 10 requests per 20 seconds"
}]
|
429 |
[{
"error": "TooManyRequestsError",
"message": "Exceeded send limits (50) for today"
}]
|
400 |
[{
"error": "BadRequestError",
"message": "Cannot send letters with a team api key"
]}
|
400 |
[{
"error": "BadRequestError",
"message": "Cannot send letters when service is in trial mode"
}]
|
400 |
[{
"error": "ValidationError",
"message": "personalisation address_line_1 is a required property"
}]
|
template_idFind by clicking API info for the template you want to send.
referenceAn optional identifier you generate. The reference can be used as a unique reference for the notification. Because Notify does not require this reference to be unique you could also use this reference to identify a batch or group of notifications.
You can omit this argument if you do not require a reference for the notification.
personalisationThe letter must contain:
personalisation={
'address_line_1': 'The Occupier', # mandatory address field
'address_line_2': 'Flat 2', # mandatory address field
'address_line_3': '123 High Street', # optional address field
'address_line_4': 'Richmond upon Thames', # optional address field
'address_line_5': 'London', # optional address field
'address_line_6': 'Middlesex', # optional address field
'postcode': 'SW14 6BH', # mandatory address field
'application_id': '1234', # field from template
'application_date': '2017-01-01', # field from template
}
notifyClient
.getNotificationById(notificationId)
.then((response) => { })
.catch((err) => {})
;
If the request is successful, response will be an object:
{
"id": "notify_id",
"body": "Hello Foo",
"subject": "null|email_subject",
"reference": "client reference",
"email_address": "email address",
"phone_number": "phone number",
"line_1": "full name of a person or company",
"line_2": "123 The Street",
"line_3": "Some Area",
"line_4": "Some Town",
"line_5": "Some county",
"line_6": "Something else",
"postcode": "postcode",
"type": "sms|letter|email",
"status": "current status",
"template": {
"version": 1,
"id": 1,
"uri": "/template/{id}/{version}"
},
"created_at": "created at",
"sent_at": "sent to provider at",
}
Otherwise the client will return an error err:
| `err.error.status_code` | `err.error.errors` |
|---|---|
404 |
[{
"error": "NoResultFound",
"message": "No result found"
}]
|
400 |
[{
"error": "ValidationError",
"message": "id is not a valid UUID"
}]
|
notifyClient
.getNotifications(templateType, status, reference, olderThan)
.then((response) => { })
.catch((err) => {})
;
If the request is successful, response will be an object:
{ "notifications":
[{
"id": "notify_id",
"reference": "client reference",
"email_address": "email address",
"phone_number": "phone number",
"line_1": "full name of a person or company",
"line_2": "123 The Street",
"line_3": "Some Area",
"line_4": "Some Town",
"line_5": "Some county",
"line_6": "Something else",
"postcode": "postcode",
"type": "sms | letter | email",
"status": sending | delivered | permanent-failure | temporary-failure | technical-failure
"template": {
"version": 1,
"id": 1,
"uri": "/template/{id}/{version}"
},
"created_at": "created at",
"sent_at": "sent to provider at",
},
…
],
"links": {
"current": "/notifications?template_type=sms&status=delivered",
"next": "/notifications?other_than=last_id_in_list&template_type=sms&status=delivered"
}
}
Otherwise the client will return an error err:
| `err.error.status_code` | `err.error.errors` |
|---|---|
400 |
[{
'error': 'ValidationError',
'message': 'bad status is not one of [created, sending, delivered, pending, failed, technical-failure, temporary-failure, permanent-failure]'
}]
|
400 |
[{
"error": "ValidationError",
"message": "Apple is not one of [sms, email, letter]"
}]
|
templateTypeIf omitted all messages are returned. Otherwise you can filter by:
emailsmsletterstatusIf omitted all messages are returned. Otherwise you can filter by:
sending - the message is queued to be sent by the provider.delivered - the message was successfully delivered.failed - this will return all failure statuses permanent-failure, temporary-failure and technical-failure.permanent-failure - the provider was unable to deliver message, email or phone number does not exist; remove this recipient from your list.temporary-failure - the provider was unable to deliver message, email box was full or the phone was turned off; you can try to send the message again.technical-failure - Notify had a technical failure; you can try to send the message again.referenceThis is the reference you gave at the time of sending the notification. This can be omitted to ignore the filter.
olderThanIf omitted all messages are returned. Otherwise you can filter to retrieve all notifications older than the given notification id.
notifyClient
.getTemplateById(templateId)
.then((response) => { })
.catch((err) => {})
;
If the request is successful, response will be an object:
{
"id": "template_id",
"type": "sms|email|letter",
"created_at": "created at",
"updated_at": "updated at",
"version": "version",
"created_by": "someone@example.com",
"body": "body",
"subject": "null|email_subject"
}
Otherwise the client will return an error err:
| `err.error.status_code` | `err.error.errors` |
|---|---|
404 |
[{
"error": "NoResultFound",
"message": "No result found"
]}
|
templateIdFind by clicking API info for the template you want to send.
notifyClient
.getTemplateByIdAndVersion(templateId, version)
.then((response) => { })
.catch((err) => {})
;
If the request is successful, response will be an object:
{
"id": "template_id",
"type": "sms|email|letter",
"created_at": "created at",
"updated_at": "updated at",
"version": "version",
"created_by": "someone@example.com",
"body": "body",
"subject": "null|email_subject"
}
Otherwise the client will return an error err:
| `err.error.status_code` | `err.error.errors` |
|---|---|
404 |
[{
"error": "NoResultFound",
"message": "No result found"
]}
|
templateIdFind by clicking API info for the template you want to send.
versionThe version number of the template
notifyClient
.getAllTemplates(templateType)
.then((response) => { })
.catch((err) => {})
;
This will return the latest version for each template
If the request is successful, response will be an object:
{
"templates" : [
{
"id": "template_id",
"type": "sms|email|letter",
"created_at": "created at",
"updated_at": "updated at",
"version": "version",
"created_by": "someone@example.com",
"body": "body",
"subject": "null|email_subject"
},
{
... another template
}
]
}
If no templates exist for a template type or there no templates for a service, the response will be an object with an empty templates list element:
{
"templates" : []
}
templateTypeIf omitted all messages are returned. Otherwise you can filter by:
emailsmsletterpersonalisation = { "foo": "bar" };
notifyClient
.previewTemplateById(templateId, personalisation)
.then((response) => { })
.catch((err) => {})
;
If the request is successful, response will be an object:
{
"id": "notify_id",
"type": "sms|email|letter",
"version": "version",
"body": "Hello bar" // with substitution values,
"subject": "null|email_subject"
}
Otherwise the client will return an error err:
| `err.error.status_code` | `err.error.errors` |
|---|---|
400 |
[{
"error": "BadRequestError",
"message": "Missing personalisation: [name]"
]}
|
404 |
[{
"error": "NoResultFound",
"message": "No result found"
]}
|
templateIdFind by clicking API info for the template you want to send.
personalisationIf a template has placeholders you need to provide their values. For example:
personalisation={
'first_name': 'Amala',
'reference_number': '300241',
}
Otherwise the parameter can be omitted or undefined can be passed in its place.
There are unit and integration tests that can be run to test functionality of the client. You will need to have the relevant environment variables sourced to run the tests.
To run the unit tests:
npm test
To run the integration tests:
npm test --integration
FAQs
GOV.UK Notify Node.js client
We found that notifications-node-client demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.