Pipedrive

Add a bot to Pipedrive using the official integration.

Open in Hubv

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

1. Install the integration in Botpress

   First, install the integration to your bot:

   1. In Botpress Studio, select Explore Hub in the upper-right corner.
   2. 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.

2. Create a Pipedrive API key

   Next, create a Pipedrive API key:

   1. 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.

   2. Open the My Account menu in the upper-right corner, then select Personal preferences.

   3. 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.

3. Configure the integration in Botpress

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

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

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

---

Cards

Here’s a reference for all Cards available with the integration:

Add Person

output · object

Show child attributes

success · boolean

data · object

Show child attributes

id · number

name · string

first_name · string

last_name · string

owner_id · number

org_id · number | null

add_time · string | null

update_time · string | null

emails · array

Show array item properties

value · string

primary · boolean

label · string

phones · array

Show array item properties

value · string

primary · boolean

label · string

is_deleted · boolean

visible_to · number

label_ids · array

picture_id · number | null

postal_address · object

Show child attributes

street_number · string

route · string

sublocality · string

locality · string

admin_area_level_1 · string

admin_area_level_2 · string

country · string

postal_code · string

formatted_address · string

notes · string

im · array

Show array item properties

protocol · string

value · string

birthday · string

job_title · string

Find Person

input · object

Show child attributes

fields · enum<string>

Available options: custom_fields, email, notes, phone, name

output · object

Show child attributes

success · boolean

data · object

Show child attributes

items · array

Show array item properties

result_score · number

item · object

Show child attributes

id · number

type · string

name · string

phones · array

emails · array

visible_to · number

owner · object

Show child attributes

id · number

name · string

email · string

organization · object

Show child attributes

id · number

name · string

custom_fields · array

notes · array

additional_data · string

Update Person

output · object

Show child attributes

success · boolean

data · object

Show child attributes

id · number

name · string

first_name · string

last_name · string

owner_id · number

org_id · number | null

add_time · string | null

update_time · string | null

emails · array

Show array item properties

value · string

primary · boolean

label · string

phones · array

Show array item properties

value · string

primary · boolean

label · string

is_deleted · boolean

visible_to · number

label_ids · array

picture_id · number | null

postal_address · object

Show child attributes

street_number · string

route · string

sublocality · string

locality · string

admin_area_level_1 · string

admin_area_level_2 · string

country · string

postal_code · string

formatted_address · string

notes · string

im · array

Show array item properties

protocol · string

value · string

birthday · string

job_title · string

---

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.