Pipedrive – Docs

The official Pipedrive integration allows your bot to create, update and search for Pipedrive contacts.

Setup

You will need:

A published bot
A Pipedrive account

Install the integration in Botpress

First, install the integration to your bot:

In Botpress Studio, select Explore Hub in the upper-right corner.
Search for the Pipedrive integration, then select Install Integration.

In the Configuration menu, you should see one field: API Key. Leave it empty for now—you’ll come back to it after creating your Pipedrive API key.

Create a Pipedrive API key

Next, create a Pipedrive API key:

Log in to Pipedrive.

The API key will inherit the permissions of whatever user you’re logging in as. Because of this, we recommend using a dedicated Pipedrive user account for the API key.
This makes it easier to maintain the right permissions for the integration, or to rotate the key if it becomes compromised.
Open the My Account menu in the upper-right corner, then select Personal preferences.
Navigate to the API tab. You should see your personal API key—copy it.

If you don’t have an API key, select Generate new token.

Configure the integration in Botpress

Now, you can finish setting up the integration in Botpress:

In the integration’s API Key field, paste your Pipedrive API key.
Select Save Configuration.

Your Pipedrive integration is ready. You can use the integration’s Cards to interact with your Pipedrive contacts.

Cards

Add Person

Add a person in Pipedrive

inputobject

outputobject

Find Person

Search for a person in Pipedrive

inputobject

outputobject

Update Person

Update a person in Pipedrive

inputobject

outputobject

Triggers

Troubleshooting

If you run into errors when using the integration’s Cards, check out your bot’s Logs and locate the error message:

(Field) must be (data type)

Usually this means:

Not all the Card’s required input fields were filled
One of the fields contained invalid data

Double-check the input fields and try again. If you’re letting your bot fill the input fields automatically based on context, make sure it’s providing input that conforms to the Card’s expected format.

An unexpected error occurred

This could mean a few things:

Your Pipedrive API key may have been revoked. Create a new one and update your bot’s configuration.
Your API key may belong to a user that doesn’t have permission to perform the Card’s action. We recommend creating a dedicated Pipedrive user account for the API key and ensuring it has the necessary permissions for the Cards you want to use.
You may have exceeded Pipedrive’s API rate limit. Wait and retry according to Pipedrive’s documentation.

You can also consult Pipedrive’s error code reference for further troubleshooting.