1. Add your Pipefy access
- In the Destinations tab, click on the “Add destination” 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:
- Access Token: Your Pipefy authentication token. You can use either a Personal Access Token (PAT) or a Service Account token.
- Endpoint: The operation to perform. See the details for each endpoint below:
CreateCardcreates new cards in the pipe.UpdateCardupdates existing cards (metadata and custom fields).BatchUpdateCardFieldperforms bulk updates on custom fields across many cards in a single request. Recommended for high-volume scenarios (e.g. updating a lead score on 100k+ cards).
- Pipe ID: The ID of the Pipefy pipe where cards will be created or updated. You can find this in the pipe URL (e.g.
https://app.pipefy.com/pipes/305737084means the Pipe ID is305737084). - Batch Size (advanced, BatchUpdateCardField only): The number of field updates to include in each API request. Default is
100. Higher values reduce the total number of requests but increase payload size. - Enable partial success: Whether the connector should continue trying to sync records after one fails. Recommended for large batch operations.
To generate a Personal Access Token, go to your Pipefy account settings, navigate to Personal access tokens, and create a new token. For production integrations, Pipefy recommends using Service Accounts instead. - Click Next.
2. Select your data to send
- The next step is letting us know which data you want to send. Select the layer and then the desired table.
- Click Next.
3. Map your data fields
Configure how the fields from your source table should be mapped to the fields in the selected endpoint. Below you can find the supported fields for each endpoint.Understanding Pipefy field types
Pipefy cards have two categories of fields:- Card-level fields: Built-in fields like
title,due_date,assignee_ids,label_ids, andphase_id. These are common to all pipes. - Custom fields: Fields defined in the pipe’s configuration (e.g. “Nome completo”, “CPF”, “Renda mensal”). Each custom field has an internal field ID (e.g.
nome_completo,valor_do_cr_dito) that you must use as the destination field name in the mapping.
To find a custom field’s internal ID, go to the pipe settings in Pipefy and check the field configuration. The ID is displayed under the field name. Alternatively, you can use the Pipefy GraphQL API to query the pipe’s
start_form_fields or phase fields.CreateCard
CreateCard
Creates a new card in the specified pipe. Card-level fields are set directly on the card, and custom fields are set via the
fields_attributes parameter in a single API call.Card-level fieldsCustom fieldsAny destination field name that is not a card-level field is treated as a custom field ID. For example, if your pipe has a field called “Nome completo” with internal ID
nome_completo, map your source column to destination field nome_completo.Connector fields (fields that link to cards in another pipe) require special formatting. The value must reference valid connected card IDs or labels as expected by the Pipefy API. Check the connected pipe for valid values.
UpdateCard
UpdateCard
Updates an existing card. Card-level fields (title, due date, assignees, labels) are updated in a single API request via the
updateCard mutation. Custom fields are updated individually via the updateCardField mutation (one API call per field).Card-level fieldsCustom fieldsAny destination field name that is not a card-level field (and not
id) is treated as a custom field ID and updated via the updateCardField mutation.Since each custom field requires a separate API call, updating many fields on many cards can be slow. If you only need to update a single field across many cards, consider using
BatchUpdateCardField instead.BatchUpdateCardField
BatchUpdateCardField
Performs bulk updates on a single custom field across many cards. Instead of sending one API call per card, this endpoint batches multiple
updateCardField mutations into a single GraphQL request using aliases.This is the recommended endpoint for high-volume operations like updating a lead score, status, or any computed field across thousands of cards.Performance comparisonRequired fields
Source table formatYour source table should have one row per field update. For example, to update the
lead_score field on three cards:To update multiple fields per card, include one row per card-field combination:
Common Pipefy field types and value formats
When mapping values to Pipefy custom fields, use the format that Pipefy expects for each field type:4. Configure your Pipefy data destination
- Describe your destination for easy identification within your organization. You can inform things like what data it brings, to which team it belongs, etc.
- To define your Trigger, consider how frequently you need to have the data updated on the destination (every day, once a week, only at specific times, etc.).
- Click Done.
Check your new destination!
- Once completed, you’ll receive confirmation that your new destination is set up!
- You can view your new destination on the Destinations page. Now, for you to be able to see it on Pipefy, you have to wait for the pipeline to run. You can monitor it on the Destinations page to see its execution and completion. If needed, manually trigger the pipeline by clicking on the refresh icon. Once executed, your data should be seen on Pipefy.
If you encounter any issues, reach out to us via Slack, and we’ll gladly assist you!