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

Dispatch / Get

  • Article
  • 2 minutes to read

Operation Information

Retrieves details about a form dispatched from FastField.

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
User ID userId integer The User ID of the user who the dispatch was sent to Yes None provided
Dispatch ID dispatchId integer The ID of the dispatch Yes 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
Id id number Id
Dispatch Id dispatchId number Dispatch Id
Account Id accountId number Account Id
Form Id formId number Form Id
Form Unique Id formUniqueId string Form Unique Id
Form Name formName string Form Name
Message message string Message
Version version number Version
Name name string Name
Recalled recalled boolean Recalled
Updated At updatedAt string Updated At
Created By createdBy number Created By
Reference Id referenceId string Reference Id
Due Date dueDate string Due Date
Dispatch Status dispatchStatus string Dispatch Status
Workflow Status workflowStatus string Workflow Status
Location location string Location
Priority priority string Priority
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document