Pipefy

Overview

This node interacts with the Pipefy API to manage tables within an organization. Specifically, the "Table" resource with the "Get" operation retrieves detailed information about a specific table by its ID. This includes the table's name, description, and its fields with their properties.

Common scenarios for this node include:

• Fetching metadata about a table to understand its structure before creating or updating records.
• Integrating Pipefy tables into workflows where table details are needed dynamically.
• Auditing or reporting on table configurations in Pipefy.

Practical example:

• A workflow that triggers when a new record is created elsewhere, then uses this node to get the target table's schema to validate or map data accordingly.

Properties

Output

The output JSON object contains the following structure representing the table details:

{
  "id": "string",               // The unique ID of the table
  "name": "string",             // The name of the table
  "description": "string",      // Description of the table (may be empty)
  "fields": [                   // Array of field objects defined in the table
    {
      "label": "string",       // The label/name of the field
      "type": "string",        // The type of the field (e.g., short_text, number, date, etc.)
      "required": true|false,  // Whether the field is required
      "help": "string",        // Help text associated with the field
      "description": "string"  // Additional description of the field
    }
  ]
}

This output provides comprehensive metadata about the table and its fields, useful for downstream processing or UI display.

Dependencies

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

Troubleshooting

• Invalid Table ID: If the provided Table ID does not exist or is incorrect, the API will return an error. Verify the Table ID is correct and accessible.
• Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
• Network Issues: Connectivity problems to the Pipefy API endpoint can cause failures; check network access.
• API Rate Limits: Excessive requests may lead to rate limiting; consider adding delays or retries.

If errors occur, enabling "Continue On Fail" in the node settings allows the workflow to proceed while capturing error messages in the output.

Links and References

• Pipefy API Documentation
• GraphQL Basics
• n8n Documentation - Creating Custom Nodes