Documentation Library

Search for information on Hornbill Documentation.


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

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 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 over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title ||}}


  1. {{book.title}}

{{group.title ||}}


  1. {{book.title}}


Deals / Deal Merge

Operation Information

Merges a pair of Pipedrive Deals.

This is a Premium Integration.


This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type API Key.

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 API Key in the Type pick list;
  • Give the API Key KeySafe key a Title (this is the name / identifier for the API Key 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
ApiKey string Authentication Key
API Endpoint string Optional API Endpoint


The API Endpoint field is not required to be populated for this integration - just an API Key for your Pipedrive account.

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.


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

Input Parameters

Display Name ID Type Description Required Supported Values
Deal ID id number ID of the deal Yes None provided
Deal to merge ID mergeId number ID of the deal you want to merge with Yes None provided

Output Parameters

Display Name ID Type Description
Deal ID id number None provided
Creator User ID creator_user_id number User ID for the creator of the deal
User ID user_id number User ID for the owner of the deal
Person ID person_id number User ID for the person associated to the deal
Organization ID org_id number None provided
Stage ID stage_id number None provided
Deal Title title string None provided
Deal Value value number None provided
Currency currency string 3 character code for the currency
Add Time add_time string None provided
Update Time update_time string None provided
Stage Change Time stage_change_time string None provided
Deal Active? active boolean None provided
Deal Deleted? deleted boolean None provided
Deal Status status string None provided
Next Activity Date next_activity_date string None provided
Next Activity Time next_activity_time string None provided
Next Activity ID next_activity_id number None provided
Last Activity ID last_activity_id number None provided
Last Activity Date last_activity_date string None provided
Lost Reason lost_reason string The reason that the deal was lost
Visible To visible_to string The number of users the deal is visible to
Close Time close_time string None provided
Pipeline ID pipeline_id number None provided
Won Time won_time string None provided
First Won Time first_won_time string None provided
Lost Time lost_time string None provided
Products Count products_count number None provided
Files Count files_count number None provided
Notes COunt notes_count number None provided
Followers Count followers_count number None provided
Email Messages Count email_messages_count number None provided
Activities Count activities_count number None provided
Done Activities Count done_activities_count number None provided
Undone Activities Count undone_activities_count number None provided
Reference Activities Count reference_activities_count string None provided
Participants Count participants_count number None provided
Expected Close Date expected_close_date string None provided
Last Incoming Mail Time last_incoming_mail_time string None provided
Last Outgoing Mail Time last_outgoing_mail_time string None provided
Stage Order NR stage_order_nr number None provided
Person Name person_name string None provided
Organization Name org_name string None provided
Next Activity Subject next_activity_subject string None provided
Next Activity Type next_activity_type string None provided
Next Activity Duration next_activity_duration string None provided
Next Activity Note next_activity_note string None provided
Formatted Value formatted_value string None provided
Rotten Time rotten_time string None provided
Weighted Value weighted_value number None provided
Formatted Weighted Value formatted_weighted_value string None provided
Owner Name owner_name string None provided
CC Email cc_email string None provided
Organization Hidden org_hidden boolean None provided
Person Hidden person_hidden boolean None provided
Merge What ID merge_what_id number None provided
In This Document