This integration is powered by Singer's Pipedrive tap. For support, visit the GitHub repo or join the Singer Slack.
Pipedrive feature snapshot
A high-level look at Stitch's Pipedrive (v05-10-2016) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release Status |
Deprecated |
Supported By | |
Stitch Plan |
Free |
||
DATA SELECTION | |||
Table Selection |
Unsupported |
Column Selection |
Unsupported |
REPLICATION SETTINGS | |||
Anchor Scheduling |
Unsupported |
Advanced Scheduling |
Unsupported |
Table-level Reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
TRANSPARENCY | |||
Extraction Logs |
Unsupported |
Loading Reports |
Supported |
Connecting Pipedrive
Connecting your Pipedrive data to Stitch is a five-step process:
- Create a Stitch Pipedrive user
- Retrieve your Pipedrive API token
- Add Pipedrive as a Stitch data source
- Define the Historical Sync
- Define the Replication Frequency
Creating a Stitch Pipedrive User
To ensure Stitch can access and replicate all your data, the Pipedrive credentials you use to connect to Stitch need Admin permissions. We recommend that you create a separate Pipedrive Admin user for Stitch, but this isn’t mandatory to use the integration. Creating a user for us simply makes our activity easier to distinguish in logs and audits.
If you don’t want to create a user for us, simply ensure that the credentials you use to connect to Stitch have Admin permissions. If the API token associated with a non-Admin user is used to set up the integration, Stitch may be unable to access and replicate all of your data.
Note that users are counted at the account-level in Pipedrive, not the company level. If you want to create a user for us and are concerned about the cost of your Pipedrive subscription, don’t worry - you won’t be charged twice.
Connecting Multiple Pipedrive Companies
If you want to connect more than one Pipedrive company to Stitch, you’ll have to repeat the entire process in this article for each company you want to add. Essentially, you’ll have to create a separate Pipedrive integration for each company.
Our Pipedrive integration uses an API Token to authenticate. Pipedrive API tokens are unique not only at the user level, but the company level as well. This means that a user’s API Token will vary from company to company, even if everything is housed in the same Pipedrive account.
Retrieving Your Pipedrive API Token
-
If you created a Pipedrive user for Stitch, sign into Pipedrive as the Stitch user.
If you didn’t, sign into Pipedrive as an Admin user.
- Click the user menu (where your avatar is) in the top right corner of the screen.
- Click Settings.
- In the settings menu, click API.
- The user’s API Token will display.
Leave this page open for now - you’ll need it to complete the setup in Stitch.
Add Pipedrive as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Pipedrive icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Pipedrive” would create a schema called
stitch_pipedrive
in the destination. Note: Schema names cannot be changed after you save the integration. - Paste the Pipedrive API Token into the API Token field.
Define the Historical Sync
The Sync Historical Data setting will define the starting date for your Pipedrive integration. This means that:
- For tables using Incremental Replication, data equal to or newer than this date will be replicated to your data warehouse.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond Pipedrive’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Pipedrive integrations support the following replication scheduling methods:
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Initial and historical replication jobs
After you finish setting up Pipedrive, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Pipedrive Schema
Want to check out what your data looks like in Pipedrive’s API? If you still have your API Token handy, you can enter it on Pipedrive’s website to interact directly with the API and see your data in raw JSON format.
In the Attributes section for each table is a link to Pipedrive’s documentation for that endpoint. Use those links to interact with Pipedrive’s API.
Included Tables
Stitch's Pipedrive integration includes these tables:
- activities
- activity_types
- currencies
- deals
- email_messages
- email_threads
- files
- filters
- notes
- organizations
- persons
- pipelines
- products
- stages
- users
activities
Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?:
No
activities
table contains info about the activities (calls, tasks, lunches, etc.) in your Pipedrive account.activities Attributes
While we try to include everything Pipedrive has here, this may not be a full list of attributes. Refer to Pipedrive's documentation for a full list and description of each attribute.
Activity ID (
id
)active_flag
add_time
assigned_to_user_id
company_id
created_by_user_id
deal_dropbox_bcc
deal_id
deal_title
done
due_date
due_time
duration
marked_as_done_time
note
org_id
org_id
owner_name
person_dropbox_bcc
person_id
person_name
reference_type
subject
type
update_time
user_id
activity_types
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
activity_types
table contains info about the various activity types in your Pipedrive account.activity_types Attributes
While we try to include everything Pipedrive has here, this may not be a full list of attributes. Refer to Pipedrive's documentation for a full list and description of each attribute.
Activity Type ID (
id
)active_flag
add_time
icon_key
is_custom_flag
key_string
name
order_nr
currencies
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
currencies
table contains info about the currencies listed in your Pipedrive account.currencies Attributes
While we try to include everything Pipedrive has here, this may not be a full list of attributes. Refer to Pipedrive's documentation for a full list and description of each attribute.
Currency ID (
id
)active_flag
code
decimal_points
is_custom_flag
name
symbol
deals
Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?:
No
deals
table contains info about the deals in your Pipedrive account.deals Attributes
While we try to include everything Pipedrive has here, this may not be a full list of attributes. Refer to Pipedrive's documentation for a full list and description of each attribute.
Deal ID (
id
)active
activites_count
add_time
cc_email
creator_user_id
currency
deleted
done_activities_count
expected_close_date
followers_count
formatted_value
formatted_weighted_value
last_activity_date
last_activity_id
next_activity_date
next_activity_duration
next_activity_id
next_activity_note
next_activity_subject
next_activity_time
next_activity_type
notes_count
org_hidden
org_id
org_name
owner_name
participants_count
person_hidden
person_id
person_name
pipeline_id
reference_activites_count
rotten_time
stage_id
stage_order_nr
status
title
undone_activites_count
update_time
user_id
value
visible_to
weighted_value
email_messages
Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?:
Yes
email_messages
table contains info about the email messages sent and received through your Pipedrive account. Your Pipedrive account must have the Mailbox feature enabled to replicate this data.email_messages & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
email_messages Attributes
While we try to include everything Pipedrive has here, this may not be a full list of attributes. Refer to Pipedrive's documentation for a full list and description of each attribute.
Email Message ID (
id
)company_id
user_id
message_id
external_message_id
thread_id
mailbox
subject
summary
active
read
replied
sent
draft
has_body
include_body
read_time
language_code
reply_to_message_id
messages_to
*
messages_from
*
sent_error
attachment_count
draft_parameters
person_id
org_id
message_time
update_time
add_time
email_threads
Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?:
Yes
email_threads
table contains info about the email threads in your Pipedrive account. Individual emails are organized into threads.email_threads & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
email_threads Attributes
While we try to include everything Pipedrive has here, this may not be a full list of attributes. Refer to Pipedrive's documentation for a full list and description of each attribute.
Email Thread (
id
)company_id
user_id
deal_id
first_message_subject
last_message_subject
total_messages
unread_messages
last_message_summary
first_message_time
last_message_time
replied
shared
last_message_attachment
last_message_cc
last_message_bcc
active
attachment
draft_messages
org_id
add_time
update_time
last_message_from
*
last_message_to
*
labels
*
files
Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?:
No
files
table contains info about the files in your Pipedrive account.files Attributes
While we try to include everything Pipedrive has here, this may not be a full list of attributes. Refer to Pipedrive's documentation for a full list and description of each attribute.
File ID (
id
)name
type
active
inline
remote_location
remote_id
cid
s3_bucket
deal_name
person_name
org_name
product_name
url
description
add_time
update_time
user_id
person_id
org_id
product_id
email_message
activity
mail_message
filters
Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?:
No
filters
table contains info about the filters that can be applied to Deals, Persons, Organizations, Products, and Activities in your Pipedrive account.filters Attributes
While we try to include everything Pipedrive has here, this may not be a full list of attributes. Refer to Pipedrive's documentation for a full list and description of each attribute.
Filter ID (
id
)active_flag
add_time
name
type
update_time
user_id
visible_to
notes
Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?:
No
notes
table contains info about notes associated with deals.notes Attributes
While we try to include everything Pipedrive has here, this may not be a full list of attributes. Refer to Pipedrive's documentation for a full list and description of each attribute.
Note ID (
id
)active_flag
add_time
content
deal__title
deal_id
org_id
organization_name
pinned_to_deal_flag
pinned_to_organization_flag
pinned_to_person_flag
update_time
user__email
user__is_you
user__name
user_id
organizations
Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?:
No
organizations
table contains info about the organizations - or the companies you’re doing deals with - in your Pipedrive account.organizations Attributes
While we try to include everything Pipedrive has here, this may not be a full list of attributes. Refer to Pipedrive's documentation for a full list and description of each attribute.
Organization ID (
id
)active_flag
activities_count
add_time
address
address_admin_area_level_1
address_admin_area_level_2
address_country
address_formatted_address
address_locality
address_postal_code
address_route
address_street_number
address_sublocality
address_subpremise
cc_email
company_id
done_activities_count
email_messages_count
first_char
followers_count
last_activity_date
last_activity_id
lost_deals_count
name
next_activity_date
next_activity_id
next_activity_time
notes_count
open_deals_count
owner_id
people_count
reference_activites_count
undone_activities_count
update_time
visible_to
won_deals_count
persons
Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?:
Yes
persons
table contains info about the ‘persons’ in your Pipedrive account. These are the customers you’re doing deals with.persons & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
persons Attributes
While we try to include everything Pipedrive has here, this may not be a full list of attributes. Refer to Pipedrive's documentation for a full list and description of each attribute.
Person ID (
id
)active_flag
activities_count
add_time
cc_email
company_id
done_activities_count
email
*
email_messages_count
first_char
followers_count
last_activity_date
last_activity_id
last_incoming_mail_time
last_name
lost_deals_count
name
next_activity_date
next_activity_id
next_activity_time
notes_count
open_deals_count
org_id
org_name
owner_id
participant_closed_deals_count
participant_open_deals_count
phone
*
reference_activities_count
undone_activities_count
update_time
visible_to
won_deals_count
pipelines
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
pipelines
table contains info about the pipelines in your account.pipelines Attributes
While we try to include everything Pipedrive has here, this may not be a full list of attributes. Refer to Pipedrive's documentation for a full list and description of each attribute.
Pipeline ID (
id
)active
add_time
name
order_nr
selected
url_title
products
Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?:
No
products
table contains info about the products in your account. Products must be enabled in your account, or there’ll be no data for Stitch to replicate.A set of the prices__[currency]__[attribute]
columns will be created for every currency enabled in your account.
If USD, for example:
prices__usd__cost
-prices__usd__currency
prices__usd__id
prices__usd__overhead_cost
prices__usd__price
prices__usd__product_id
products Attributes
While we try to include everything Pipedrive has here, this may not be a full list of attributes. Refer to Pipedrive's documentation for a full list and description of each attribute.
Product ID (
id
)active
add_time
code
first_char
followers_count
name
owner_id
prices__[currency]__cost
prices__[currency]__currency
prices__[currency]__id
prices__[currency]__overhead_cost
prices__[currency]__price
prices__[currency]__product_id
selectable
tax
update_time
visible_to
stages
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
stages
table contains info about the stages in each of your pipelines.stages Attributes
While we try to include everything Pipedrive has here, this may not be a full list of attributes. Refer to Pipedrive's documentation for a full list and description of each attribute.
Stage ID (
id
)active_flag
add_time
deal_probability
name
order_nr
pipeline_id
pipeline_name
rotten_days
rotten_flag
update_time
users
Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?:
No
users
table contains information about the internal users of your Pipedrive account.users Attributes
While we try to include everything Pipedrive has here, this may not be a full list of attributes. Refer to Pipedrive's documentation for a full list and description of each attribute.
User ID (
id
)activated
active_flag
created
default_currency
email
is_admin
is_you
lang
last_login
locale
modified
name
phone
role_id
timezone_name
Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.