Pipedrive CRM v2

Provides integration with Pipedrive CRM to query and manage persons, organizations, leads, notes, and related records in your Workflows. The Node uses OAuth authentication and is available on Cloud Runtime Clusters.

Revision History

0.0.0.9 - Initial release.

Connection

Use this Connection to store your Pipedrive OAuth app credentials and the tokens generated when you authorize your account.

Setup Notes

1. Create a Pipedrive OAuth app and obtain its Client ID and Client Secret. See Pipedrive's app credential guide.
2. Set the app's OAuth callback URL to your Console's origin followed by /r/auth. For example, use https://appnew.flowgear.net/r/auth when connecting from https://appnew.flowgear.net. Pipedrive allows one callback URL per app.
3. Configure the app's access scopes for the operations you intend to use. Person and Organization queries require contacts:read or contacts:full; their create, update, and delete operations require contacts:full. Lead queries require leads:read or leads:full, and Lead mutations require leads:full. Refer to Pipedrive's scope and endpoint mapping for other operations.
4. Create a Pipedrive CRM Connection in Flowgear and enter the app credentials and the required space-separated Scopes, including base.
5. Authorize the Connection with your target Pipedrive account. Flowgear stores the returned access token, refresh token, API domain, and granted scopes.
6. Test the Connection. The test reads the current user through users/me without changing any records.

The default base scope supports the Connection test but does not grant access to all CRM operations. A successful test does not confirm permissions for every template. If you need additional scopes, update the app permissions and authorize the Connection again; refreshing a token does not grant new permissions.

Methods

Select a template for the Method you want to use. The template supplies OperationId and describes the available Options, request fields, and response fields. OperationId is the template's GUID, rather than a Pipedrive endpoint name or URL.

The supported operations are:

Person and Organization operations use the Pipedrive API v2. The other supported operations use the Pipedrive API v1. These API versions are independent of the Flowgear Runtime version.

Query

Reads records using the selected operation and automatically follows pagination for supported list queries.

Create

Creates one record for each JSON object supplied through Items.

Creating a Person or Organization requires name. Creating a Lead requires title and either person_id or organization_id. Creating a Note requires content and a linked entity ID exposed by its template.

Update

Updates the record identified by the selected operation's route values using one request per input item. Person and Organization updates use PATCH requests.

Delete

Deletes the record identified by Options. The Node sends no request body.

To update or delete different records, invoke the Node separately with each record's route ID in Options. Supplying different IDs in Items does not change the route.

Usage Notes

• Use only the route and query fields exposed by the selected template. Unknown options and operations from a different Method are rejected. The Node manages start, limit, and cursor. Do not add these pagination controls to Options.
• Templates describe the supported operations without reading your account's records. Template availability does not prove that your account has permission to execute an operation.
• Map arrays of strings or integers as CSV strings. For example, Lead label_ids contains comma-separated UUIDs, while Person and Organization label_ids contains comma-separated integer IDs. Contact query options such as ids and include_fields also use CSV. The Node converts these values to the provider's required format and rejects invalid UUIDs or integers.
• Keep object arrays structured, including Person emails and phone numbers. Organization addresses also retain their structured form.
• Account-specific custom_fields objects are preserved in requests and responses, but their child fields are absent from fixed templates. Define the child metadata in your Workflow when mapping these fields. The Node does not discover your account's custom field definitions.
• Lead query, create, and update responses include nullable archive_time and archive_reason fields. archive_time is a date-time string. Regenerate existing templates when you need these response fields.
• The first query page or mutation request executes when the Node starts. Later pages and input items are processed as the response stream is consumed.
• Check Flowgear.IsSuccess for each mutation result. Handled provider record errors and body-validation errors on later items produce failed rows and allow subsequent items to continue. Invalid first-item input, authentication or permission failures, transport failures, and server errors stop the Node.
• The Node makes bounded retries for token renewal and rate limiting. It does not automatically replay writes after an ambiguous timeout or server failure. Check Pipedrive before retrying a write that may already have succeeded.
• Deal, product, activity, pipeline, and stage CRUD operations are outside this Node's supported surface. Generic search, files, mail, projects, tasks, administration, webhooks, and API-key authentication are also unsupported.

Examples

Create a Person, then create a linked Lead

1. Select the Create template for adding a Person and supply the following object through Items:

{
  "name": "Example Contact"
}

2. Check the Person result's Flowgear.IsSuccess and retain its returned id.
3. Select the Create template for adding a Lead and map the returned Person ID into person_id. For example, if the Person ID is 123, supply:

{
  "title": "Example integration enquiry",
  "person_id": 123
}

4. You can check the Lead result's Flowgear.IsSuccess before using its returned ID in later steps.

You can use the same pattern with an Organization and the Lead's organization_id. To associate a new Person with an existing Organization, map the Organization ID into the Person's org_id field.

See also

• Pipedrive OAuth authorization.
• Pipedrive scopes and permissions.