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

Dispatch / Create

  • Article
  • 3 minutes to read

Operation Information

Dispatches a form to one or more users. Dispatched form notifications and messages will be sent to the recipient(s) email address. Dispatched forms can be found in the user’s Inbox folder within the FastField application.

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 FastField Forms Authentication.

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 FastField Forms Authentication in the Type pick list;
  • Give the FastField Forms Authentication KeySafe key a Title (this is the name / identifier for the FastField Forms Authentication 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
Username string FastField Forms Username
Password string FastField Forms Password
API Key string Authentication Key
Session Token string System populated, leave this field blank
Session Expires string System populated, leave this field blank

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 FastField Forms Authentication account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Form formId integer The Form to be dispatched Yes None provided
Name name string A name used to identify the dispatch Yes None provided
Due Date dueDate string ISO Format, e.g. 2017-12-03T08:38:27.771-08:00 Yes None provided
Reference ID referenceId string An external identifier assigned to the dispatch which can be used to uniquely identify the Dispatch record in FastField. Often the reference Id is used to reference an existing identifier from another system No None provided
Recipients recipients array An array of users to send the dispatched form to. Provide the User ID OR Email. If the recipient is not already a FastField user then you should also pass firstName and lastName data so their account may be created with this data (See autoCreateUsers property) No None provided
Auto-Create Users autoCreateUsers boolean If set to true and an email listed in the recipients list does not exist, will autocreate the given user No None provided
Message message string The message for this dispatch Yes None provided
Dispatch Email Subject dispatchEmailSubject string The email subject to show up in the users inbox Yes None provided
Dispatch Email Message dispatchEmailMessage string The email message body to show up in the users inbox Yes None provided
Merge Fields mergeFields array Fields you would like to pre populate before dispatching your form 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 FastField
Dispatch ID id integer None provided
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document