Pipefy

Interact with Pipefy API

Actions32

Card Actions
Organization Actions
Pipe Actions
Phase Actions
Table Actions
Table Record Actions
User Actions
Webhook Actions
- Create
- Delete

Overview

This node interacts with the Pipefy API to create a new card within a specified pipe and phase. It allows users to define the card's title and set various custom fields on the card, including complex field types like checklists, labels, and attachments.

Common scenarios where this node is beneficial include automating task or issue creation in project management workflows, dynamically adding cards based on external triggers, or integrating Pipefy with other systems to streamline process management.

For example, you could use this node to automatically create a new support ticket card in a specific phase of your customer service pipe whenever a new email arrives, populating relevant fields such as assignee, due date, and attachments.

Properties

Name	Meaning
Pipe ID	The ID of the pipe where the card will be created.
Phase ID	The ID of the phase within the pipe where the card will be created.
Title	The title of the card.
Fields	The fields to set on the card. This supports multiple entries, each with:
	- Field ID: The identifier of the field to set.
	- Field Type: The type of the field. Options include Assignee, Attachment, Checklist, Cnpj, Connection, Currency, Date, DateTime, Due Date, Email, ID, Label, Long Text, Number, Phone, Radio, Select, Short Text, Statement, Time.
	- Value: The value to assign to the field (for most types).
	- Array Values: For checklist or label fields, comma-separated values to set.
	- Attachments: For attachment fields, one or more attachments can be specified, each with a URL and filename.

Output

The node outputs JSON data representing the newly created card. The output includes:

id: The unique identifier of the created card.
title: The title of the card.
current_phase: An object containing the name of the phase where the card currently resides.
fields: An array of fields on the card, each with:
- name: The field's name.
- value: The field's value.
- array_value: For checklist or label fields, the array of values.
- field: An object with the field's id and type.
created_at: Timestamp when the card was created.
updated_at: Timestamp when the card was last updated.

If attachments are included in the fields, they are sent as URLs and filenames but the node does not output binary data directly.

Dependencies

Requires an active connection to the Pipefy API via an API key credential configured in n8n.
The node uses GraphQL queries/mutations to interact with the Pipefy API endpoint at https://api.pipefy.com/graphql.
Proper permissions on the Pipefy account to create cards in the specified pipe and phase.

Troubleshooting

Invalid Pipe or Phase ID: If the provided Pipe ID or Phase ID is incorrect or the user lacks access, the API will return errors. Verify IDs and permissions.
Field ID or Type Mismatch: Providing invalid field IDs or mismatched field types may cause the mutation to fail. Ensure field IDs correspond to the pipe's schema and types match expected values.
Attachment Errors: Attachments require valid URLs and filenames. Invalid URLs or missing filenames will cause errors.
API Rate Limits or Authentication Failures: Ensure the API key credential is valid and has sufficient quota.
Error Messages: The node returns error messages from the API in the output JSON under an error property if "Continue On Fail" is enabled. Otherwise, execution stops on error.

To resolve issues, double-check all input parameters, ensure correct API credentials, and consult Pipefy API documentation for field and pipe configurations.