Documentation

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

Deals / Deal Get Info

Operation Information

Retrieves information about a Pipedrive Deal.

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

Tip

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.

Warning

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 dealId number Id of the deal to Load Yes None provided

Output Parameters

Display Name ID Type Description
Activities activities string Information about the number of activities against a deal
Creator User ID creator_user_id number ID for the user that created the deal
Creator Name creator_name string Name of the user that created the deal
Owner User ID owner_user_id number ID of the user responsible for the deal
Owner Email owner_email string Email of the user responsible for the deal
Owner Name owner_name string Name of the user responsible for the deal
Person User ID person_user_id number ID of the person associated with the deal
Person Email person_email string Email of the person associated with the deal
Person Name person_name string Name of the person associated with the deal
Organization Name org_name string Name of the organization associated with the deal
Organziation People Count org_people_count number Number of people associated with the organization
Organization Address org_address string Address of the organization
Stage ID stage_id number None provided
Deal Title title string None provided
Deal Value value number None provided
Deal Currency currency string The currency of the deal’s value
Deal Added added string Date that the deal was added
Deal updated updated string Date that the deal was last updated
Deal Active? active boolean Is the deal active?
Deal deleted deleted boolean Has the deal been deleted?
Deal Status status string None provided
Formatted Deal Value formatted_value string The formatted value of the deal
Lost Reason lost_reason string The reason the deal was lost
Follower Count followers_count string The number of followers of the deal
Participant Count participants_count string The number of participants on the deal
Expected Close Date expected_close_date string The date that the deal is expected to close
Next Activity Dave next_activity_date string The date of the next activity
Next Activity Time next_activity_time string The time of the next activity
Next Activity ID next_activity_id string ID of the next activity
Next Activity Subject next_activity_subject string The subject of the next activity
Last Activity ID last_activity_id string ID of the last activity
Least Activity Dave last_activity_date string The date of the last activity
Activities Count activities_count number The number of activities associated with a deal
Completed Activites Count activities_done_count string The number of completed activities
Uncommplete Activities count activities_undone_count string The number of activites that have not been completed
In This Document