Pipefy icon

Pipefy

Interact with Pipefy API

Actions32

Overview

This node interacts with the Pipefy API to manage tables within an organization. Specifically, the "Table" resource with the "Create" operation allows users to create a new table in a specified organization. This is useful for automating the setup of structured data containers (tables) that can hold various fields and records, enabling streamlined data management workflows.

Practical examples include:

  • Automatically creating project tracking tables when a new project is initiated.
  • Setting up custom data tables for client information or inventory management as part of a larger automation.
  • Defining tables with specific fields tailored to business needs without manual intervention.

Properties

Name Meaning
Organization ID The ID of the organization where the table will be created.
Name The name of the table to be created.
Description An optional description providing more details about the table.
Fields A collection of fields to define the structure of the table. Each field includes:
- Label: The display name 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 this field must be filled out.
- Help Text: Additional help text for the field.
- Description: A description explaining the purpose of the field.

Output

The output JSON contains the newly created table's details, including:

  • id: The unique identifier of the created table.
  • name: The name of the table.
  • description: The description of the table.
  • fields: An array of the fields defined on the table, each with:
    • label: The label of the field.
    • type: The type of the field.
    • required: Whether the field is required.
    • help: Help text associated with the field.
    • description: Description of the field.

No binary data output is involved in this operation.

Example output snippet:

{
  "id": "12345",
  "name": "Project Tasks",
  "description": "Table for managing project tasks",
  "fields": [
    {
      "label": "Task Name",
      "type": "short_text",
      "required": true,
      "help": "Enter the task name",
      "description": "The name of the task"
    },
    {
      "label": "Due Date",
      "type": "due_date",
      "required": false,
      "help": "",
      "description": ""
    }
  ]
}

Dependencies

  • Requires an active connection to the Pipefy API via an API key credential configured in n8n.
  • The node sends GraphQL requests to the Pipefy API endpoint (https://api.pipefy.com/graphql).
  • Proper permissions are needed on the API key to create tables within the specified organization.

Troubleshooting

  • Common issues:

    • Invalid or missing Organization ID: Ensure the organization ID is correct and accessible by the API key.
    • Field definitions malformed: The fields property must be properly structured; invalid field types or missing required properties may cause errors.
    • API authentication errors: Verify that the API key credential is valid and has sufficient permissions.

  • Error messages:

    • Errors returned from the Pipefy API typically include descriptive messages indicating what went wrong (e.g., "Organization not found", "Field type invalid").
    • Network or connectivity errors may occur if the API endpoint is unreachable.

  • Resolutions:

    • Double-check all input parameters for correctness.
    • Confirm API credentials and permissions.
    • Review the Pipefy API documentation for field type constraints and required parameters.

Links and References

Discussion