Onboard with NHS Notify - You must follow the steps to prepare for integration

To set up an APIM application ID, you need to:

1. Sign in to your NHS Digital developer account (opens in a new tab).
2. Create an APIM application.
3. Select ‘integration test’ as the environment.
4. Select ‘Communications Manager (integration environment)’ as the connected API.

To see how your messages perform, you can get the status of a message (opens in a new tab) or choose to receive realtime message callbacks (opens in a new tab).

If you want to receive realtime message status callbacks, you’ll need to:

• decide which message, channel or supplier statuses you want to receive
• prepare an endpoint URL for your integration

You can only use NHS Notify if your organisation or service sends messages that are:

• part of a campaign
• triggered when something happens in your service
• sent directly on a one-to-one basis

When you send messages you’ll need to tell your recipients who your messages are from by creating message sender names.

Before you provide your message sender names, you should understand more about:

• NHS App sender names
• email sender names and from addresses
• email reply-to email addresses
• text message sender names

You’ll be asked if your organisation or service will:

• have finished drafts of the messages you want to send
• send NHS App messages and if so, which links and URLs you’ll include
• send letters in other languages and if so, which languages
• send letters in accessible formats and if so, which formats
• use Personal Demographics Service (PDS) fields
• have your PDS test data ready
• use custom personalisation fields
• have test data prepared for your custom personalisation fields

The form will also ask for the routing plans that you want to use for your messages.

You do not need to do this if you send direct messages and use free-text inputs.

When you get access to NHS Notify’s integration environment, you’ll need to create and submit your templates. These templates will be used as the messages you send when you go live.

To access this feature, you must nominate someone in your organisation or service to sign in with NHS Notify. This is because creating and submitting templates is only available to one person in an organisation or service at this time.

To sign into NHS Notify you must have a Care Identity (CIS2 authentication). If you do not have a Care Identity, we can help you create one.

We need to understand how many messages you need to send and how often to set up your integration environment.

You’ll need to provide:

• how many messages you want to send per day
• the maximum amount of messages you might send per day