Pipefy icon

Pipefy

Interact with Pipefy GraphQL API

Overview

This node interacts with the Pipefy GraphQL API to retrieve detailed information about a specific pipe within Pipefy. It is useful for workflows that need to fetch metadata or configuration details of pipes, such as their labels, members, phases, and webhooks.

Common scenarios include:

  • Automating reporting or auditing by extracting pipe structure and membership.
  • Integrating Pipefy pipe data into other systems or dashboards.
  • Triggering downstream processes based on pipe configuration or membership changes.

For example, you might use this node to get all phases of a pipe to dynamically build a UI or to check which members have access to a pipe before sending notifications.

Properties

Name Meaning
Authentication Method to authenticate with Pipefy API: either using a Service Account or a Personal Access Token.
Pipe ID The unique identifier of the pipe to retrieve.
Include Labels? Whether to include the labels associated with the pipe in the response (true/false).
Include Members? Whether to include the members of the pipe in the response (true/false).
Include Phases? Whether to include the phases of the pipe in the response (true/false).
Include Webhooks? Whether to include the webhooks configured on the pipe in the response (true/false).

Output

The node outputs a JSON array where each item corresponds to the requested pipe's data. The structure includes:

  • Basic pipe information (such as ID, name, description).
  • Optionally included arrays for:
    • Labels: Metadata tags associated with the pipe.
    • Members: Users who have access or roles within the pipe.
    • Phases: Different stages or steps defined in the pipe.
    • Webhooks: Configured webhooks related to the pipe.

If any of the "Include" options are enabled, the corresponding data will be present in the output JSON under relevant keys.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the Pipefy GraphQL API.
  • Requires authentication via either:
    • A service account credential with appropriate permissions.
    • A personal access token credential.
  • No additional environment variables are needed beyond these credentials.

Troubleshooting

  • Invalid Pipe ID: If the provided Pipe ID does not exist or is malformed, the node may return an error or empty result. Verify the Pipe ID is correct.
  • Authentication Errors: Using incorrect or expired credentials will cause authentication failures. Ensure the API key or token is valid and has sufficient permissions.
  • Permission Denied: Even with valid credentials, insufficient permissions to view certain pipe details (like members or webhooks) can cause partial or failed responses.
  • Network Issues: Connectivity problems to the Pipefy API endpoint will cause request failures. Check network access and API availability.

Links and References

Discussion