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}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}

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...

Groups / Create

  • Article
  • 2 minutes to read

Operation Information

Creates a new Group in 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
Name name string The group name Yes None provided
Description description string The description for your new group Yes None provided
From from string The default From (Sender ID) setting for your new group Yes None provided
API ID api string An optional API ID for your new group. Useful if looking to send or add contacts to this group later No None provided
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}}
In This Document