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

Collaboration / Create a New Contact

  • Article
  • 2 minutes to read

Operation Information

Hornbill Integration method for creating a new contact. The Hornbill account must be authenticated in KeySafe first.

This is a Free Tier Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Hornbill 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 Hornbill Authentication in the Type pick list;
  • Give the Hornbill Authentication KeySafe key a Title (this is the name / identifier for the Hornbill 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
Instance ID or URL string Hornbill Instance ID or API Endpoint URL
ApiKey string Authentication Key

Tip

Please read the Hornbill API Keys documentation to learn how to create and manage API Keys on the Hornbill platform.

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

Input Parameters

Display Name ID Type Description Required Supported Values
First Name aFirstName string First Name Yes None provided
Last Name bLastName string Last Name Yes None provided
Organization cOrganisationId string Organization No None provided
Job Title dJobTitle string Job Title No None provided
Phone Number ePhoneNumberOne string Primary Phone Number No None provided
Alternative Phone Number fPhoneNumberTwo string Alternative Phone Number No None provided
Primary Email gEmailOne string Primary Email Address No None provided
Alternative Email hEmailTwo string Alternative Email Address No None provided
Description iDescription string Description No None provided
Country jCountry string Country Code No None provided
Language kLanguage string Language Code No None provided
Owner lOwnerId string Contact owner Yes None provided
Notes mNotes string Notes No None provided
Private nPrivate string Mark as Private No None provided
Custom One oCustom1 string Custom Field One No None provided
Custom Two pCustom2 string Custom Field No None provided
Custom Three qCustom3 string Custom Field No None provided
Custom Four rCustom4 string Custom Field No None provided
Custom Five sCustom5 string Custom Field No None provided
Custom Six tCustom6 string Custom Field No None provided

Output Parameters

Display Name ID Type Description
Contact ID contactId string Contact ID
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document