Pipeline CRM v2

Provides integration with Pipeline CRM records, searches, administration and supported CSV exports through its REST API. Use operation templates to select the route, filters and request body for your Workflow.

Revision History

0.0.0.4 - Provides template-driven reads, searches and mutations with automatic paging.

Connection

Property Type Description
ApiToken Masked User-created API token from Profile > API tokens. An application key is not required.
TimeoutSeconds Integer Positive per-request timeout in seconds. Defaults to 30.

Setup Notes

  1. Have an administrator grant API access and token-management permission.
  2. Create a token for the integration user and enter it in ApiToken. Read-only tokens cannot perform mutations.
  3. Test the Connection with the read-only profile check.
  4. Run on a Cloud Cluster and select an operation template.

Methods

Select a Method and its template to populate the operation and its supported fields.

Query

Reads records, performs supported POST searches or returns a CSV export.

Parameter Type Description
Connection Connection Pipeline CRM Connection profile.
OperationId String Operation identifier populated by the selected template.
Options Object Route and query values required by the selected operation.
Request Object Single search body for a POST search. GET operations reject a supplied body.
Return Type Description
Response Array Provider records; search matrices use JSON text in Value and Columns. CSV exports return their text in Value.

Create

Creates records using the selected POST operation.

Parameter Type Description
Connection Connection Pipeline CRM Connection profile.
OperationId String Operation identifier populated by the selected template.
Options Object Route and query values required by the selected operation.
Items Array Complete request bodies, one item per provider request.
Return Type Description
Response Array Provider results with Flowgear.IsSuccess, Flowgear.Message, and the original request under Flowgear.Request.

Update

Updates records using the selected PUT or PATCH operation.

Parameter Type Description
Connection Connection Pipeline CRM Connection profile.
OperationId String Operation identifier populated by the selected template.
Options Object Route and query values required by the selected operation.
Items Array Complete request bodies, one item per provider request.
Return Type Description
Response Array Provider results with Flowgear.IsSuccess, Flowgear.Message, and the original request under Flowgear.Request.

Delete

Deletes one record selected by its explicit route. This Method has no Items input.

Parameter Type Description
Connection Connection Pipeline CRM Connection profile.
OperationId String Operation identifier populated by the selected template.
Options Object Route and query values required by the selected operation.
Return Type Description
Response Array Deletion result with normalized Flowgear mutation metadata.

Usage Notes

  • Query removes list envelopes and emits individual provider records without mutation metadata. Empty results return zero rows. Paging is automatic; caller page and per_page controls are rejected. CSV exports and bare arrays are unpaged.
  • POST searches use the same Request on subsequent pages. Returned search rows are positional arrays encoded as JSON text in Value; Columns describes their columns.
  • Activity listing requires at least one of the template's deal_id, company_id or person_id filters. Structured conditions retain provider field names; dictionary filters use JSON object text.
  • Create and Update send one request per input item. A disconnected Items input executes a bodyless operation once; an empty connected stream does no work. An operation requiring a body requires Items. Route Options apply to the whole invocation.
  • The first request executes during invocation. Later handled record-validation errors become failed rows; authentication, permission, malformed-response, server and transport failures stop execution. HTTP 429 permits bounded recovery, but ambiguous writes are not replayed.
  • Known string and integer lists use CSV where the template specifies it. Quote values containing commas, quotes or newlines, and double embedded quotes. Empty text represents an empty list; "" represents one empty string. Integer lists do not accept added whitespace or fractions. Structured object arrays retain their child fields.
  • Expired or revoked tokens must be replaced; there is no token refresh flow.

Known Issues

  • This connector is Early Access.