Pipefy

Overview

This node interacts with the Pipefy API to manage phases within a Pipefy pipe. Specifically, the "Get" operation for the "Phase" resource retrieves detailed information about a specific phase by its ID. This includes metadata such as the phase's name, description, card count, completion status, associated fields, and a list of cards in that phase.

Common scenarios where this node is beneficial include:

• Fetching details about a particular phase to display or process in an automation workflow.
• Retrieving the list of cards currently in a phase for reporting or further processing.
• Integrating Pipefy phase data into other systems or dashboards.

Practical example:

• An automation that triggers when a card moves to a certain phase can use this node to get full details about that phase, including its fields and cards, to decide subsequent actions.

Properties

Output

The output JSON object contains detailed information about the requested phase, structured as follows:

• id: The unique identifier of the phase.
• name: The name of the phase.
• description: A textual description of the phase.
• cards_count: The number of cards currently in the phase.
• done: Boolean indicating whether this phase is marked as done.
• fields: An array of field objects associated with the phase, each containing:
  • id: Field identifier.
  • label: The label/name of the field.
  • type: The type of the field (e.g., short_text, date).
  • required: Whether the field is mandatory.
• cards: An object containing up to 100 cards in the phase, each card having:
  • id: Card identifier.
  • title: Title of the card.
  • created_at: Timestamp when the card was created.
• created_at: Timestamp when the phase was created.
• updated_at: Timestamp when the phase was last updated.

No binary data is output by this operation.

Example output snippet:

{
  "id": 123,
  "name": "In Progress",
  "description": "Tasks currently being worked on",
  "cards_count": 5,
  "done": false,
  "fields": [
    {
      "id": 1,
      "label": "Priority",
      "type": "select",
      "required": true
    }
  ],
  "cards": {
    "edges": [
      {
        "node": {
          "id": 456,
          "title": "Task A",
          "created_at": "2023-01-01T12:00:00Z"
        }
      }
    ]
  },
  "created_at": "2022-12-01T10:00:00Z",
  "updated_at": "2023-01-15T08:30:00Z"
}

Dependencies

• Requires an active Pipefy API key credential configured in n8n to authenticate requests.
• Uses the Pipefy GraphQL API endpoint at https://api.pipefy.com/graphql.
• No additional external dependencies are needed.

Troubleshooting

• Invalid Phase ID: If the provided Phase ID does not exist or is incorrect, the API will return an error. Verify the Phase ID is correct and accessible by the authenticated user.
• Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to access phase data.
• API Rate Limits: Pipefy may enforce rate limits; if exceeded, requests might fail temporarily.
• Network Issues: Connectivity problems can cause request failures; check network access to Pipefy API.
• Empty Cards List: If no cards appear under the phase, it may be empty or the user lacks permission to view cards.

Links and References

• Pipefy API Documentation
• Pipefy GraphQL API Reference
• n8n Documentation on Creating Custom Nodes