Pipefy

Overview

This node interacts with the Pipefy API to manage "pipes," which are workflows or pipelines used to organize and track tasks or processes. Specifically, the Get Pipe operation retrieves detailed information about a single pipe by its ID.

Typical use cases include:

• Fetching the configuration and status of a specific pipe in Pipefy.
• Retrieving metadata such as pipe name, description, phases, members, labels, and start form fields.
• Integrating Pipefy pipe data into automated workflows for reporting, monitoring, or further processing.

For example, you might use this node to get all details of a pipe before creating cards or phases within it, or to synchronize pipe data with another system.

Properties

Output

The output JSON contains detailed information about the requested pipe, including:

• id: The pipe's unique identifier.
• name: The name of the pipe.
• description: A textual description of the pipe.
• phases: An array of phases within the pipe, each with:
  • id: Phase ID.
  • name: Phase name.
  • cards_count: Number of cards in the phase.
  • done: Boolean indicating if the phase is marked as done.
  • description: Description of the phase.
• members: Array of members associated with the pipe, each containing:
  • user: User details (id, name, email).
  • role_name: Role of the user in the pipe.
• labels: Array of labels defined in the pipe, each with:
  • id: Label ID.
  • name: Label name.
  • color: Label color code.
• start_form_fields: Array of fields that appear on the pipe's start form, each with:
  • id: Field ID.
  • label: Field label.
  • type: Field type.
  • required: Whether the field is mandatory.
• created_at: Timestamp when the pipe was created.
• updated_at: Timestamp when the pipe was last updated.

This rich structure allows downstream nodes or systems to fully understand the pipe's setup and current state.

Dependencies

• Requires an active connection to the Pipefy API via an API key credential configured in n8n.
• The node sends GraphQL queries to the Pipefy API endpoint at https://api.pipefy.com/graphql.
• Proper permissions on the API key are necessary to read pipe details.

Troubleshooting

• Invalid Pipe ID: If the provided Pipe ID does not exist or is malformed, the API will return an error. Verify the Pipe ID is correct.
• Authentication Errors: Missing or invalid API credentials will cause authentication failures. Ensure the API key credential is properly set up.
• API Rate Limits: Excessive requests may be throttled by Pipefy. Implement retry logic or reduce request frequency.
• Network Issues: Connectivity problems can cause request failures. Check network access to Pipefy API.
• Unexpected Response Structure: Changes in Pipefy API schema could affect the returned data. Review Pipefy API documentation if issues arise.

Links and References

• Pipefy API Documentation
• Pipefy GraphQL API Reference
• n8n Documentation on Creating Custom Nodes