Actions13
Overview
The Pickaxe node allows users to interact with the Pickaxe API, specifically enabling operations related to managing documents and their connections within a studio environment. The "Connect Document" operation is designed to link a specified document to a Pickaxe entity (referred to as "Pickaxe") under a particular studio, optionally associating it with a user by email.
This node is beneficial in scenarios where automated workflows need to manage document relationships dynamically, such as connecting form responses or data entries to specific processing pipelines or user accounts within Pickaxe studios.
Practical example:
A workflow that receives new form submissions can use this node to connect the submitted document to a designated Pickaxe form for further processing or analytics, associating it with the submitting user's email.
Properties
| Name | Meaning |
|---|---|
| Studio | Select the studio from Pickaxe where the document and pickaxe entities reside. You can choose from a list of available studios or specify an ID using an expression. |
| Documents | Choose the document to connect. This list depends on the selected Studio. You can select one document or specify its ID via an expression. |
| Pickaxe | (Optional) Select the Pickaxe entity (e.g., a form or processing unit) to which the document will be connected. This list also depends on the selected Studio. |
| User | Provide the email address of the user to associate with the document connection. This links the document to a specific user in Pickaxe. |
Output
The node outputs JSON data representing the result of the connect document operation. This typically includes confirmation details about the connection made between the document and the Pickaxe entity, such as IDs and status messages returned by the Pickaxe API.
No binary data output is indicated or expected from this operation.
Dependencies
- Requires an active API authentication token configured in n8n credentials to access the Pickaxe API.
- The node makes HTTP requests to the Pickaxe API endpoints at
https://api.pickaxe.co/v1. - The user must have appropriate permissions in Pickaxe to list studios, documents, pickaxes, and to perform connection operations.
Troubleshooting
Common issues:
- Invalid or expired API credentials may cause authentication failures.
- Selecting a document or pickaxe entity that does not belong to the chosen studio will likely result in errors.
- Providing an invalid user email format might cause the API to reject the request.
Error messages and resolutions:
- Authentication errors: Verify that the API key or OAuth2 token is correctly set up and has not expired.
- Resource not found: Ensure that the selected studio, document, and pickaxe IDs are valid and accessible by the authenticated user.
- Validation errors: Check that all required fields are provided and formatted correctly, especially the user email.
Links and References
- Pickaxe API Documentation (assumed URL for reference)
- n8n Expressions Documentation – for using expressions in property fields