Pipefy

Overview

This node interacts with the Pipefy API to manage webhooks among other resources. Specifically, for the Webhook - Delete operation, it deletes an existing webhook by its ID. This is useful when you want to stop receiving events from a previously created webhook, for example, if the webhook URL is no longer valid or you want to clean up unused webhooks.

Practical scenarios include:

• Removing obsolete or test webhooks to avoid unnecessary event traffic.
• Managing webhook lifecycle programmatically as part of automation workflows.
• Ensuring security by deleting webhooks that should no longer be active.

Properties

Output

The output JSON contains the result of the deletion mutation. It includes a success field indicating whether the deletion was successful.

Example output JSON structure:

{
  "success": true
}

No binary data is involved in this operation.

Dependencies

• Requires an API key credential for authenticating with the Pipefy API.
• The node sends GraphQL requests to the Pipefy API endpoint at https://api.pipefy.com/graphql.
• Proper network access to Pipefy's API is necessary.

Troubleshooting

• Common issues:

  • Invalid or missing Webhook ID: The deletion will fail if the provided webhook ID does not exist or is incorrect.
  • Authentication errors: If the API key credential is invalid or missing, requests will be rejected.
  • Network connectivity problems can prevent communication with the Pipefy API.

• Error messages and resolutions:

  • "Unauthorized" or similar authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • "Webhook not found" or similar: Confirm the webhook ID is correct and that the webhook exists.
  • Timeout or network errors: Check internet connectivity and firewall settings.

Links and References

• Pipefy API Documentation
• Pipefy Webhooks Guide (example link, replace with actual if available)
• GraphQL Basics