INDEX
Documentation Library
Search for information on Hornbill Documentation.
{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}
-
{{resultItem.title}}
{{resultItem.url}}
Have questions about this site?
What is this site?
- This website is Hornbill's new product documentation website and is currently under development.
- It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
- Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
- Please feel free to have a look around at any time.
Why has Hornbill created this site?
- Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
- Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
- We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
- We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
- We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.
What will this site be good for?
- Community contribution will be facilitated, encouraged, and most welcome.
- High quality documentation, will be kept up to date as rapidly as our products evolve.
- Real-time content search and discovery.
- Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
- Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
- Documentation available in browser as well as printable/viewable as PDF on demand.
- Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
- Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.
What is the timeline for this site?
- We have taken the decision to publish and make available early, there is very little content at this time.
- As and when we have completed/usable documentation, it will be published here.
- We have a host of additional features we wish to add over time, so please watch this space.
- We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
- The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Operation Information
Sends an SMS to one or more mobile numbers (maximum of 50) from a FireText account.
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 API Key.
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 API Key in the Type pick list;
- Give the API Key KeySafe key a Title (this is the name / identifier for the API Key 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 |
---|---|---|
ApiKey | string |
Authentication Key |
API Endpoint | string |
Optional API Endpoint |
Tip
The API Endpoint field is not required to be populated for this integration - just the API Key for your FireText account.
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 API Key account, so you will need to manage these workflows accordingly.
Input Parameters
Display Name | ID | Type | Description | Required | Supported Values |
---|---|---|---|---|---|
Message | message |
string |
The text message body in utf-8. This can be up to 612 characters in length. For GSM, a single message is 160 characters, longer messages are 153 each (2=306,3=459,4=612). Unicode is 70 characters or 66 per part for longer messages | Yes | None provided |
From | from |
string |
The ‘Sender ID’ that is displayed when the message arrives on handset. This can be your company name or reply number. This field can only be alpha numeric. [A-Z], [a-z], [0-9], Min 3 chars, max 11 chars | Yes | None provided |
To | to |
array |
List of up to 50 mobile numbers. Remove the ‘+’ sign and any leading zeros when using international codes. A UK number can start ‘07’ or ‘447’ | Yes | None provided |
Schedule | schedule |
string |
The scheduled message date/time in the format YYYY-MM-DD HH:MM (e.g. 2015-05-20 17:00). Scheduled messages can be viewed and deleted online at FireText.co.uk | No | None provided |
Expired | expires |
string |
For repeat messages: Specifies when the repeat message should expire. Format YYYY-MM-DD (e.g. 2016-05-20) | No | None provided |
Interval | interval |
integer |
For repeat messages: Specifies the repeat interval between messages in days | No | None provided |
Reference | reference |
string |
If set, you can record a custom ID against the the message batch, which will be passed back in the delivery receipt | No | None provided |
Group | group |
string |
The API ID specified for the group. Any duplicates or opt-outs will be ignored | No | None provided |
Reciept | receipt |
string |
Alternate receipt URL. Instead of using the receipt URL as set within your FireText.co.uk account, receipts will be sent to this URL | No | None provided |
Template | template |
string |
The ID of a pre-defined template for your message content | No | None provided |
Unicode | unicode |
string |
This allows you to specify if the message is sent to the networks as GSM or Unicode characters. Unicode supports other languages and emojis | No | GSM Characters Only (default), Always assume Unicode, Auto-detect from the message content |
Sub-Account ID | subaccount |
string |
Your sub-account ID. Add a group for a given sub-account | No | None provided |
Output Parameters
Display Name | ID | Type | Description |
---|---|---|---|
Status | status |
string |
API Call Status - ok / failed |
Error | error |
string |
API Call Error from FireText |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}