Pipefy icon

Pipefy

Interact with Pipefy API

Actions32

Overview

The node interacts with the Pipefy API to manage "pipes," which are workflows or pipelines used to organize and automate processes. Specifically, the Update Pipe operation allows users to modify an existing pipe's details such as its name and description.

This operation is useful when you need to rename a pipe or update its description to reflect changes in your workflow or project without recreating it. For example, if a pipe initially created for "Sales Leads" needs to be updated to "Qualified Sales Leads" with a more detailed description, this operation facilitates that update seamlessly.

Properties

Name Meaning
Pipe ID The unique identifier of the pipe to update.
Name The new name to assign to the pipe.
Description (Optional) A new description for the pipe to provide additional context or details.
Start Form Fields (Not used in update operation here, but generally defines the fields shown at pipe start.)

Output

The output JSON contains the updated pipe object with the following structure:

  • id: The unique identifier of the pipe.
  • name: The updated name of the pipe.
  • description: The updated description of the pipe.
  • updated_at: Timestamp indicating when the pipe was last updated.

Example output JSON snippet:

{
  "id": 123,
  "name": "Updated Pipe Name",
  "description": "Updated description text",
  "updated_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.
  • Proper permissions on the Pipefy account to update pipes are necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Pipe ID: Ensure the Pipe ID provided exists and is correct.
    • Insufficient permissions: The API key must have rights to update pipes.
    • Network or API errors: Check connectivity and Pipefy service status.

  • Error messages:

    • "Field 'id' is required": Occurs if Pipe ID is not provided; ensure this field is set.
    • "Unauthorized" or "Forbidden": Indicates API key lacks permission; verify credentials.
    • "Pipe not found": The specified Pipe ID does not exist; confirm the ID.

  • Resolution tips:

    • Double-check all required parameters.
    • Verify API credentials and their scopes.
    • Review Pipefy API documentation for any recent changes.

Links and References

Discussion