
Configuring Pipefy as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Pipefy option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
You can authenticate with Pipefy using either a Service Account (recommended) or a Personal Access Token (deprecated). The following configurations are available:- Organization ID: The unique identifier (ID) associated with your Pipefy organization. This can be extracted from the URL at
https://app.pipefy.com/organizations/{YourOrganizationID}). - Authentication mode: The authentication mode to use. Choose between Service Account and Personal Access Token.
- Service Account Credentials: (If Service Account is selected) Create a service account in Pipefy (Members and Permissions > Service Accounts) and provide the credentials here.
- Client ID: The Client ID from the Pipefy service account.
- Client Secret: The Client Secret from the Pipefy service account.
- Personal Access Token: (If Personal Access Token is selected) Personal Access Tokens are deprecated. Use a service account instead for new integrations.
- Auth Token: The Personal Access Token to authenticate against the Pipefy API.
- Page Size: (Default: 50) Number of records per page for paginated GraphQL queries. Lower it (e.g., 25 or 10) if Pipefy returns 408 Request Timeout on heavy pipes.
- Enable card attachments streams: (Default:
false) When enabled, the source adds oneall_cards_{pipeId}_attachmentsstream per pipe that downloads every card’s attachments and uploads them to a Nekt volume. This makes extractions significantly slower and heavier: each attachment is downloaded from Pipefy and re-uploaded to Nekt, and a card’s attachments are re-uploaded whenever the card changes. Only enable this if you need the card files stored in a Nekt volume. - Attachments Volume: Nekt volume to upload card attachments to. Required when card attachments streams are enabled.
2. Select streams
Choose which data streams you want to sync - you can select all streams or pick specific ones that matter most to you. The available streams are dynamically discovered based on the pipes and tables in your organization.Tip: The stream can be found more easily by typing its name.Select the streams and click Next.
3. Configure data streams
Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.- Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
- Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
- Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
- Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
- Incremental: every time the extraction happens, we’ll get only the new data - which is good if, for example, you want to keep every record ever fetched.
- Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.
4. Configure data source
Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:- Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
- Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
5. Check your new source
You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.Streams and Fields
Below you’ll find all available data streams from Pipefy and their corresponding fields:All Cards
All Cards
Stream for fetching cards information within a specific pipe. A stream is created for each pipe in your organization (e.g.,
all_cards_PIPE_ID).Key Fields:| Field | Type | Description |
|---|---|---|
id | String | Unique identifier for the card |
title | String | Title of the card |
created_at | DateTime | When the card was created |
updated_at | DateTime | When the card was last updated |
finished_at | DateTime | When the card was finished |
done | Boolean | Whether the card is completed |
age | Integer | Age of the card in days |
assignees | Array | Users assigned to the card |
created_by | Object | User who created the card |
comments | Array | Comments added to the card |
comments_count | Integer | Total number of comments on the card |
current_phase | Object | The current phase of the card |
current_phase_age | Integer | Time elapsed in the current phase |
due_date | DateTime | Due date defined for the card |
expired | Boolean | Indicates whether the due date has expired |
fields | Array | Field values associated with the card |
phases_history | Array | History of phase transitions for the card |
child_relations | Array | Child cards related to this card |
parent_relations | Array | Parent cards related to this card |
labels | Array | Labels on the card |
late | Boolean | Whether the card is late |
overdue | Boolean | Whether the card is overdue |
started_current_phase_at | DateTime | When the card started its current phase |
url | String | URL of the card |
uuid | String | UUID of the card |
All Cards Attachments
All Cards Attachments
Stream for fetching card attachments and uploading them to a Nekt volume. A stream is created for each pipe (e.g.,
all_cards_PIPE_ID_attachments).Key Fields:| Field | Type | Description |
|---|---|---|
card_id | String | The ID of the card this attachment belongs to |
card_updated_at | DateTime | Timestamp when the card was last updated |
path | String | The path/URL of the attachment in Pipefy |
created_at | DateTime | Timestamp when the attachment was created |
file_name | String | File name derived from the attachment path |
file_size | Integer | Size of the uploaded file in bytes |
mime_type | String | MIME type of the uploaded file |
_nekt_file_id | String | ID of the file created in the Nekt volume |
_nekt_uploaded_at | DateTime | Timestamp when the file was uploaded to Nekt |
Phases
Phases
Stream for managing the phases of your pipes.Key Fields:
| Field | Type | Description |
|---|---|---|
pipe_id | String | ID of the pipe this phase belongs to |
id | String | Unique identifier for the phase |
name | String | Name of the phase |
description | String | Description of the phase |
created_at | DateTime | When the phase was created |
Phase Fields
Phase Fields
Stream for managing the fields within each phase of your pipes.Key Fields:
| Field | Type | Description |
|---|---|---|
phase_id | String | ID of the phase this field belongs to |
id | String | Unique identifier for the field |
label | String | Label of the field |
description | String | Description of the field |
is_multiple | Boolean | Whether the field can have multiple values |
options | Array | Options for the field (if applicable) |
required | Boolean | Whether the field is required |
settings | Object | Field-specific settings |
type | String | Type of the field |
Members
Members
Stream containing members of your Pipefy organization.Key Fields:
| Field | Type | Description |
|---|---|---|
id | String | Unique identifier for the member user |
name | String | Member user name |
email | String | Member user email |
username | String | Member username |
uuid | String | Member UUID |
avatarUrl | String | Avatar URL |
confirmed | Boolean | Whether the user account is confirmed |
createdAt | DateTime | When the user account was created |
invited | Boolean | Whether the member is invited |
locale | String | Member locale |
phone | String | Member phone number |
timezone | String | Member timezone |
Tables
Tables
Stream containing information about the tables in your organization.Key Fields:
| Field | Type | Description |
|---|---|---|
id | String | Unique identifier for the table |
name | String | Name of the table |
internal_id | String | Internal ID of the table |
description | String | Description of the table |
public | Boolean | Whether the table is public |
table_records_count | Integer | Number of records in the table |
users_count | Integer | Number of users with access to the table |
type | String | Type of the table |
statuses | Array | Statuses defined for the table |
labels | Array | Labels defined for the table |
members | Array | Members with access to the table |
table_fields | Array | Fields in the table |
Table Records
Table Records
Stream for managing records within a specific table. A stream is created for each table in your organization (e.g.,
table_records_TABLE_ID).Key Fields:| Field | Type | Description |
|---|---|---|
id | String | Unique identifier for the record |
title | String | Title of the record |
created_at | DateTime | When the record was created |
updated_at | DateTime | When the record was last updated |
created_by | Object | User who created the record |
table | Object | The table this record belongs to |
record_fields | Array | Fields in the record |
Implementation Notes
Dynamic Stream Discovery
- The Pipefy connector dynamically discovers streams based on the pipes and tables available in your organization.
- The connector is designed to be resilient to changes in your Pipefy environment. If a new Pipe or Table is added after your initial setup, the connector will safely handle the discovery of these new streams during subsequent syncs without failing on stale catalog references.
Skills for agents
Download Pipefy skills file
Pipefy connector documentation as plain markdown, for use in AI agent contexts.