Documentation

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

Contacts / Edit Contact Advanced

Operation Information

This is a Hubspot integration that allows you to edit existing properties within Hubspot. There are 4 different types of Properties you can edit

  • String
  • Number
  • Date
  • Date Time

    Each one has a list of existing properties of that type that you can select and put a new property to be used.

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

    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 HubSpot in the Type pick list;
    • Give the HubSpot KeySafe key a Title (this is the name / identifier for the HubSpot account as you will see it when using the cloud automation node in your workflows);
    • Optionally populate the Description field;
    • Click the Create Key button to create your new key;
    • Once the Key is created, you will need to connect to the target service, and your account, in order to authorize the connector app access to the listed operations. Click the Connect button and you will be redirected to the service provider in a popup window;
    • Log in to your account, and then you will be prompted to review the options you are authorizing the Hornbill connector to be allowed to perform using the chosen account;
    • Accept the review and you will be returned to your KeySafe key.

    Revoking Access

    If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just hit the Revoke button in the relevant KeySafe key(s).

    Warning

    This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked HubSpot account, so you will need to manage these workflows accordingly.

    Input Parameters

    Display Name ID Type Description Required Supported Values
    Contact contact string None provided Yes None provided
    String Properties: propertiesstr array None provided No None provided
    Number Properties: propertiesnum array None provided No None provided
    Date Properties: propertiesdate array None provided No None provided
    Date Time Properties: propertiesdatetimem array None provided No None provided

    Output Parameters

    This integration returns no output parameters.

  • In This Document