The Pipedrive Integration package allows you to interact with the Pipedrive API and perform account operations from within your Wix site.
Before using the package, set up the following:
Secrets Manager
pipedrive_api_token
.companydomain
to your Pipedrive company domain.This package includes two backend files. To use the functions in the files in your backend code, import them with the following syntax:
1
The following files are included in the package:
The code in this file contains functions for sending get
, post
, put
, patch
, and delete
requests to the Pipedrive API. For details on the parameters required for different requests and response object structures, see the Pipedrive API Reference.
To use the functions below in your code, import them with the following syntax:
1
getRequest()
Sends a get
request to the Pipedrive API to retrieve data from your account.
Syntax:
function getRequest (endpoint: string, queryParams: object): Promise<response: object>
Parameters:
/v1/
in the Pipedrive API.get
requests require.Example:
1
Returns:
A promise that resolves to a response
object. Different Pipedrive API endpoints return objects with different structures. See the Pipedrive API Reference for details.
postRequest()
Sends a post
request to the Pipedrive API to add data to your account.
Syntax:
function postRequest (endpoint: string, dataToSend: object): Promise<response: object>
Parameters:
/v1/
in the Pipedrive API.Example:
1
Returns:
A promise that resolves to a response
object. Different Pipedrive API endpoints return objects with different structures. See the Pipedrive API Reference for details.
putRequest()
Sends a put
request to the Pipedrive API to replace data in your account.
Syntax:
function putRequest (endpoint: string, dataToSend: object): Promise<response: object>
Parameters:
/v1/
in the Pipedrive API.Example:
1
Returns:
A promise that resolves to a response
object. Different Pipedrive API endpoints return objects with different structures. See the Pipedrive API Reference for details.
patchRequest()
Sends a patch
request to the Pipedrive API to update data in your account.
Syntax:
function patchRequest (endpoint: string, dataToSend: object): Promise<response: object>
Parameters:
/v1/
in the Pipedrive API.Example:
1
Returns:
A promise that resolves to a response
object. Different Pipedrive API endpoints return objects with different structures. See the Pipedrive API Reference for details.
deleteRequest()
Sends a delete
request to the Pipedrive API to delete data from your account.
Syntax:
function deleteRequest (endpoint: string, details: object): Promise<response: object>
Parameters:
/v1/
in the Pipedrive API.delete
requests require.Example:
1
Returns:
A promise that resolves to a response
object. Different Pipedrive API endpoints return objects with different structures. See the Pipedrive API Reference for details.
Note:
The response objects returned by these functions may include sensitive Pipedrive account data that you don’t want to expose. To call these functions from the frontend, create a .jsw file and define wrapper functions for the package functions that limit the returned data.
Example:
1
The code in this editable file contains the configuration for setting your company domain. Follow the instructions in the Setup section to set up the configurations.
1.0 Initial version
Pipedrive, crm