Habitica icon

Habitica

Habitica API

Overview

This node creates a new task in Habitica, a task management and habit-building application. It supports creating different types of tasks such as habits, dailies, todos, and rewards. Users can specify task details like the task caption, type, and additional optional fields depending on the task type. This node is useful for automating task creation in Habitica based on external triggers or workflows, such as adding a new habit or todo item automatically from another app.

Use Case Examples

  1. Automatically create a new habit task in Habitica when a user completes a specific action in another app.
  2. Add a daily task with a custom frequency and start date based on a calendar event.
  3. Create a reward task with a specified gold value when a user achieves a milestone.

Properties

Name Meaning
Task Caption The text of the task, describing what the task is about.
Task Type The type of task to create, such as habit, daily, todo, or reward.
Up Indicates whether the habit is a good habit (applicable only for habit type).
Down Indicates whether the habit is a bad habit (applicable only for habit type).
Value The amount of gold the reward is worth (applicable only for reward type).
Frequency The frequency of the task recurrence (applicable only for daily type).
Optional Fields Additional optional fields for the task such as notes, difficulty, attribute, and alias.
Optional Fields for Todo Type Optional fields specific to todo tasks, such as due date.
Optional Fields for Daily Type Optional fields specific to daily tasks, including interval, streak, and start date.

Output

JSON

  • id - The unique identifier of the created task.
  • text - The text or caption of the created task.
  • type - The type of the created task (habit, daily, todo, reward).
  • up - Indicates if the habit is a good habit (true/false).
  • down - Indicates if the habit is a bad habit (true/false).
  • value - The gold value of the reward task.
  • frequency - The recurrence frequency of the task (for daily tasks).
  • notes - Additional notes associated with the task.
  • priority - The difficulty or priority level of the task.
  • attribute - The user attribute associated with the task.
  • alias - Alias assigned to the task.
  • date - Due date for todo tasks.
  • everyX - Interval between daily tasks occurrences.
  • streak - Consecutive days the daily task has been completed.
  • startDate - Start date for the daily task availability.

Dependencies

  • Requires an API key credential for Habitica API authentication.

Troubleshooting

  • Ensure the API key credential is correctly configured and has the necessary permissions to create tasks.
  • Verify that the task type and related optional fields are correctly set according to Habitica API requirements.
  • Check network connectivity and API base URL settings, especially if using a self-hosted Habitica instance.
  • Common error messages may include authentication failures, invalid task data, or rate limiting; resolving these involves checking credentials, input data validity, and request throttling settings.

Links

Discussion