Skip to main content
Pipefy is a workflow management and process automation platform that helps organizations streamline their business processes. It provides tools for creating custom workflows, managing tasks, and automating repetitive processes to improve efficiency and productivity.

​
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’ll need your Pipefy Personal Access Token (PAT) for this connection. You can generate one in your Pipefy user settings. Once you have it, add the account access and your Organization ID, then click Next.
  • Access Token: Your personal access token for the Pipefy API.
  • Organization ID: The ID is a number that identifies your Pipefy organization. This can be extracted from the URL at https://app.pipefy.com/organizations/{YourOrganizationID}).

​
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 a name for each table (which will contain the fetched data) and the type of sync.
  • Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix 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.
Once you are done configuring, click Next.

​
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 determine when to execute a full sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while. Once you are ready, click Next to finalize the setup.

​
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.
For you to be able to see it on your Catalog, you need at least one successful source run.

​
Streams and Fields

Below you’ll find all available data streams from Pipefy and their corresponding fields:
Stream for fetchings cards information within a specific pipe. A stream is created for each pipe in your organization (e.g., all_cards_PIPE_ID).Key Fields:
  • id: Unique identifier for the card
  • title: Title of the card
  • created_at: When the card was created
  • updated_at: When the card was last updated
  • finished_at: When the card was finished
  • done: Whether the card is completed
  • age: Age of the card in seconds
  • assignees: Users assigned to the card
  • created_by: User who created the card
  • comments: Comments on the card
  • comments_count: Number of comments on the card
  • current_phase: The current phase of the card
  • current_phase_age: Age in the current phase in seconds
  • due_date: Due date for the card
  • expired: Whether the card is expired
  • fields: Custom fields on the card
  • phases_history: History of phases the card has been through
  • child_relations: Child cards related to this card
  • parent_relations: Parent cards related to this card
  • labels: Labels on the card
  • late: Whether the card is late
  • overdue: Whether the card is overdue
  • started_current_phase_at: When the card started its current phase
  • url: URL of the card
  • uuid: UUID of the card
Stream for managing the phases of your pipes.Key Fields:
  • pipe_id: ID of the pipe this phase belongs to
  • id: Unique identifier for the phase
  • name: Name of the phase
  • description: Description of the phase
  • created_at: When the phase was created
Stream for managing the fields within each phase of your pipes.Key Fields:
  • phase_id: ID of the phase this field belongs to
  • id: Unique identifier for the field
  • label: Label of the field
  • description: Description of the field
  • is_multiple: Whether the field can have multiple values
  • options: Options for the field (if applicable)
  • required: Whether the field is required
  • settings: Field-specific settings
  • type: Type of the field
Stream containing information about the tables in your organization.Key Fields:
  • id: Unique identifier for the table
  • name: Name of the table
  • internal_id: Internal ID of the table
  • description: Description of the table
  • public: Whether the table is public
  • table_records_count: Number of records in the table
  • users_count: Number of users with access to the table
  • type: Type of the table
  • statuses: Statuses defined for the table
  • labels: Labels defined for the table
  • members: Members with access to the table
  • table_fields: Fields in the table
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:
  • id: Unique identifier for the record
  • title: Title of the record
  • created_at: When the record was created
  • updated_at: When the record was last updated
  • created_by: User who created the record
  • table: The table this record belongs to
  • record_fields: Fields in the record
⌘I