Actions13
Overview
The Pickaxe node allows users to interact with the Pickaxe API, specifically enabling operations related to managing studios, products, documents, and pickaxes. The "Invite Users" operation under the "Pickaxe" resource is designed to invite multiple users by their email addresses to a specified studio and optionally associate them with selected products.
This node is beneficial in scenarios where an organization wants to programmatically manage user access and invitations within the Pickaxe platform, such as onboarding new team members or collaborators to specific studios and product groups.
Practical example:
A marketing team uses Pickaxe to manage product feedback. When new members join the team, this node can be used to automatically send invitations to their emails, granting them access to relevant studios and products without manual intervention.
Properties
| Name | Meaning |
|---|---|
| Studio | The target studio to which users will be invited. Choose from a list of available studios or specify an ID via expression. This is required. |
| Product Names | Optional selection of one or more products within the chosen studio to associate with the invited users. Choose from a list or specify IDs via expression. |
| User Emails | A list of email addresses of users to invite. Multiple emails can be provided. This is required. |
Output
The node outputs JSON data representing the result of the invitation operation. Typically, this includes confirmation details about the invited users, such as their email addresses and status of the invitation. The exact structure depends on the Pickaxe API response but generally confirms successful invitations or provides error information per user.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential configured for authenticating with the Pickaxe API.
- The node makes HTTP requests to
https://api.pickaxe.co/v1endpoints. - The OAuth2 authentication method is used for secure API access.
- The node dynamically loads options for studios and products based on the authenticated user's accessible resources.
Troubleshooting
Common issues:
- Invalid or expired API credentials may cause authentication failures.
- Providing invalid or non-existent studio or product IDs will result in errors.
- Incorrectly formatted email addresses or empty email lists will prevent invitations from being sent.
Error messages:
- Authentication errors typically indicate problems with the API key or OAuth token; re-authenticate or update credentials.
- Validation errors from the API may specify missing or invalid parameters; verify that all required fields are correctly set.
- Network or timeout errors suggest connectivity issues; check internet connection and API availability.
Links and References
- Pickaxe API Documentation (assumed official docs URL)
- n8n Expressions Documentation – for using expressions in property values