Habitica icon

Habitica

Habitica API

Overview

This node integrates with the Habitica API to allow users to interact with Habitica tasks and their checklist items. Specifically, the "Score Checklist Item" operation for the "Task" resource enables users to mark a specific checklist item within a task as completed (or scored). This is useful in scenarios where you want to programmatically update the progress of subtasks or checklist items inside a Habitica task, such as automating task management workflows or syncing task progress from other systems.

Practical examples include:

  • Automatically scoring a checklist item when a related event occurs in another app.
  • Marking subtasks as done based on external triggers without manual intervention.
  • Integrating Habitica task progress into broader productivity pipelines.

Properties

Name Meaning
Task The target task containing the checklist item to score. Can be selected from a list or by entering a valid UUID task ID.
Checklist Item ID The unique identifier of the checklist item within the task that you want to score (mark as completed).

Details:

  • Task: Supports two modes:
    • List: Select from a list of available tasks.
    • ID: Enter a UUID string representing the task ID.
  • Checklist Item ID: A required string identifying which checklist item to score.

Output

The node outputs JSON data representing the response from the Habitica API after scoring the checklist item. This typically includes updated task information reflecting the newly scored checklist item. The output structure will contain fields describing the task's current state, including checklist completion status.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Habitica API.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • Uses the base URL either from the official Habitica API endpoint or a self-hosted instance if specified in credentials.

Troubleshooting

  • Invalid Task ID format: If the provided task ID does not match the expected UUID pattern, the node will reject it. Ensure the task ID is a valid UUID string.
  • Checklist Item Not Found: If the checklist item ID does not exist within the specified task, the API will return an error. Verify the checklist item ID corresponds to an existing checklist item in the task.
  • Authentication Errors: Missing or invalid API credentials will cause authorization failures. Confirm that the API key/token is correctly set up in n8n credentials.
  • API Connectivity Issues: Network problems or incorrect API base URLs can prevent successful requests. Check network connectivity and credential configuration, especially if using a self-hosted API instance.

Links and References

Discussion