Pipedrive

Availability: Airbyte Cloud: ✅, Airbyte OSS: ✅
Support Level: Community
Latest Version: 2.2.1
Definition Id: d8286229-c680-4063-8c59-23b9b391c700

This page contains the setup guide and reference information for the Pipedrive connector.

Prerequisites

• A Pipedrive account;
• An API token;
• A client_id, client_secret, and refresh_token.

Setup guide

The Pipedrive connector accepts two authentication flows:

Via API Token Authentication

Step 1 - Enable API Token:

If you don't see API next to the Your companies section, it's due to the permission sets handled by the company's admin. The company's admin can give you access to your API token by enabling it for you from the Settings in Pipedrive web app.

For more information, access enabling API for company users.

Step 2 - Find the API Token:

You can get the API Token manually from the Pipedrive web app by going to account name (on the top right) > Company settings > Personal preferences > API.

See How to find the API Token for detailed information.

Via OAuth

Step 1 - Register a Pipedrive app:

Pipedrive allows integrations with its API through registered apps. So, to authenticate Airbyte, first you need to create a Pipedrive private app in the marketplace. Follow these instructions to register your integration.

Step 2 - Follow the Oauth Authorization flow:

With the registered app, you can follow the authorization flow to obtain the client_id, client_secret, and refresh_token secrets. Pipedrive has documentation about it: https://pipedrive.readme.io/docs/marketplace-oauth-authorization.

Step 3 - Configure Airbyte:

Now you can fill the fields Client ID, Client Secret, and Refresh Token. Your Pipedrive connector is set up to work with the OAuth authentication.

Supported sync modes

The Pipedrive connector supports the following sync modes:

Feature	Supported?
Full Refresh Sync	Yes
Incremental Sync	Yes
Replicate Incremental Deletes	No
SSL connection	Yes
Namespaces	No

Supported Streams

Apart from Fields streams, all other streams support incremental.

• Activities

• ActivityFields

• ActivityTypes

• Currencies

• DealFields

• DealProducts

• Deals

• Files

• Filters

• Goals

• LeadLabels

• Leads

• Notes

• OrganizationFields

• Organizations

• PermissionSets

• PersonFields

• Persons

• Pipelines

• ProductFields

• Products

• Roles

• Stages

• Users

Performance considerations

The Pipedrive connector will gracefully handle rate limits. For more information, see the Pipedrive docs for rate limitations.

Changelog

Version	Date	Pull Request	Subject
2.2.1	2023-11-06	31147	Bugfix: handle records with a null data field
2.2.0	2023-10-25	31707	Add new stream mail
2.1.0	2023-10-10	31184	Add new stream goals
2.0.1	2023-10-13	31151	Add additionalProperties in schemas to read custom fields
2.0.0	2023-08-09	29293	Migrated to Low-Code CDK
1.0.0	2023-06-29	27832	Remove followers_count field from Products stream
0.1.19	2023-07-05	27967	Update OrganizationFields and ProductFields with display_field field
0.1.18	2023-06-02	26892	Update DialFields schema with pipeline_ids property
0.1.17	2023-03-21	24282	Bugfix handle missed cursor_field
0.1.16	2023-03-08	23789	Add 11 new streams
0.1.15	2023-03-02	23705	Disable OAuth
0.1.14	2023-03-01	23539	Fix schema for "activities", "check" works if empty "deals"
0.1.13	2022-09-16	16799	Migrate to per-stream state
0.1.12	2022-05-12	12806	Remove date-time format from schemas
0.1.10	2022-04-26	11870	Add 3 streams: DealFields, OrganizationFields and PersonFields
0.1.9	2021-12-07	8582	Update connector fields title/description
0.1.8	2021-11-16	7875	Extend schema for "persons" stream
0.1.7	2021-11-15	7968	Update oAuth flow config
0.1.6	2021-10-05	6821	Add OAuth support
0.1.5	2021-09-27	6441	Fix normalization error
0.1.4	2021-08-26	5943	Add organizations stream
0.1.3	2021-08-26	5642	Remove date-time from deals stream
0.1.2	2021-07-23	4912	Update money type to support floating point
0.1.1	2021-07-19	4686	Update spec.json
0.1.0	2021-07-19	4686	🎉 New source: Pipedrive connector