> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Habitica

The Habitica connector lets your AI agent act in each user's Habitica account. Each user connects their own Habitica API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 51 tools.

**Authentication:** API Key
**Categories:** Productivity, Project Management
**Tools:** 51: 16 read, 29 write, 6 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=HABITICA)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Habitica connection

   In **AgentKit > Connections**, create a Habitica connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'habitica'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Habitica:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'habitica_inbox_messages_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "habitica"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Habitica:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="habitica_inbox_messages_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Habitica credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'habitica_challenge_get',
  toolInput: {
    challenge_id: '<challenge_id>',
  },
  connector: 'habitica',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="habitica_challenge_get",
    tool_input={
        "challenge_id": "<challenge_id>",
    },
    connection_name="habitica",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `habitica_challenge_get`

Get Challenge · Read-only

Get one challenge. Returns its name, description, group, prize, member count, leader and task IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `challenge_id` (`string`, required): ID (UUID) of the challenge, from habitica_challenges_list. Example: f23c12f2-5830-4f15-9c36-e17fd729a812.

Example input: `{"challenge_id":"<challenge_id>"}`

### `habitica_challenges_list`

List Challenges · Read-only

List challenges you can see, 10 per page, optionally only ones you joined or own, by search text or categories. Returns per challenge its ID, name, summary, group, prize, member count and leader.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, required): Page number, starting at 0. Example: 0.
- `categories` (`string`, optional): Comma-separated category slugs, e.g. self_improvement,health_fitness. Example: self_improvement.
- `member` (`string`, optional): Set to true for only challenges you joined. Example: true.
- `owned` (`string`, optional): owned for only challenges you own, not_owned for the rest. Example: owned. One of: `owned`, `not_owned`.
- `search` (`string`, optional): Text to search challenge names for. Example: reading.

Example input: `{"page":0}`

### `habitica_group_chat_list`

List Group Chat · Read-only

Get recent chat messages of a group, your party or the Tavern. Returns messages with ID, sender, text, timestamp and likes.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`string`, required): ID (UUID) of the group, or party for your party, or habitrpg for the Tavern. Example: party.
- `before` (`string`, optional): Only messages older than this message ID. Example: 6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d.
- `limit` (`integer`, optional): Number of messages (up to 400, default 50). Example: 50.

Example input: `{"group_id":"<group_id>"}`

### `habitica_group_get`

Get Group · Read-only

Get one group, or your party with party. Returns its name, description, leader, member count, quest and chat summary.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`string`, required): ID (UUID) of the group, or party for your party, or habitrpg for the Tavern. Example: party.

Example input: `{"group_id":"<group_id>"}`

### `habitica_group_members_list`

List Group Members · Read-only

List members of a group or your party, 30 per page by default. Returns per member the ID, profile name and optionally all public fields or tasks.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`string`, required): ID (UUID) of the group, or party for your party, or habitrpg for the Tavern. Example: party.
- `include_all_public_fields` (`boolean`, optional): Set to true for full public profiles. Example: false.
- `last_id` (`string`, optional): Member ID to start after, for paging. Example: 4c35f4e5-0a50-4f45-8d2e-1b7c3c6a1f7a.
- `limit` (`integer`, optional): Members per page (up to 60). Example: 30.

Example input: `{"group_id":"<group_id>"}`

### `habitica_groups_list`

List Groups · Read-only

List groups of a type you can see: your party, your guilds, private guilds, public guilds or the Tavern. Returns per group its ID, name, type, summary and member count.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `type` (`string`, required): Comma-separated group types: party, guilds, privateGuilds, publicGuilds, tavern. Example: party,guilds.
- `page` (`integer`, optional): Page number (from 0) when paginating public guilds. Example: 0.
- `paginate` (`boolean`, optional): Set to true to page public guilds. Example: true.

Example input: `{"type":"<type>"}`

### `habitica_inbox_messages_list`

List Private Messages · Read-only

List your private messages, 10 per page, optionally one conversation. Returns messages with sender, text and timestamp.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `conversation` (`string`, optional): User ID of the other person, to show only that conversation. Example: 4c35f4e5-0a50-4f45-8d2e-1b7c3c6a1f7a.
- `page` (`integer`, optional): Page number (from 0), 10 messages per page. Example: 0.

Example input: `{}`

### `habitica_member_get`

Get Member Profile · Read-only

Get the public profile of another Habitica user. Returns name, stats, class, level, achievements and appearance.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `member_id` (`string`, required): Habitica user ID (UUID) of the member. Example: 4c35f4e5-0a50-4f45-8d2e-1b7c3c6a1f7a.

Example input: `{"member_id":"<member_id>"}`

### `habitica_status_get`

Get API Status · Read-only

Check whether the Habitica API is up. Returns status up or down.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `habitica_tag_get`

Get Tag · Read-only

Get one tag. Returns its ID and name.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `tag_id` (`string`, required): ID (UUID) of the tag, from habitica_tags_list. Example: 3d5d324d-a042-4d5f-872e-0553e228553e.

Example input: `{"tag_id":"<tag_id>"}`

### `habitica_tags_list`

List Tags · Read-only

List your tags. Returns per tag its ID and name. Use this to find tag IDs for tasks.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `habitica_task_get`

Get Task · Read-only

Get one task by ID or alias. Returns its type, text, notes, difficulty, checklist, tags, schedule, streak and history.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `task_id` (`string`, required): ID (UUID) or alias of the task, from habitica_tasks_list. Example: 2b774d70-ec8b-41c1-8967-eb6b13d962ba.

Example input: `{"task_id":"<task_id>"}`

### `habitica_tasks_list`

List Tasks · Read-only

List your tasks, optionally only habits, dailies, To Dos, rewards or completed To Dos. Returns per task its ID, type, text, notes, difficulty, value, completed flag, due date, streak, checklist and tags. Use this to see what is on your list. Use habitica_task_get for one task.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `due_date` (`string`, optional): Date used to compute each daily's next due date, as an ISO 8601 date. Example: 2026-07-01.
- `type` (`string`, optional): Task type to return: habits, dailys, todos, rewards or completedTodos (the 30 most recent). Example: todos. One of: `habits`, `dailys`, `todos`, `rewards`, `completedTodos`.

Example input: `{}`

### `habitica_user_get`

Get User · Read-only

Get your Habitica profile: stats (health, experience, mana, gold, level, class), preferences, items, party, achievements and more, optionally only some fields. Returns the user object. Use user_fields to keep the response small, e.g. stats,profile.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `user_fields` (`string`, optional): Comma-separated user fields to return, e.g. stats,profile,preferences. Example: stats,profile.

Example input: `{}`

### `habitica_user_in_app_rewards_list`

List Reward Items · Read-only

List the in-game items shown in your rewards column (gear, potions, armoire). Returns each item's key, name, cost and currency.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `habitica_webhooks_list`

List Webhooks · Read-only

List your webhooks. Returns per webhook its ID, URL, label, type, options and enabled flag.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `habitica_challenge_join`

Join Challenge · Write

Join a challenge; its tasks are added to your list. Returns the challenge.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `challenge_id` (`string`, required): ID (UUID) of the challenge, from habitica_challenges_list. Example: f23c12f2-5830-4f15-9c36-e17fd729a812.

Example input: `{"challenge_id":"<challenge_id>"}`

### `habitica_challenge_leave`

Leave Challenge · Write

Leave a challenge, keeping or removing its tasks. Returns an empty data object.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `challenge_id` (`string`, required): ID (UUID) of the challenge, from habitica_challenges_list. Example: f23c12f2-5830-4f15-9c36-e17fd729a812.
- `keep` (`string`, optional): keep-all keeps the challenge tasks as your own; remove-all deletes them. Example: keep-all. One of: `keep-all`, `remove-all`.

Example input: `{"challenge_id":"<challenge_id>"}`

### `habitica_checklist_item_add`

Add Checklist Item · Write

Add an item to a daily's or To Do's checklist. Returns the updated task.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `task_id` (`string`, required): ID (UUID) or alias of the task, from habitica_tasks_list. Example: 2b774d70-ec8b-41c1-8967-eb6b13d962ba.
- `text` (`string`, required): Text of the checklist item. Example: Draft the summary.
- `completed` (`boolean`, optional): Set to true to add it already checked. Example: false.

Example input: `{"task_id":"<task_id>","text":"<text>"}`

### `habitica_checklist_item_score`

Toggle Checklist Item · Write

Check or uncheck a checklist item (it toggles). Returns the updated task.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `item_id` (`string`, required): ID (UUID) of the checklist item, from the task's checklist. Example: 9f3a0f4c-1c7e-4b55-8d1e-2a1b3c4d5e6f.
- `task_id` (`string`, required): ID (UUID) or alias of the task, from habitica_tasks_list. Example: 2b774d70-ec8b-41c1-8967-eb6b13d962ba.

Example input: `{"item_id":"<item_id>","task_id":"<task_id>"}`

### `habitica_checklist_item_update`

Update Checklist Item · Write

Change a checklist item's text or checked state. Returns the updated task.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `item_id` (`string`, required): ID (UUID) of the checklist item, from the task's checklist. Example: 9f3a0f4c-1c7e-4b55-8d1e-2a1b3c4d5e6f.
- `task_id` (`string`, required): ID (UUID) or alias of the task, from habitica_tasks_list. Example: 2b774d70-ec8b-41c1-8967-eb6b13d962ba.
- `text` (`string`, required): New text of the item. Example: Draft the executive summary.
- `completed` (`boolean`, optional): Checked state. Example: true.

Example input: `{"item_id":"<item_id>","task_id":"<task_id>","text":"<text>"}`

### `habitica_cron_run`

Run Cron · Write

Run Habitica's daily reset (cron) for you now if it is due: unfinished dailies do damage and a new day starts. Returns nothing. Use this before scoring dailies on a new day.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs: none.

Example input: `{}`

### `habitica_group_chat_like`

Like Chat Message · Write

Like or unlike (toggle) a group chat message. Returns the updated message.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `chat_id` (`string`, required): ID of the chat message. Example: 6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d.
- `group_id` (`string`, required): ID (UUID) of the group, or party for your party, or habitrpg for the Tavern. Example: party.

Example input: `{"chat_id":"<chat_id>","group_id":"<group_id>"}`

### `habitica_group_chat_post`

Post Group Chat Message · Write

Post a chat message to a group or your party. Returns the new message.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `group_id` (`string`, required): ID (UUID) of the group, or party for your party, or habitrpg for the Tavern. Example: party.
- `message` (`string`, required): Message text (Markdown). Example: Finished my dailies, ready for the boss!.

Example input: `{"group_id":"<group_id>","message":"<message>"}`

### `habitica_group_chat_seen`

Mark Group Chat Read · Write

Mark all chat messages of a group as read. Returns an empty data object.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`string`, required): ID (UUID) of the group, or party for your party, or habitrpg for the Tavern. Example: party.

Example input: `{"group_id":"<group_id>"}`

### `habitica_group_invite`

Invite to Group · Write

Invite people to a group or your party by Habitica user ID or by email. Returns the created invitations.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `group_id` (`string`, required): ID (UUID) of the group, or party for your party, or habitrpg for the Tavern. Example: party.
- `emails` (`array`, optional): Email invitations, each {"email": ..., "name": ...}. Example: [{"email":"friend@example.com","name":"Sam"}]
- `uuids` (`array`, optional): Habitica user IDs to invite. Example: ["4c35f4e5-0a50-4f45-8d2e-1b7c3c6a1f7a"]

Example input: `{"group_id":"<group_id>"}`

### `habitica_notifications_read`

Mark Notifications Read · Write

Mark notifications as read (removes them). Returns the remaining notifications.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `notification_ids` (`array`, required): IDs of the notifications to mark as read, from the user's notifications. Example: ["b8c7a6e5-1d2c-4b3a-9f8e-7d6c5b4a3f2e"]

Example input: `{"notification_ids":["b8c7a6e5-1d2c-4b3a-9f8e-7d6c5b4a3f2e"]}`

### `habitica_private_message_send`

Send Private Message · Write

Send a private message to another Habitica user. Returns the sent message.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `message` (`string`, required): Message text. Example: Thanks for the quest invite!.
- `to_user_id` (`string`, required): Habitica user ID (UUID) of the recipient. Example: 4c35f4e5-0a50-4f45-8d2e-1b7c3c6a1f7a.

Example input: `{"message":"<message>","to_user_id":"<to_user_id>"}`

### `habitica_quest_accept`

Accept Quest · Write

Accept your party's pending quest invitation. Returns the quest state.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`string`, required): ID (UUID) of the group, or party for your party, or habitrpg for the Tavern. Example: party.

Example input: `{"group_id":"<group_id>"}`

### `habitica_quest_leave`

Leave Quest · Write

Leave the active quest of your party. Returns the quest state.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `group_id` (`string`, required): ID (UUID) of the group, or party for your party, or habitrpg for the Tavern. Example: party.

Example input: `{"group_id":"<group_id>"}`

### `habitica_quest_reject`

Reject Quest · Write

Reject your party's pending quest invitation. Returns the quest state.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`string`, required): ID (UUID) of the group, or party for your party, or habitrpg for the Tavern. Example: party.

Example input: `{"group_id":"<group_id>"}`

### `habitica_tag_create`

Create Tag · Write

Create a tag. Returns the new tag with its ID.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Tag name. Example: Work.

Example input: `{"name":"<name>"}`

### `habitica_tag_update`

Rename Tag · Write

Rename a tag. Returns the updated tag.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `name` (`string`, required): New tag name. Example: Office.
- `tag_id` (`string`, required): ID (UUID) of the tag, from habitica_tags_list. Example: 3d5d324d-a042-4d5f-872e-0553e228553e.

Example input: `{"name":"<name>","tag_id":"<tag_id>"}`

### `habitica_task_create`

Create Task · Write

Create a habit, daily, To Do or reward with optional notes, difficulty, due date, schedule, checklist, tags and reminders. Returns the new task with its ID. Use habitica_task_score to complete it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `text` (`string`, required): Title of the task. Example: Write the quarterly report.
- `type` (`string`, required): Task type: habit, daily, todo or reward. Example: todo. One of: `habit`, `daily`, `todo`, `reward`.
- `alias` (`string`, optional): Optional alias you can use instead of the ID. Example: quarterly-report.
- `attribute` (`string`, optional): Character attribute the task trains: str, int, per or con. Example: int. One of: `str`, `int`, `per`, `con`.
- `checklist` (`array`, optional): Checklist items for dailies and To Dos, each {"text": ..., "completed": false}. Example: [{"text":"Outline","completed":false}]
- `date` (`string`, optional): Due date of a To Do, as an ISO 8601 date. Example: 2026-07-01.
- `down` (`boolean`, optional): Habits only: allow scoring down (negative). Example: false.
- `every_x` (`integer`, optional): Repeat every X days, weeks, months or years (dailies). Example: 1.
- `frequency` (`string`, optional): How a daily repeats: daily, weekly, monthly or yearly. Example: weekly. One of: `daily`, `weekly`, `monthly`, `yearly`.
- `notes` (`string`, optional): Extra notes shown under the task. Example: Spend at least 20 minutes.
- `priority` (`number`, optional): Difficulty: 0.1 (trivial), 1 (easy), 1.5 (medium) or 2 (hard). Example: 1.
- `reminders` (`array`, optional): Reminders, each {"time": ISO date-time, "startDate": ISO date-time}. Example: [{"time":"2026-07-01T08:00:00.000Z","startDate":"2026-07-01T00:00:00.000Z"}]
- `repeat` (`object`, optional): Weekdays a weekly daily is due, e.g. {"m": true, "t": true, "w": true, "th": true, "f": true, "s": false, "su": false}. Example: {"m":true,"t":true,"w":true,"th":true,"f":true,"s":false,"su":false}
- `start_date` (`string`, optional): Date a daily starts, as an ISO 8601 date. Example: 2026-07-01.
- `tags` (`array`, optional): IDs (UUIDs) of tags to attach. Example: ["3d5d324d-a042-4d5f-872e-0553e228553e"]
- `up` (`boolean`, optional): Habits only: allow scoring up (positive). Example: true.
- `value` (`number`, optional): Rewards only: cost in gold. Example: 10.

Example input: `{"text":"<text>","type":"habit"}`

### `habitica_task_move`

Move Task · Write

Move a task to a new position in its list (0 is the top, -1 the bottom). Returns the new order of task IDs. Completed To Dos cannot be moved.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `position` (`integer`, required): New position: 0 for the top, -1 for the bottom. Example: 0.
- `task_id` (`string`, required): ID (UUID) or alias of the task, from habitica_tasks_list. Example: 2b774d70-ec8b-41c1-8967-eb6b13d962ba.

Example input: `{"position":0,"task_id":"<task_id>"}`

### `habitica_task_score`

Score Task · Write

Score a task: up completes a To Do or daily, buys a reward or scores a habit positively; down unchecks or scores a habit negatively. Returns the change in health, experience, gold and mana, any drop, and the new stats. Use this to check off tasks.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `direction` (`string`, required): up or down. Example: up. One of: `up`, `down`.
- `task_id` (`string`, required): ID (UUID) or alias of the task, from habitica_tasks_list. Example: 2b774d70-ec8b-41c1-8967-eb6b13d962ba.

Example input: `{"direction":"up","task_id":"<task_id>"}`

### `habitica_task_tag_add`

Add Tag to Task · Write

Attach one of your tags to a task. Returns the updated task.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `tag_id` (`string`, required): ID (UUID) of the tag, from habitica_tags_list. Example: 3d5d324d-a042-4d5f-872e-0553e228553e.
- `task_id` (`string`, required): ID (UUID) or alias of the task, from habitica_tasks_list. Example: 2b774d70-ec8b-41c1-8967-eb6b13d962ba.

Example input: `{"tag_id":"<tag_id>","task_id":"<task_id>"}`

### `habitica_task_update`

Update Task · Write

Update the fields you pass on one task, such as text, notes, difficulty, due date or schedule. Returns the updated task. Use habitica_checklist_item_add and the tag tools for checklists and tags.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `task_id` (`string`, required): ID (UUID) or alias of the task, from habitica_tasks_list. Example: 2b774d70-ec8b-41c1-8967-eb6b13d962ba.
- `attribute` (`string`, optional): Character attribute the task trains: str, int, per or con. Example: int. One of: `str`, `int`, `per`, `con`.
- `date` (`string`, optional): Due date of a To Do, as an ISO 8601 date. Example: 2026-07-01.
- `down` (`boolean`, optional): Habits only: allow scoring down (negative). Example: false.
- `every_x` (`integer`, optional): Repeat every X days, weeks, months or years (dailies). Example: 1.
- `frequency` (`string`, optional): How a daily repeats: daily, weekly, monthly or yearly. Example: weekly. One of: `daily`, `weekly`, `monthly`, `yearly`.
- `notes` (`string`, optional): Extra notes shown under the task. Example: Spend at least 20 minutes.
- `priority` (`number`, optional): Difficulty: 0.1 (trivial), 1 (easy), 1.5 (medium) or 2 (hard). Example: 1.
- `reminders` (`array`, optional): Reminders, each {"time": ISO date-time, "startDate": ISO date-time}. Example: [{"time":"2026-07-01T08:00:00.000Z","startDate":"2026-07-01T00:00:00.000Z"}]
- `repeat` (`object`, optional): Weekdays a weekly daily is due, e.g. {"m": true, "t": true, "w": true, "th": true, "f": true, "s": false, "su": false}. Example: {"m":true,"t":true,"w":true,"th":true,"f":true,"s":false,"su":false}
- `start_date` (`string`, optional): Date a daily starts, as an ISO 8601 date. Example: 2026-07-01.
- `text` (`string`, optional): New title of the task. Example: Write the Q3 report.
- `up` (`boolean`, optional): Habits only: allow scoring up (positive). Example: true.
- `value` (`number`, optional): Rewards only: cost in gold. Example: 10.

Example input: `{"task_id":"<task_id>"}`

### `habitica_user_buy_health_potion`

Buy Health Potion · Write

Buy a health potion with gold to restore 15 health. Returns the updated stats.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs: none.

Example input: `{}`

### `habitica_user_custom_day_start`

Set Custom Day Start · Write

Set the hour your Habitica day starts (dailies reset). Returns the new setting.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `day_start` (`integer`, optional): Hour from 0 to 23 when the day begins. Example: 4.

Example input: `{}`

### `habitica_user_revive`

Revive · Write

Revive your character after dying (losing a level and an item). Returns the updated user.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs: none.

Example input: `{}`

### `habitica_user_sleep_toggle`

Toggle Rest in the Inn · Write

Start or stop resting in the Inn: while resting, missed dailies do no damage. Returns the new sleep state. Calling it again toggles back.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs: none.

Example input: `{}`

### `habitica_user_update`

Update User · Write

Update user settings with dotted paths, such as preferences.dayStart, preferences.timezoneOffset or profile.name. Returns the updated user. Use this for profile and preference changes.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `updates` (`object`, required): Object of dotted user paths to new values, e.g. {"profile.name": "Jane", "preferences.dayStart": 4}. Example: {"profile.name":"Jane"}

Example input: `{"updates":{"profile.name":"Jane"}}`

### `habitica_webhook_create`

Create Webhook · Write

Create a webhook that posts task, chat, user or quest events to a URL. Returns the new webhook.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `url` (`string`, required): URL that receives the events. Example: https://example.com/habitica-webhook.
- `enabled` (`boolean`, optional): Set to false to create it disabled. Example: true.
- `label` (`string`, optional): Label for the webhook. Example: sk-test task events.
- `options` (`object`, optional): Type-specific options, e.g. {"created": true, "scored": true} for taskActivity or {"groupId": ...} for groupChatReceived. Example: {"created":true,"scored":true}
- `type` (`string`, optional): Event type: taskActivity, groupChatReceived, userActivity or questActivity. Example: taskActivity. One of: `taskActivity`, `groupChatReceived`, `userActivity`, `questActivity`.

Example input: `{"url":"<url>"}`

### `habitica_webhook_update`

Update Webhook · Write

Change a webhook's URL, label, type, options or enabled flag. Returns the updated webhook.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID (UUID) of the webhook, from habitica_webhooks_list. Example: 3b6d4c5e-1a2b-4c3d-9e8f-0a1b2c3d4e5f.
- `enabled` (`boolean`, optional): true to enable, false to pause. Example: false.
- `label` (`string`, optional): Label for the webhook. Example: sk-test task events.
- `options` (`object`, optional): Type-specific options, e.g. {"created": true, "scored": true} for taskActivity or {"groupId": ...} for groupChatReceived. Example: {"created":true,"scored":true}
- `type` (`string`, optional): Event type: taskActivity, groupChatReceived, userActivity or questActivity. Example: taskActivity. One of: `taskActivity`, `groupChatReceived`, `userActivity`, `questActivity`.
- `url` (`string`, optional): URL that receives the events. Example: https://example.com/habitica-webhook-2.

Example input: `{"id":"<id>"}`

### `habitica_checklist_item_delete`

Delete Checklist Item · Destructive

Delete a checklist item from a task. Returns the updated task.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `item_id` (`string`, required): ID (UUID) of the checklist item, from the task's checklist. Example: 9f3a0f4c-1c7e-4b55-8d1e-2a1b3c4d5e6f.
- `task_id` (`string`, required): ID (UUID) or alias of the task, from habitica_tasks_list. Example: 2b774d70-ec8b-41c1-8967-eb6b13d962ba.

Example input: `{"item_id":"<item_id>","task_id":"<task_id>"}`

### `habitica_tag_delete`

Delete Tag · Destructive

Delete a tag and remove it from all tasks. Returns an empty data object.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `tag_id` (`string`, required): ID (UUID) of the tag, from habitica_tags_list. Example: 3d5d324d-a042-4d5f-872e-0553e228553e.

Example input: `{"tag_id":"<tag_id>"}`

### `habitica_task_delete`

Delete Task · Destructive

Delete one task. Returns an empty data object on success.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `task_id` (`string`, required): ID (UUID) or alias of the task, from habitica_tasks_list. Example: 2b774d70-ec8b-41c1-8967-eb6b13d962ba.

Example input: `{"task_id":"<task_id>"}`

### `habitica_task_tag_remove`

Remove Tag from Task · Destructive

Detach a tag from a task. Returns the updated task.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `tag_id` (`string`, required): ID (UUID) of the tag, from habitica_tags_list. Example: 3d5d324d-a042-4d5f-872e-0553e228553e.
- `task_id` (`string`, required): ID (UUID) or alias of the task, from habitica_tasks_list. Example: 2b774d70-ec8b-41c1-8967-eb6b13d962ba.

Example input: `{"tag_id":"<tag_id>","task_id":"<task_id>"}`

### `habitica_todos_clear_completed`

Clear Completed To Dos · Destructive

Delete all your completed To Dos except those that belong to a challenge or group plan. Returns an empty data object.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs: none.

Example input: `{}`

### `habitica_webhook_delete`

Delete Webhook · Destructive

Delete a webhook. Returns the remaining webhooks.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID (UUID) of the webhook, from habitica_webhooks_list. Example: 3b6d4c5e-1a2b-4c3d-9e8f-0a1b2c3d4e5f.

Example input: `{"id":"<id>"}`

## Related

Other Productivity connectors ([all 203](/agentkit/connectors/?category=productivity)):

- [Slack](/agentkit/connectors/slack/): Scalekit connector, OAuth, 96 tools
- [Notion](/agentkit/connectors/notion/): Scalekit connector, OAuth, 51 tools
- [Google Workspace (DWD)](/agentkit/connectors/googledwd/): Scalekit connector, Service account, 100 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
