Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Notify / Send SMS

  • Article
  • 2 minutes to read

Operation Information

Hornbill Cloud Automation that allows you to send an SMS message via the GOV.UK Notify service. See the Send SMS API documentation for more information: https://docs.notifications.service.gov.uk/rest-api.html#send-a-text-message.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type GOV.UK Notify.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose GOV.UK Notify in the Type pick list;
  • Give the GOV.UK Notify KeySafe key a Title (this is the name / identifier for the GOV.UK Notify account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
API Key string API Key

Tip

The API Key field should be populated with a valid GOV.UK Notify API Key. You can find more information on how to generate API Keys in the GOV.UK Notify documentation.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked GOV.UK Notify account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Template ID templateId string The ID of the Template you wish to use Yes None provided
Phone Number phoneNumber string The phone number you wish to send the SMS to Yes None provided
Personalisation personalisation array If a template has placeholder fields for personalized information such as name or reference number, you must provide their values here, with key value pairs. No None provided
Reference reference string An identifier you can create if necessary, to identify a single notification or a batch of notifications No None provided
SMS Sender ID smsSenderID string A unique identifier of the sender of the text message notification No None provided

Output Parameters

Display Name ID Type Description
Outcome outcome string The outcome of the iBridge operation
Error error string Any errors returned from the iBridge operation
Message ID id string None provided
Message Content content string None provided
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document