Pipefy

Overview

This node interacts with the Pipefy API to manage "cards" within Pipefy workflows. Specifically, the Card - Get operation retrieves detailed information about a card by its ID. This is useful when you want to fetch the current state or details of a specific card in your Pipefy process.

Common scenarios include:

• Retrieving card details to display or use in subsequent workflow steps.
• Monitoring the status or metadata of a card for reporting or automation.
• Integrating Pipefy card data into other systems or dashboards.

Example: You have a card representing a customer support ticket in Pipefy, and you want to get its title, current phase, and timestamps to update a CRM system or trigger notifications.

Properties

Output

The output JSON object contains the following fields describing the card:

• id: The unique identifier of the card.
• title: The title of the card.
• current_phase: An object containing the current phase of the card, including:
  • name: The name of the phase where the card currently resides.
• created_at: Timestamp when the card was created.
• updated_at: Timestamp when the card was last updated.

Example output JSON:

{
  "id": 12345,
  "title": "Sample Card Title",
  "current_phase": {
    "name": "In Progress"
  },
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-02T15:30:00Z"
}

The node does not output binary data for this operation.

Dependencies

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

Troubleshooting

• Invalid Card ID: If the provided Card ID does not exist or is malformed, the API will return an error. Verify that the Card ID is correct and accessible with your API credentials.
• Authentication Errors: Ensure the API key credential is valid and has permission to access the card resource.
• Network Issues: Connectivity problems may cause request failures. Check network access to the Pipefy API endpoint.
• API Rate Limits: Excessive requests might be throttled by Pipefy. Implement retry logic or reduce request frequency if needed.
• Error Messages: The node returns error messages from the API in the output JSON under an error field if continueOnFail is enabled. Review these messages for troubleshooting.

Links and References

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