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 operation allows you to create a new phase within a specified pipe in Pipefy. A phase represents a stage or step in a workflow pipeline where cards (tasks/items) can be organized and managed. Creating phases is essential for structuring processes, tracking progress, and defining workflow stages.

Common scenarios include:

Setting up a new workflow pipeline by defining its phases.
Adding additional phases to an existing pipe to reflect changes in the process.
Automating the creation of phases as part of a larger workflow setup.

For example, you might create a "Review" phase in a sales pipeline to track deals currently under review, or a "QA Testing" phase in a software development pipeline.

Properties

Name	Meaning
Pipe ID	The ID of the pipe in which the new phase will be created.
Name	The name of the phase to create.
Description	An optional description providing more details about the phase.
Can Receive Card	Whether cards can be moved into this phase (boolean).
Can Create Card	Whether cards can be created directly in this phase (boolean).
Done	Whether this phase is considered a "done" phase, indicating completion (boolean).
Fields	Custom fields to add to the phase. Each field includes:
	- Label: The display label of the 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.
	- Required: Whether the field is mandatory.
	- Help Text: Additional help text for the field.
	- Description: Description of the field.
	- Options: For select and radio types, a list of options with names.

Output

The output JSON object contains the newly created phase's details:

id: The unique identifier of the created phase.
name: The name of the phase.
description: The description of the phase.
created_at: Timestamp when the phase was created.

Example output JSON:

{
  "id": "12345",
  "name": "Review",
  "description": "Phase for reviewing items",
  "created_at": "2024-06-01T12:00:00Z"
}

No binary data is output by this operation.

Dependencies

Requires an active connection to the Pipefy API via an API key credential configured in n8n.
The node sends GraphQL requests to https://api.pipefy.com/graphql.
Proper permissions on the Pipefy account to create phases in the specified pipe are necessary.

Troubleshooting

Invalid Pipe ID: If the provided Pipe ID does not exist or is incorrect, the API will return an error. Verify the Pipe ID is correct.
Missing Required Fields: The "Name" and "Pipe ID" properties are required. Omitting them will cause errors.
Permission Denied: Ensure the API key has sufficient permissions to create phases in the target pipe.
API Rate Limits: Excessive requests may trigger rate limiting; implement retries or delays if needed.
Field Validation Errors: When specifying custom fields, ensure all required attributes are correctly set and options for select/radio types are properly formatted.