Actions11
Overview
This node allows you to manage Pipefy pipes, specifically enabling the addition of members to a pipe. It is useful in scenarios where you want to programmatically control access and collaboration within Pipefy workflows by adding users with specific roles to a pipe. For example, you can automate team setup by adding new members as admins or regular members when a new project pipe is created.
Properties
| Name | Meaning |
|---|---|
| Pipe ID | The unique identifier of the pipe to which you want to add a member. |
| User Email | The email address of the user you want to add as a member to the pipe. |
| Role | The role assigned to the new member; options are "Admin" or "Member". |
Output
The output JSON contains details about the pipe relation after adding the member. This typically includes information confirming the member was added and their role within the pipe. No binary data is output by this operation.
Example output structure (simplified):
{
"pipeRelation": {
"id": "relation-id",
"user": {
"email": "user@example.com"
},
"roleNames": ["admin"]
}
}
Dependencies
- Requires an API key credential for authenticating requests to the Pipefy API.
- Requires another API authentication token credential for general API access.
- The node uses internal utility functions to perform GraphQL requests to Pipefy's API endpoints.
Troubleshooting
- Missing Required Fields: If "Pipe ID" or "User Email" is not provided, the node will throw an error indicating these fields are required.
- Invalid Email or Pipe ID: Providing an incorrect or non-existent pipe ID or user email may result in API errors or failure to add the member.
- Permission Issues: The API credentials used must have sufficient permissions to modify pipe members; otherwise, the operation will fail.
- Role Value: Ensure the role is either "admin" or "member"; other values are not supported and will cause errors.
Links and References
- Pipefy API Documentation
- Pipefy User Roles Explanation (example link for understanding roles)