Pipefy

Overview

This node interacts with the Pipefy API to manage users within an organization. Specifically, the "Remove" operation under the "User" resource allows you to remove a user from a specified organization by their email address. This is useful in scenarios where you need to revoke access or membership of a user from your Pipefy organization.

Practical examples:

• Automatically removing a user who no longer requires access after offboarding.
• Cleaning up organization members based on external triggers or workflows.
• Managing user memberships dynamically as part of organizational changes.

Properties

Output

The output JSON contains a success field indicating whether the removal operation was successful.

Example output structure:

{
  "success": true
}

This confirms that the user has been successfully removed from the organization.

Dependencies

• Requires an API key credential for authenticating requests to the Pipefy API.
• The node sends GraphQL mutations to the Pipefy API endpoint at https://api.pipefy.com/graphql.
• Proper permissions are needed on the API key to manage organization members.

Troubleshooting

• Common issues:

  • Invalid or missing Organization ID or Email parameters will cause the mutation to fail.
  • Insufficient permissions on the API key may result in authorization errors.
  • If the user email does not exist in the organization, the operation might succeed but have no effect or return an error depending on API behavior.

• Error messages:

  • Errors returned from the API typically include messages about invalid input or permission denied.
  • To resolve, verify that the Organization ID and Email are correct and that the API key has the necessary rights.

Links and References

• Pipefy API Documentation
• GraphQL API Reference