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

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

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

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

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Contacts / Contact Update

  • Article
  • 4 minutes to read

Operation Information

Updates a Salesforce Contact.

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

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 oAuth 2.0 in the Type pick list;
  • Give the oAuth 2.0 KeySafe key a Title (this is the name / identifier for the oAuth 2.0 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
Client Id string Application Client Id
Client Secret string Application Client Secret
oAuth Scope string Application oAuth Scope
Authorize URL string Application Authorize URL
Access URL string Application Access UR
Response Type string Application Response Type
Additional Params string Application Additional Params
Additional Access Token Params string Application Additional Access Token Request Params
Grant Type string Application Grant Type
Refresh URL string Application Refresh URL
Refresh Grant Type string Application Refresh Grant Type
Refresh Body string Application Refresh Body
Revoke URL string Token Revoke URL
Token string Authentication Token
Refresh Token string Refresh Token
API Endpoint string Optional API Endpoint

Tip

Client ID and Client Secret should be populated with a valid Consumer Key and Consumer Secret. Values for the Authorize, Access, Refresh and Revoke URLs can be found on the Salesforce website.

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

Input Parameters

Display Name ID Type Description Required Supported Values
Account ID accountId string ID of the account this contact will be associated with No None provided
Assistant Name assistantName string Assistant Name for the contact No None provided
Assistant Phone assistantPhone string Assistant Phone Number for the contact No None provided
Birthdate birthdate string Birthdate of the contact No None provided
Contact ID contactId string ID of the contact record that will updated Yes None provided
Department department string Department of the contact No None provided
Description description string Description for the contact No None provided
Email email string Email address of the contact No None provided
Fax fax string Fax Number of the contact No None provided
First Name firstName string First Name of the contact No None provided
Home Phone homePhone string Home Phone Number of the contact No None provided
Instance instance string SalesForce Instance Name Yes None provided
Last Name lastName string Last Name of the contact No None provided
Lead Source leadSource string Lead source of the contact No Web, Phone Enquiry, Partner Referral, Purchased List, Other
Mailing City mailingCity string Mailing City for the contact No None provided
Mailing Country mailingCountry string Mailing Country for the contact No None provided
Mailing Postal Code mailingPostalCode string Mailing Postal Code for the contact No None provided
Mailing State mailingState string Mailing State for the contact No None provided
Mailing Street mailingStreet string Mailing Street for the contact No None provided
Mobile Phone mobilePhone string Mobile Phone Number of the contact No None provided
Shipping City otherCity string Other City for the contact No None provided
Shipping Country otherCountry string Other Country for the contact No None provided
Other Phone otherPhone string Other Phone Number of the contact No None provided
Shipping Postal Code otherPostalCode string Other Postal Code for the contact No None provided
Other State otherState string Other State for the contact No None provided
Other Street otherStreet string Other Street for the contact No None provided
Phone phone string Phone Number of the contact No None provided
Salutation salutation string Salutation of the contact No Mr., Ms., Mrs., Dr., Prof.
Title title string Title of the contact No None provided

Output Parameters

Display Name ID Type Description
Id id string Id of the contact that was generated
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document