Pickaxe icon

Pickaxe

Interact with the Pickaxe APIs

Overview

The Pickaxe node allows users to interact with the Pickaxe API, specifically managing connections between documents and pickaxes within a given studio. The "Disconnect Document" operation removes an existing association between a specified document and a pickaxe for a user.

This node is useful in scenarios where you need to programmatically manage document-pickaxe relationships, such as revoking access or unlinking documents from forms or workflows dynamically. For example, if a user no longer needs access to a particular document through a pickaxe form, this operation can disconnect that link automatically.

Properties

Name Meaning
Studio Select the studio by name or ID where the document and pickaxe exist.
Documents Select the document(s) to disconnect from the pickaxe.
Pickaxe Select the pickaxe (form) from which to disconnect the document.
User The email address of the user for whom the document will be disconnected from the pickaxe.

Output

The node outputs JSON data representing the result of the disconnect operation. This typically includes confirmation details about the disconnection status, such as success or failure messages. There is no binary data output.

Dependencies

  • Requires an API key credential for authenticating with the Pickaxe API.
  • The node makes HTTP requests to https://api.pickaxe.co/v1 endpoints.
  • Requires n8n credentials configured with OAuth2 or appropriate API authentication for Pickaxe.
  • Uses helper methods to load options dynamically for studios, documents, and pickaxes based on the selected studio.

Troubleshooting

  • Common Issues:

    • Invalid or expired API credentials may cause authentication failures.
    • Selecting a document or pickaxe that does not belong to the chosen studio will likely result in errors.
    • Providing an incorrect user email format might cause the API to reject the request.
  • Error Messages:

    • Authentication errors: Check that the API key or OAuth token is valid and has necessary permissions.
    • Resource not found: Verify that the studio, document, and pickaxe IDs are correct and exist.
    • Permission denied: Ensure the authenticated user has rights to modify document-pickaxe connections.

Links and References

Discussion