Pipefy icon

Pipefy

Interact with Pipefy API

Actions32

Overview

This node integrates with the Pipefy API to manage "pipes," which are customizable workflows or pipelines used to organize and automate business processes. Specifically, the Pipe - Create operation allows users to create a new pipe within a specified organization.

Typical use cases include:

  • Automating the creation of new workflow pipelines in Pipefy as part of onboarding or project setup.
  • Dynamically generating pipes based on external triggers or data inputs.
  • Integrating Pipefy pipe creation into larger automation workflows for process management.

For example, a user could set up an automation that creates a new pipe for each new client added to their CRM system, associating it with the client's organization ID.

Properties

Name Meaning
Name The name of the pipe to be created.
Organization ID The ID of the organization under which the pipe will be created.
Description (Optional) A description for the pipe.
Start Form Fields (Optional) Defines the fields that appear on the start form of the pipe. Each field includes: Label, Type (e.g., Assignee, Attachment, Checklist, CNPJ, Connection, Currency, Date, DateTime, Due Date, Email, ID, Label, Long Text, Number, Phone, Radio, Select, Short Text, Statement, Time), Required flag, Help Text, and Description.

Output

The output JSON contains the details of the newly created pipe, including at least:

  • id: The unique identifier of the created pipe.
  • name: The name of the pipe.
  • created_at: Timestamp when the pipe was created.

Example output JSON structure:

{
  "id": "12345",
  "name": "New Pipe Name",
  "created_at": "2024-01-01T12:00:00Z"
}

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.
  • The user must provide a valid Organization ID where the pipe will be created.

Troubleshooting

  • Invalid Organization ID: If the provided organization ID is incorrect or does not exist, the API will return an error. Verify the organization ID before running the node.
  • Missing Required Fields: The "Name" and "Organization ID" properties are required. Omitting these will cause the request to fail.
  • API Authentication Errors: Ensure the API key credential is correctly configured and has sufficient permissions to create pipes.
  • GraphQL Syntax Errors: The mutation query is constructed dynamically; ensure that input values do not contain characters that break the query syntax (e.g., unescaped quotes).
  • Network Issues: Connectivity problems to the Pipefy API endpoint will result in request failures.

Links and References

This summary focuses exclusively on the "Pipe" resource with the "Create" operation as requested.

Discussion