Documentation

This documentation is for developers who want to integrate the GOV.UK Notify API with a web application or back office system.

Client libraries

Links to documentation open in a new tab.

A developer should be able to set up the API client and start sending test messages in around 30 minutes. A full integration can take a few days, depending on the other systems you’re using.

Integrating directly with the API

We recommend using the client libraries rather than integrating directly with the API.

There’s no documentation for using the API in this way. You’ll still need to read the client documentation to understand:

  • what the API client does
  • what development work you’ll need to do

To send a message you’ll need to create an HTTPS request and add an authorisation header with your API key. The API key is encoded with JSON Web Tokens (JWT).