Module pipedrive

ballerinax/pipedrive Ballerina library

2.0.0

Overview

Pipedrive is a sales CRM and pipeline management platform that helps sales teams track leads, deals, contacts, activities and products through customizable sales pipelines.

The Pipedrive connector offers APIs to connect and interact with the Pipedrive API v2 endpoints.

Key features

  • Manage deals, persons and organizations, including their followers and custom fields
  • Track activities and tasks, and keep them linked to deals, contacts and projects
  • Configure pipelines and stages, and monitor deal progress through them
  • Manage products, product variations, images and discounts attached to deals
  • Search across deals, persons, organizations, leads, products and projects

Setup guide

To use the Pipedrive connector, you need a Pipedrive account and an API token.

  1. If you do not have a Pipedrive account, sign up at pipedrive.com.

  2. Log in to your Pipedrive account and open your personal preferences from the account menu in the top right corner.

  3. Open the API tab and copy your personal API token.

Note: Applications that act on behalf of other Pipedrive users can authenticate with OAuth 2.0 instead. Register an app in the Pipedrive Developer Hub and use the refresh token grant configuration of the connector.

Quickstart

To use the pipedrive connector in your Ballerina application, update the .bal file as follows:

  1. Import the pipedrive module.

    Copy
    import ballerinax/pipedrive;
  2. Create a Config.toml file with your API token.

    Copy
    apiToken = "<Your Pipedrive API token>"
  3. Create a client with the API token and invoke an operation.

    Copy
    configurable string apiToken = ?;
    
    public function main() returns error? {
        pipedrive:Client pipedrive = check new ({auth: {xApiToken: apiToken}});
        pipedrive:GetPipelinesResponse _ = check pipedrive->getPipelines();
    }
  4. Use bal run to compile and run the Ballerina program.

Examples

The Pipedrive connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:

  1. Lead to deal onboarding - Create an organization and contact person, open a deal for them and schedule the first follow-up activity.
  2. Pipeline deal summary - Summarise the open deals of every sales pipeline by stage, paging through all deals.

Import

import ballerinax/pipedrive;Copy

Other versions

See more...

Metadata

Released date: about 20 hours ago

Version: 2.0.0

License: Apache-2.0


Security

Direct vulnerabilities: No known direct vulnerabilities

Indirect vulnerabilities: 

Checked on 2026-11-20 via OSV.dev


Compatibility

Platform: any

Ballerina version: 2201.12.0

GraalVM compatible: Yes


Pull count

Total: 1831

Current verison: 1


Weekly downloads


Source repository


Keywords

Vendor/Pipedrive

Area/CRM & Sales

Type/Connector


Contributors