Habitica icon

Habitica

Habitica API

Actions23

Overview

This node integrates with the Habitica API to create new tasks within a user's Habitica account. It supports creating different types of tasks such as Habits, Dailies, Todos, and Rewards, each with specific properties tailored to their function in the Habitica system.

Common scenarios for using this node include:

  • Automating task creation based on external triggers or workflows.
  • Syncing tasks from other productivity tools into Habitica.
  • Programmatically managing task attributes like difficulty, frequency, and due dates.

For example, you could use this node to automatically add a daily reminder task every morning or create a reward task when a user achieves a milestone in another app.

Properties

Name Meaning
Task Caption The text description of the task.
Task Type The type of task to create. Options: Habit, Daily, Todo, Reward.
Up (Habit only) Whether the habit is a positive (good) habit.
Down (Habit only) Whether the habit is a negative (bad) habit.
Value (Reward only) The amount of gold the reward is worth.
Frequency (Daily only) How often the task repeats. Options: Daily, Weekly, Monthly, Yearly.
Optional Fields Additional optional fields applicable to all task types:
- Notes Extra notes or comments about the task.
- Difficulty The difficulty level of the task. Options: Trivial, Easy, Medium, Hard.
- Attribute User attribute associated with the task. Options: Strength, Intelligence, Perception, Constitution.
- Alias An alias name to assign to the task.
Optional Fields for Todo Type Additional optional field for Todo tasks: Due Date (date/time when the task is due).
Optional Fields for Daily Type Additional optional fields for Daily tasks: Every X (interval), Streak (consecutive days completed), Start Date (when the task becomes active).

Output

The node outputs JSON data representing the created task as returned by the Habitica API. This typically includes details such as the task ID, text, type, and any other metadata set during creation.

If the node supports binary data output, it would be related to attachments or media linked to tasks, but no such binary output is indicated here.

Dependencies

  • Requires an API key credential for authenticating with the Habitica API.
  • The base URL for the API can be configured to use either the official Habitica API endpoint or a self-hosted instance.
  • No additional external dependencies are indicated beyond the Habitica API itself.

Troubleshooting

  • Authentication errors: Ensure that the API key credential is correctly configured and has sufficient permissions.
  • Invalid property values: For example, setting up or down flags on non-habit tasks will likely cause errors; ensure properties match the selected task type.
  • Date format issues: When specifying due dates or start dates, ensure the date/time format matches what the API expects.
  • API rate limits: Habitica enforces rate limits; excessive requests may result in temporary blocking.
  • Missing required fields: The text (task caption) and type are mandatory; omitting these will cause the request to fail.

Links and References

Discussion