92c0530289
* 🐛 Source(Pipedrive): remove date-time format from schemas Pipedrive doesn't work with ISO format of date times. Example of format by Pipedrive: 2020-04-15 12:58:48 * chore: update changelog * chore: updated the source-pipedrive version * chore: update seed file Co-authored-by: Joël Luijmes <me@joell.dev>
102 lines
4.9 KiB
Markdown
102 lines
4.9 KiB
Markdown
# Pipedrive
|
|
|
|
## Overview
|
|
|
|
The Pipedrive connector can be used to sync your Pipedrive data. It supports full refresh sync for Deals, Leads, Activities, ActivityFields, Persons, Pipelines, Stages, Users streams and incremental sync for Activities, Deals, Persons, Pipelines, Stages, Users streams.
|
|
|
|
There was a priority to include at least a single stream of each stream type which is present on Pipedrive, so the list of the supported streams is meant to be easily extendable. By the way, we can only support incremental stream support for the streams listed [there](https://developers.pipedrive.com/docs/api/v1/Recents#getRecents).
|
|
|
|
### Output schema
|
|
|
|
Several output streams are available from this source:
|
|
|
|
* [Activities](https://developers.pipedrive.com/docs/api/v1/Activities#getActivities),
|
|
|
|
retrieved by [getRecents](https://developers.pipedrive.com/docs/api/v1/Recents#getRecents) \(incremental\)
|
|
|
|
* [ActivityFields](https://developers.pipedrive.com/docs/api/v1/ActivityFields#getActivityFields)
|
|
* [Deals](https://developers.pipedrive.com/docs/api/v1/Deals#getDeals),
|
|
|
|
retrieved by [getRecents](https://developers.pipedrive.com/docs/api/v1/Recents#getRecents) \(incremental\)
|
|
|
|
* [Leads](https://developers.pipedrive.com/docs/api/v1/Leads#getLeads)
|
|
* [Persons](https://developers.pipedrive.com/docs/api/v1/Persons#getPersons),
|
|
|
|
retrieved by [getRecents](https://developers.pipedrive.com/docs/api/v1/Recents#getRecents) \(incremental\)
|
|
|
|
* [Pipelines](https://developers.pipedrive.com/docs/api/v1/Pipelines#getPipelines),
|
|
|
|
retrieved by [getRecents](https://developers.pipedrive.com/docs/api/v1/Recents#getRecents) \(incremental\)
|
|
|
|
* [Stages](https://developers.pipedrive.com/docs/api/v1/Stages#getStages),
|
|
|
|
retrieved by [getRecents](https://developers.pipedrive.com/docs/api/v1/Recents#getRecents) \(incremental\)
|
|
|
|
* [Users](https://developers.pipedrive.com/docs/api/v1/Users#getUsers),
|
|
|
|
retrieved by [getRecents](https://developers.pipedrive.com/docs/api/v1/Recents#getRecents) \(incremental\)
|
|
|
|
### Features
|
|
|
|
| Feature | Supported? |
|
|
| :--- | :--- |
|
|
| Full Refresh Sync | Yes |
|
|
| Incremental Sync | Yes |
|
|
| Replicate Incremental Deletes | No |
|
|
| SSL connection | Yes |
|
|
| Namespaces | No |
|
|
|
|
### Performance considerations
|
|
|
|
The Pipedrive connector will gracefully handle rate limits. For more information, see [the Pipedrive docs for rate limitations](https://pipedrive.readme.io/docs/core-api-concepts-rate-limiting).
|
|
|
|
## Getting started
|
|
|
|
### Requirements
|
|
|
|
* Pipedrive Account with wright to generate API Token
|
|
|
|
### Setup guide
|
|
|
|
This connector supports only authentication with API Token. To obtain API Token follow the instructions below:
|
|
|
|
#### Enable API:
|
|
|
|
1. Click Manage users from the left-side menu.
|
|
2. Click on the Permission sets tab.
|
|
3. Choose the set where the user \(who needs the API enabled\) belongs to.
|
|
4. Lastly, click on "use API" on the right-hand side section \(you need to scroll down a bit\).
|
|
|
|
Now all users who belong in the set that has the API enabled can find their API token under
|
|
|
|
Settings > Personal Preferences > API in their Pipedrive web app.
|
|
|
|
See [Enabling API for company users](https://pipedrive.readme.io/docs/enabling-api-for-company-users) for more info.
|
|
|
|
#### How to find the API token:
|
|
|
|
1. Account name \(on the top right\)
|
|
2. Company settings
|
|
3. Personal preferences
|
|
4. API
|
|
5. Copy API Token
|
|
|
|
See [How to find the API token](https://pipedrive.readme.io/docs/how-to-find-the-api-token) for more info.
|
|
|
|
## Changelog
|
|
|
|
| Version | Date | Pull Request | Subject |
|
|
| :------ | :-------- | :----- | :------ |
|
|
| 0.1.12 | 2022-05-12 | [12806](https://github.com/airbytehq/airbyte/pull/12806) | Remove date-time format from schemas |
|
|
| 0.1.10 | 2022-04-26 | [11870](https://github.com/airbytehq/airbyte/pull/11870) | Add 3 streams: DealFields, OrganizationFields and PersonFields |
|
|
| 0.1.9 | 2021-12-07 | [8582](https://github.com/airbytehq/airbyte/pull/8582) | Update connector fields title/description |
|
|
| 0.1.8 | 2021-11-16 | [7875](https://github.com/airbytehq/airbyte/pull/7875) | Extend schema for "persons" stream |
|
|
| 0.1.7 | 2021-11-15 | [7968](https://github.com/airbytehq/airbyte/pull/7968) | Update oAuth flow config |
|
|
| 0.1.6 | 2021-10-05 | [6821](https://github.com/airbytehq/airbyte/pull/6821) | Add OAuth support |
|
|
| 0.1.5 | 2021-09-27 | [6441](https://github.com/airbytehq/airbyte/pull/6441) | Fix normalization error |
|
|
| 0.1.4 | 2021-08-26 | [5943](https://github.com/airbytehq/airbyte/pull/5943) | Add organizations stream |
|
|
| 0.1.3 | 2021-08-26 | [5642](https://github.com/airbytehq/airbyte/pull/5642) | Remove date-time from deals stream |
|
|
| 0.1.2 | 2021-07-23 | [4912](https://github.com/airbytehq/airbyte/pull/4912) | Update money type to support floating point |
|
|
| 0.1.1 | 2021-07-19 | [4686](https://github.com/airbytehq/airbyte/pull/4686) | Update spec.json |
|
|
| 0.1.0 | 2021-07-19 | [4686](https://github.com/airbytehq/airbyte/pull/4686) | Release Pipedrive connector! |
|