Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.withampersand.com/llms.txt

Use this file to discover all available pages before exploring further.

​
What’s Supported

​
Supported Actions

This connector supports:
  • Read Actions including full historic backfill. Incremental read is supported for select objects using the v2 API (see v2 API Objects below). For all other objects, a full read of the Pipedrive instance will be done for each scheduled read.
  • Write Actions
  • Proxy Actions, using the base URL https://api.pipedrive.com.
Pipedrive has a v1 and v2 API, if you would like to opt into the v2 API, then add module: crm to your amp.yaml file. Otherwise, v1 API is used. You can learn more about the difference between v1 and v2 API in Pipedrive documentation. 
specVersion: 1.0.0
integrations:
  - name: read-write-pipedrive
    provider: pipedrive
    module: "crm" # The CRM module uses v2 APIs

​
Supported Objects for V2 API

The Pipedrive connector supports reading and writing to the following objects.
ObjectIncremental Read
ActivitiesYes
DealsYes
OrganizationsYes
PersonsYes
PipelinesNo
ProductsNo
StagesNo

​
Reading Deal Products

If you would like to read Products associated with Deals, add products as a field in deals. 
specVersion: 1.0.0
integrations:
  - name: read-write-pipedrive
    provider: pipedrive
    # The CRM module uses v2 APIs, which is required for to read deal products
    module: "crm"
    read:
      objects:
        - objectName: deals
          destination: pipedrive-webhook
          schedule: "*/10 * * * *" # Every 10 minutes
          requiredFields:
            - fieldName: id
            - fieldName: products # Add products as a field

​
Example Integration

For an example manifest file of a Pipedrive v2 integration, visit our samples repo on Github.

​
Supported Objects for V1 API

The Pipedrive connector supports reading from the following objects using the v1 API: The Pipedrive connector supports writing to the following objects:

​
Example Integration

For an example manifest file of a Pipedrive v1 integration, visit our samples repo on Github.

​
Before You Get Started

To integrate Pipedrive with Ampersand, you will need a Pipedrive Account. Once your account is created, you’ll need to create an app in Pipedrive, configure the Ampersand redirect URI within the app, and obtain the following credentials from your app:
  • OAuth Client ID
  • OAuth Client Secret
You will then use these credentials to connect your application to Ampersand.

​
Create a Pipedrive Account

Here’s how you can sign up for a Pipedrive account:

​
Creating a Pipedrive App

Follow the steps below to create a Pipedrive app and add the Ampersand redirect URL.
  1. Log in to your Pipedrive account.
  2. Go to Developer Hub.
  3. Click the Create an app button.
  4. Select Create private app.
  5. Enter the following app details:
    • App Name: The name of your app.
    • Callback URL: Enter the Ampersand redirect URL: https://api.withampersand.com/callbacks/v1/oauth.
  6. In the OAuth and access scopes section, select the relevant scopes for your app.
  7. Click Save.
Alt text In the **Client ID **section of OAuth and access scopes, you will find the Client ID and Client Secret keys. Note these keys, as they are essential for connecting your app to Ampersand. Alt text

​
Add Your Pipedrive App Info to Ampersand

  1. Log in to your Ampersand Dashboard.
  2. Select the project where you want to create a Pipedrive integration. Alt text
  3. Select Provider Apps.
  4. Select Pipedrive from the Provider list.
  5. Enter the previously obtained Client ID in the Client ID field and Client Secret in the Client Secret field.
  6. Click Save Changes.