Pipefy icon

Pipefy

Interact with Pipefy API

Actions32

Overview

The node interacts with the Pipefy API to update an existing phase within a Pipefy pipe. It allows you to modify the phase's name, description, and various settings such as whether cards can be created or moved into this phase, if it is marked as done, and the custom fields associated with the phase.

This operation is useful when managing workflows in Pipefy where phases represent stages in a process. For example, you might want to rename a phase to better reflect its purpose, add or update custom fields that capture specific data at that stage, or change permissions on card creation and movement to control workflow behavior.

Practical examples:

  • Renaming a phase from "In Progress" to "Under Review".
  • Adding a new required date field to a phase to track deadlines.
  • Marking a phase as done to indicate completion of that stage.
  • Disabling card creation in a phase to enforce process rules.

Properties

Name Meaning
Phase ID The unique identifier of the phase to update.
Name The new name for the phase.
Description A textual description of the phase.
Can Receive Card Boolean flag indicating whether cards can be moved into this phase.
Can Create Card Boolean flag indicating whether new cards can be created directly in this phase.
Done Boolean flag indicating whether this phase is considered a "done" or completed phase.
Fields A collection of custom fields to define or update for the phase. Each field includes:
- Label: The display label of the field.
- Type: The type of the field (e.g., Assignee, Attachment, Checklist, Date, Email, Number, Select, Short Text, etc.).
- Required: Whether the field is mandatory.
- Help Text: Additional help text for the field.
- Description: A description of the field.
- Options: For select and radio types, a list of options each with a name.

Output

The output JSON contains the updated phase object with the following structure:

  • id: The unique identifier of the phase.
  • name: The updated name of the phase.
  • description: The updated description.
  • updated_at: Timestamp of when the phase was last updated.

Example output snippet:

{
  "id": "123",
  "name": "New Phase Name",
  "description": "Updated description",
  "updated_at": "2024-01-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 are necessary to update phases.

Troubleshooting

  • Common issues:

    • Invalid or missing Phase ID will cause the update to fail.
    • Insufficient permissions on the Pipefy API key may result in authorization errors.
    • Providing invalid field definitions (e.g., missing required labels or unsupported field types) may cause the mutation to fail.
    • Network connectivity issues can prevent successful API calls.

  • Error messages:

    • "Field 'id' is required": Ensure the Phase ID is provided.
    • "Unauthorized" or "Forbidden": Check API key permissions and validity.
    • "Invalid input": Verify all required properties and field configurations are correct.

  • Resolution tips:

    • Double-check the Phase ID and other required parameters.
    • Confirm the API key has the necessary scopes.
    • Validate the format and completeness of custom fields.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully during batch operations.

Links and References

Discussion