Skip to main content

PIPEDRIVE Library

The PIPEDRIVE Library is an importable library containing functions to connect, authenticate, and interact with the PIPEDRIVE API. This library is used in the Pipedrive Adapter.

Import the PIPEDRIVE library into your project. Typically only the PIPEDRIVEclient module needs to be required in order to create the client and access the API methods.

require "PIPEDRIVE.PIPEDRIVEclient"

How it works:​

Use the Translator's built in help to review how to use each function:

PIPEDRIVEclient - sets up the adapter framework

Creates the PIPEDRIVE adapter framework, adding the various method modules to a metatable and storing the configurations added to the custom fields.

PIPEDRIVEcustom - makes API requests and returns the response

Takes in any API requests and parameters to make the API call and return the response.

The provided methods are sample ones based on common operations, but you can customize and add new ones on your own:

  • PIPEDRIVEaddDeal - creates a new deal

  • PIPEDRIVEaddPerson - creates a new person

  • PIPEDRIVEgetCustomFields - creates a dictionary of all the custom fields

  • PIPEDRIVEgetDeal - retrieves a deal's details

  • PIPEDRIVEgetRecent - gets recent items from Pipedrive based on the provided item type(s)