Skip to content

Onboarding guidance updates#238

Merged
jamestynan-content merged 3 commits into
mainfrom
Onboarding-updates
Jun 30, 2026
Merged

Onboarding guidance updates#238
jamestynan-content merged 3 commits into
mainfrom
Onboarding-updates

Conversation

@jamestynan-content

Copy link
Copy Markdown
Contributor

Description

"If you're using NHS Notify API" section

  • Added a step guiding users on how to create an APIM application from their developer account dashboard.
  • In step 5 - updated "Communications Manager" to "NHS Notify API" to reflect the correct naming.

"Confirm your setup to get access to our integration environment" section

  • Removed the link and CTA to the online onboarding form.
  • Updated the call-out text to state that the form is now invite-only.

Context

Change 1: Clarifying APIM application creation

Integrators have been asking where to create an APIM application once they are in their developer account. This added step provides clear instructions so users can self-serve.

Change 2: Updating outdated naming

"Communications Manager API" is an outdated name and no longer appears in the developer account. It has been updated to the correct name: "NHS Notify API".

Change 3: Restricting access to the onboarding form

The onboarding form is invite-only and is emailed directly to integrators once they are cleared to onboard. Removing the public link prevents uninvited or premature form submissions.

Type of changes

  • [x ] Refactoring (non-breaking change)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would change existing functionality)
  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • [x ] I am familiar with the contributing guidelines
  • [x ] I have followed the code style of the project
  • I have added tests to cover my changes
  • I have updated the documentation accordingly
  • This PR is a result of pair or mob programming

Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.

  • [x ] I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.

@jamestynan-content jamestynan-content requested a review from a team as a code owner June 29, 2026 08:27

@emmagifford emmagifford left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes all look good to me!

@jamestynan-content jamestynan-content enabled auto-merge (squash) June 30, 2026 07:59
@jamestynan-content jamestynan-content merged commit 962988d into main Jun 30, 2026
27 checks passed
@jamestynan-content jamestynan-content deleted the Onboarding-updates branch June 30, 2026 08:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants