> ## Documentation Index
> Fetch the complete documentation index at: https://docs.runalloy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Pipedrive

> Integration details and setup guide for the Pipedrive connector in Alloy Automation.

## Pre-Built Tooling

| Category                            | Details                             |
| ----------------------------------- | ----------------------------------- |
| **Authentication**                  | API Key (Query Parameter or Header) |
| **Two-Way Sync**                    | No                                  |
| **Events Supported**                | No                                  |
| **Realtime**                        | Polling                             |
| **Supports Rate Limiting**          | Yes                                 |
| **Authentication Scopes Supported** | N/A (API Key)                       |

***

## Objects Supported

Alloy Automation supports syncing the following objects from **Pipedrive**:

* **Activities**
* **Deals**
* **Products**
* **Persons**
* **Organizations**
* **Pipelines**
* **Stages**

***

## Set Up Guide

### Trial Access

| Question                                           | Answer                                                                                                                       |
| -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| **Offers free trial?**                             | Yes. Pipedrive offers a 14-day free trial with no credit card required. [Start free trial](https://www.pipedrive.com/signup) |
| **Requires paid sandbox?**                         | No. The trial account can be used for testing and development.                                                               |
| **Requires partnership to obtain authentication?** | No. Any Pipedrive user can generate API keys from their account.                                                             |

***

### Authentication (API Key)

For customers who want to completely whitelabel their authentication experience, you can provide your own developer keys instead of using Alloy Automation's.

<steps>
  <step title="Create Pipedrive Account">
    Sign up for a free trial at [https://www.pipedrive.com](https://www.pipedrive.com) or log in to your existing Pipedrive account
  </step>

  <step title="Navigate to API Settings">
    1. Click on your profile icon in the top-right corner
    2. Select **Settings** from the dropdown menu
    3. In the left sidebar, scroll to **Personal** section
    4. Click on **API**
  </step>

  <step title="Generate API Key">
    1. On the API page, you'll see your personal API token
    2. If you don't have one, click **Generate new token** or **Copy** the existing token
    3. Copy the API token to your clipboard
    4. Store it securely (this token provides full access to your Pipedrive account)
  </step>

  <step title="Configure in Alloy Automation">
    1. In Alloy Automation, enter your Pipedrive API token
    2. The token can be sent as a query parameter (`api_token=YOUR_TOKEN`) or in headers
    3. Test the connection to verify authentication
  </step>
</steps>

For comprehensive API documentation, visit [Pipedrive API Reference](https://developers.pipedrive.com/docs/api/v1).

***

## Use Cases

### 1) CRM data synchronization

Sync deals, contacts, and activities between Pipedrive and other business systems to maintain a unified view of customer relationships across your organization.

### 2) Sales automation workflows

Automatically create deals, update stages, and log activities in Pipedrive based on triggers from other systems like email, forms, or e-commerce platforms.

### 3) Lead enrichment and routing

Enrich new Pipedrive leads with data from external sources and automatically route them to the appropriate sales representatives based on territory, industry, or deal size.

### 4) Sales reporting and analytics

Pull deal data, activity metrics, and pipeline information from Pipedrive into your analytics platform for custom reporting and sales performance dashboards.

### 5) Product catalog synchronization

Keep product information synchronized between Pipedrive and your e-commerce or ERP system to ensure sales teams have accurate pricing and product details.

***

## API Gotchas

* **Custom fields:** Pipedrive supports extensive custom fields which are identified by long hash keys (e.g., `a1b2c3d4e5f6`). Use the Fields API endpoints to map these hashes to human-readable field names.

* **API token in URLs:** When using API tokens as query parameters, be careful with logging and error handling to avoid exposing tokens in logs or error messages. Consider using header-based authentication when possible.

* **Rate limiting:** Pipedrive enforces rate limits (typically 100 requests per 2 seconds). Implement proper rate limiting handling with exponential backoff to avoid hitting limits.

* **Pagination:** List endpoints return paginated results. Use the `start` and `limit` parameters along with pagination metadata in responses to retrieve all records.

* **Time zones:** Pipedrive stores dates in UTC but may display them in user-specific time zones. Be mindful of time zone conversions when working with date fields.

> For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**.