Habitica

Overview

This node integrates with the Habitica API to perform operations related to quests. Specifically, the "Force Start Quest" operation allows users to immediately start a quest for a specified group within Habitica. This can be useful in scenarios where a quest needs to be triggered programmatically without waiting for normal conditions or user actions, such as automating group activities or synchronizing quest starts across multiple systems.

Practical examples include:

• Automatically starting a quest for a guild or party when certain external criteria are met.
• Integrating Habitica quest management into broader workflow automation, e.g., triggering quests based on project milestones or team achievements.

Properties

Name	Meaning
Group	The group (e.g., party or guild) for which the quest will be force-started.

The "Group" property supports two modes of input:

• List: Select from a list of available groups retrieved via the API.
• ID: Enter a specific group ID manually, which must match the UUID format (e.g., a1abf9df-d89d-4f5e-9e80-26dc3c481042).

Output

The node outputs JSON data representing the response from the Habitica API after attempting to force start the quest. This typically includes details about the quest status and confirmation that the quest has started for the specified group.

If the API returns binary data (not indicated in the provided code), it would represent associated media or files related to the quest, but this is not evident here.

Dependencies

• Requires an API key credential for authenticating with the Habitica API.
• The node uses the base URL configured either as the default Habitica API endpoint or a self-hosted instance if specified in credentials.
• The node depends on internal helper modules for making API requests and searching groups/tasks, bundled within the node's source.

Troubleshooting

• Invalid Group ID Format: If the entered group ID does not match the required UUID pattern, the node will reject the input. Ensure the ID is correctly formatted.
• Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key credential is correctly set up.
• Group Not Found: Selecting a group that does not exist or to which the authenticated user lacks access may result in errors. Use the list mode to select valid groups.
• API Rate Limits or Downtime: Habitica API limits or outages could cause request failures. Check API status and retry later if needed.

Links and References

• Habitica API Documentation
• UUID Format Reference