Pickaxe icon

Pickaxe

Interact with the Pickaxe APIs

Overview

The Pickaxe node allows users to interact with the Pickaxe API, specifically enabling operations related to managing resources within Pickaxe. The "Create User" operation under the "Pickaxe" resource facilitates creating a new user in a specified studio with optional product associations and user details.

This node is beneficial when automating user management workflows for Pickaxe studios, such as onboarding new users programmatically, assigning them products, or updating user metadata like email verification status or IP address.

Practical examples:

  • Automatically create a new user in a Pickaxe studio after a signup form submission.
  • Assign multiple products to a user upon creation based on business logic.
  • Set user metadata such as profile image URL or IP address for audit or personalization purposes.

Properties

Name Meaning
Studio The Pickaxe studio where the user will be created. Choose from a list of available studios or specify an ID via expression.
Product Names List of products to associate with the user. Multiple products can be selected from the list or specified by IDs using expressions. Depends on the selected studio.
Email The email address of the user to be created. This is a required field.
Password The password for the new user account. Entered securely as a password type.
User Name The display name of the user. Optional descriptive name.
Image URL of the user's profile image. Optional.
IP Address The IP address associated with the user. Optional, useful for logging or security purposes.
User Email Verified Boolean flag indicating whether the user's email has been verified. Defaults to false.

Output

The node outputs JSON data representing the response from the Pickaxe API after attempting to create the user. This typically includes details about the newly created user such as their ID, email, assigned products, and other metadata.

If the API supports binary data output (not indicated here), it would be summarized accordingly, but this node primarily deals with JSON responses.

Dependencies

  • Requires an API authentication token configured in n8n credentials to authenticate requests to the Pickaxe API.
  • The node makes HTTP requests to https://api.pickaxe.co/v1 endpoints.
  • The "Studio" and "Product Names" fields dynamically load options by calling Pickaxe API endpoints to fetch current studios and products.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Specifying a non-existent studio or product ID may result in errors or empty responses.
    • Missing required fields like "Email" or "Studio" will prevent user creation.
  • Error messages:

    • Authentication errors: Ensure the API key or OAuth2 token is correctly set up in n8n credentials.
    • Validation errors: Check that all required properties are provided and valid.
    • Network errors: Verify network connectivity and that the Pickaxe API endpoint is reachable.

Links and References

Discussion