Habitica

Overview

This node integrates with the Habitica API to allow users to equip or unequip various types of items for a user in Habitica. It supports managing different item categories such as mounts, pets, costumes, and gear. This functionality is useful for automating character customization or inventory management within Habitica, especially in workflows that involve updating a user's avatar or equipment based on external triggers or conditions.

Practical examples include:

• Automatically equipping a specific mount or pet when a user reaches a certain level.
• Unequipping gear or costumes as part of a reset or event workflow.
• Syncing user equipment state from an external system into Habitica.

Properties

Name	Meaning
Type	Type of the item to equip or unequip. Options: Mount, Pet, Costume, Gear (equipped).
Key	The unique key identifier of the item to equip or unequip.

Output

The node outputs JSON data representing the result of the equip or unequip operation performed on the specified item. This typically includes confirmation of the action taken and the updated state of the user's equipment in Habitica.

If the node supports binary data output, it would relate to any media or assets associated with the equipped items, but this is not indicated in the provided code.

Dependencies

• Requires an API key credential for authenticating with the Habitica API.
• The node uses the Habitica API base URL, which can be customized if using a self-hosted instance.
• No other external dependencies are indicated.

Troubleshooting

• Common issues:

  • Invalid or missing API credentials will prevent successful requests.
  • Providing an incorrect item key or type may cause the API to reject the request.
  • Network connectivity problems can lead to timeouts or failed API calls.

• Error messages:

  • Authentication errors usually indicate invalid or expired API tokens; verify and update credentials.
  • "Item not found" or similar errors suggest the item key does not exist or is not valid for the selected type.
  • Rate limiting errors from the API require implementing retry logic or reducing request frequency.

Links and References

• Habitica API Documentation
• Habitica Official Website