Habitica icon

Habitica

Habitica API

Overview

This node integrates with the Habitica API to invite a specified group to a particular quest. It is useful in scenarios where you want to programmatically manage group participation in quests within Habitica, such as automating invitations for team challenges or coordinating group activities.

For example, if you have a Habitica group and want to invite them to join a new quest automatically when certain conditions are met (like completing a milestone), this node can handle that invitation process.

Properties

Name Meaning
Group The target group to invite to the quest. You can select the group either from a list of available groups or by entering the group's unique ID. The ID must be a UUID string like a1abf9df-d89d-4f5e-9e80-26dc3c481042.
Quest Key The unique key identifier of the quest to which the group will be invited. This is a required string value representing the quest.

Output

The node outputs JSON data representing the response from the Habitica API after attempting to invite the group to the quest. This typically includes confirmation of the invitation status or any error messages returned by the API.

No binary data output is involved.

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 additional external services are needed beyond the Habitica API.

Troubleshooting

  • Invalid Group ID Format: If the group ID does not match the expected UUID format, the node will reject it. Ensure the group ID is correctly formatted.
  • Authentication Errors: If the API key credential is missing or invalid, the node will fail to authenticate. Verify that the correct API credentials are configured.
  • Quest Key Issues: Providing an incorrect or non-existent quest key will result in an error from the API. Double-check the quest key value.
  • Group Not Found or Access Denied: If the group does not exist or the authenticated user lacks permission to invite the group, the API will return an error.
  • Network or API Downtime: Temporary network issues or Habitica API downtime can cause request failures. Retry after some time or check Habitica's status.

Links and References

Discussion