Pipefy

Overview

This node interacts with the Pipefy API to manage phases within a pipe. Specifically, the "Phase - List" operation retrieves all phases associated with a specified pipe. This is useful for workflows that need to display, analyze, or process the different stages (phases) of a workflow pipeline in Pipefy.

Common scenarios include:

• Automating reporting by listing all phases in a pipe to understand workflow progress.
• Integrating phase data into other systems for synchronization or visualization.
• Dynamically fetching phases to use their IDs or names in subsequent automation steps.

Example: You want to get all phases of a sales pipeline to trigger notifications when cards move between these phases.

Properties

Output

The output is a JSON array where each element represents a phase object with the following structure:

• id: The unique identifier of the phase.
• name: The name of the phase.
• description: A textual description of the phase.
• cards_count: Number of cards currently in this phase.
• done: Boolean indicating if this phase is marked as done.
• fields: An array of fields associated with the phase, each containing:
  • id: Field ID.
  • label: Field label.
  • type: Field type.
• created_at: Timestamp when the phase was created.
• updated_at: Timestamp when the phase was last updated.

This detailed information allows users to understand the structure and status of each phase within the specified pipe.

Dependencies

• Requires an API key credential for authenticating with the Pipefy API.
• The node makes GraphQL POST requests to https://api.pipefy.com/graphql.
• Proper configuration of the API key credential in n8n is necessary.

Troubleshooting

• Missing or invalid Pipe ID: The operation requires a valid Pipe ID. Ensure the Pipe ID is correct and exists in your Pipefy account.
• Authentication errors: If the API key is missing or invalid, requests will fail. Verify the API key credential is correctly set up.
• API rate limits: Pipefy may limit the number of API calls. If you encounter rate limit errors, consider adding delays or retries.
• Empty results: If no phases are returned, verify that the pipe actually contains phases and that the Pipe ID is correct.

Links and References

• Pipefy API Documentation
• GraphQL Queries in Pipefy
• n8n Documentation on Credentials