|
|
| (2 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| | + | This document can now be found at its new location in the [https://docs.hornbill.com/ibridge-packages/welcome Hornbill Document Library]. |
| | | | |
| − | <div style="border:1px solid #90C0FF; background:#D0E0FF; width:99%; padding:4px; margin-bottom:10px;">
| + | [[file:hornbill-document-library.png|iBridge Package Reference|link=https://docs.hornbill.com/ibridge-packages/welcome]] |
| − | __NOTOC__[[Main Page|Home]] > [[Integration]] > [[Business Process Automation & Orchestration]] > [[Hornbill iBridge]] > GOV.UK Notify
| + | [[Category:HDOC]] |
| − | </div>
| |
| − | {|style="width: 100%"
| |
| − | |- valign="top"
| |
| − | |style="width:63%"|
| |
| − | [[File:govuknotifylogo.png|x50px|link=https://www.notifications.service.gov.uk/]]
| |
| − | ===Public Sector Cloud-based Notifications Service===
| |
| − | | |
| − | The GOV.UK Notify '''[[Cloud Automation]]''' operations for Hornbill allow you to automate the sending of SMS messages, emails and physical letters through the GOV.UK Notify service.
| |
| − | | |
| − | '''GOV.UK Notify''' is a [[Hornbill_iBridge#Premium_Integrations|Premium Integration]] [[File:Green_Dollar.png|12px|link=https://wiki.hornbill.com/index.php/Hornbill_iBridge#Premium_Integrations|Premium Integration]]
| |
| − | |style="width:5%"|
| |
| − | | |
| − | |style="width:15%"|
| |
| − | |
| |
| − | |style="width:22%; border-style: solid; border-width: 1px; border-color:#e6e6e6; background-color:#f2f2f2;"|
| |
| − | | |
| − | ==Related Articles==
| |
| − | :* [[Hornbill iBridge]]
| |
| − | :* [[Hornbill_iBridge#Premium_Integrations|Premium Integrations]]
| |
| − | :* [[Hornbill_KeySafe|KeySafe]]
| |
| − | :* [[Cloud Automation]]
| |
| − | :* [[Business_Process_Designer|Business Process Designer]]
| |
| − | :* [[Auto Tasks]]
| |
| − | :* [[Custom Buttons]]
| |
| − | :* [[Runbooks]]
| |
| − | |}
| |
| − | | |
| − | ==Authentication==
| |
| − | [[File:govuk_notify_keysafe.png|300px|right]]
| |
| − | | |
| − | In order to integrate with GOV.UK Notify, you will first need to configure, and securely store the authentication credentials for the GOV.UK Notify Account/s you want to use with the Hornbill App. You can configure your '''GOV.UK Notify''' account authentication in '''[[Hornbill_KeySafe|KeySafe]]''', as below.
| |
| − | | |
| − | ===Storing Credentials===
| |
| − | | |
| − | * In '''[[Administration]]''', navigate to System > Security > KeySafe;
| |
| − | * Select on '''+''' and select '''GOV.UK Notify''';
| |
| − | * Give the GOV.UK Notify KeySafe a Title (this is the name/identifier for the GOV.UK Notify API Key as you will see it when using the Integration Call node in your business process or custom button);
| |
| − | * Optionally populate the '''Description''' field;
| |
| − | * Provide a GOV.UK Notify API Key in the API Key field. You can find more information on how to generate API Keys in the [https://docs.notifications.service.gov.uk/rest-api.html#api-keys GOV.UK Notify documentation];
| |
| − | * Select '''Create Key''' to save.
| |
| − | | |
| − | Once you have created your Keysafe key, you can then use it to authenticate your GOV.UK Notify Cloud Automation operations.
| |
| − | | |
| − | ===Revoking Access===
| |
| − | | |
| − | If at any point you wish to revoke your Hornbill instances access to GOV.UK Notify, just select the relevant key in your Keysafe list and hit the '''Trash Can''' button to delete it
| |
| − | | |
| − | '''NOTE''': This will revoke the rights of any existing GOV.UK Notify Integration Calls in your Business Processes/Custom Buttons/Auto Tasks/Runbooks that are using the revoked GOV.UK Notify Account, so you will need to edit these accordingly.
| |
| − | | |
| − | ==Cloud Automation Operations==
| |
| − | | |
| − | You can automate the use of the operations listed below using '''[[Cloud Automation|Cloud Automations]]''' from within the '''[[Business_Process_Designer|Business Process Designer]]''', '''[[Auto Tasks]]''', '''[[Custom Buttons]]''' or '''[[Runbooks]]'''.
| |
| − | | |
| − | ===GOV.UK===
| |
| − | * Notify
| |
| − | :* Get Status
| |
| − | :* Send Email
| |
| − | :* Send Letter
| |
| − | :* Send SMS
| |
| − | <br/>
| |
| − | Read more about using '''[[Cloud Automation|Cloud Automations]]''' from the Related Articles section, and learn how to work with input and output parameters for each of the GOV.UK Notify operations.
| |
| − | | |
| − | ==Support==
| |
| − | | |
| − | If you have any questions regarding the GOV.UK Notify Keysafe Key or Operations, please visit the '''[https://community.hornbill.com/forum/132-integration-connectors-api-webhooks Hornbill Community Forums]'''.
| |
| − | | |
| − | [[Category:Integration]] | |
