Pipefy

Overview

This node interacts with the Pipefy API to manage webhooks related to pipes (workflows). Specifically, the Webhook - Create operation allows users to create a new webhook for a specified pipe. The webhook will send event notifications to a user-defined URL when certain actions occur in the pipe, such as card creation, movement, or completion.

Typical use cases include:

• Automating external systems by triggering workflows when cards are created or moved in Pipefy.
• Integrating Pipefy events with other applications via webhook callbacks.
• Monitoring pipe activity in real-time by receiving event data on your server.

For example, you can create a webhook that notifies your CRM system whenever a new card is created in a sales pipeline, enabling automatic lead tracking.

Properties

Output

The output JSON contains details about the newly created webhook:

• id: The unique identifier of the webhook.
• url: The webhook URL provided during creation.
• actions: An array of event types the webhook listens to (fixed to "card.create", "card.move", and "card.done").

Example output JSON structure:

{
  "id": "12345",
  "url": "https://example.com/webhook",
  "actions": ["card.create", "card.move", "card.done"]
}

No binary data is produced by this operation.

Dependencies

• Requires an active Pipefy API key credential configured in n8n to authenticate requests.
• The node sends GraphQL requests to the Pipefy API endpoint at https://api.pipefy.com/graphql.
• The webhook URL must be publicly accessible to receive POST requests from Pipefy.

Troubleshooting

• Common issues:

  • Invalid or missing Pipe ID: Ensure the Pipe ID corresponds to an existing pipe in your Pipefy account.
  • Incorrect webhook URL: The URL must be reachable and accept POST requests; otherwise, webhook delivery will fail.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.

• Error messages:

  • API errors returned from Pipefy will typically include descriptive messages. For example, if the pipe does not exist, the response will indicate so.
  • Network errors may occur if the Pipefy API endpoint is unreachable or if there are connectivity issues.

• Resolution tips:

  • Double-check all input parameters for correctness.
  • Test the webhook URL independently to confirm it accepts incoming POST requests.
  • Review API key permissions and regenerate if necessary.

Links and References

• Pipefy API Documentation
• Pipefy Webhooks Guide
• GraphQL Basics