Skip to main content
Habitica logo
  • Category: productivity
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 70
  • Triggers: 0
  • Slug: HABITICA
  • Version: 20261101_00

Tools

Slug: HABITICA_ADD_CHALLENGE_TASKTool to add a new task to a specified challenge. Use when you need to programmatically create a challenge task after the challenge is set up and you have its ID.

Input Parameters

string
Due date for ‘todo’ type tasks in ISO 8601 format (YYYY-MM-DD or full datetime)
array
List of tag UUIDs to categorize the task. Tags must exist in the challenge owner’s account.
string
required
The title/name of the task that will be displayed to challenge participants
string ("habit" | "daily" | "todo" | "reward")
required
Task type: ‘habit’ (repeatable +/- actions), ‘daily’ (scheduled recurring tasks), ‘todo’ (one-time tasks), or ‘reward’ (purchasable with gold)
string
Detailed description or instructions for the task
integer
Repeat interval number used with frequency. E.g., everyX=3 with frequency=‘daily’ means every 3 days.
number
Task difficulty affecting gold/XP rewards: 0.1 (Trivial), 1.0 (Easy - default), 1.5 (Medium), 2.0 (Hard)
string
ISO 8601 datetime to send a reminder notification
string ("str" | "int" | "per" | "con")
Primary attribute this task trains: ‘str’ (Strength), ‘int’ (Intelligence), ‘per’ (Perception), ‘con’ (Constitution). Defaults to ‘str’.
string ("daily" | "weekly" | "monthly" | "yearly")
Recurrence frequency for ‘daily’ type tasks. Use with everyX to set repeat interval (e.g., frequency=‘weekly’, everyX=2 = every 2 weeks).
string
required
The unique UUID of the challenge to add the task to. Get this from GET /challenges/user or when creating a challenge.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_ADD_PUSH_DEVICETool to register a push notification device for the authenticated user. Use when you need to enable push notifications for mobile devices or UnifiedPush clients.

Input Parameters

string ("android" | "ios" | "unifiedpush")
required
The type of push notification service: ‘android’ for Firebase Cloud Messaging, ‘ios’ for Apple Push Notification service, or ‘unifiedpush’ for UnifiedPush
string
required
The registration ID for the device, obtained from the push notification service provider

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_ADD_TAG_TO_TASKTool to add a tag to a task. Use when you need to categorize or label a task with an existing tag.

Input Parameters

string
required
The tag ID (UUID) to add to the task. Use get_tags action to retrieve available tag IDs.
string
required
The task ID (UUID) or alias to add the tag to. Use get_tasks action to retrieve task IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_CLONE_CHALLENGETool to clone an existing challenge. Use when you need to duplicate a challenge to a different group with a new name.

Input Parameters

string
required
Name of the cloned challenge
string
required
ID of the group where the cloned challenge will be created
string
required
Short name of the cloned challenge
string
required
ID of the challenge to clone (must be a valid UUID)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_CREATE_CHALLENGETool to create a new challenge. Use when you need to start a challenge in a specific group with title, summary, and optional tasks.

Input Parameters

string
required
Full name of the challenge
string
required
ID of the group (party or guild) in which to create the challenge
integer
Number of gems awarded to the winner; use 0 for free challenges
array
List of task templates to create with the challenge
string
User ID to set as the challenge leader; defaults to the authenticated user
string
required
One-line summary or subtitle for the challenge
boolean
Marks the challenge as official (visible in the public challenge directory)
string
required
URL-friendly unique identifier (slug) for the challenge
string
Detailed description or rules of the challenge

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_CREATE_GROUPCreate a new Habitica party for collaborative gameplay. Use this tool to create a party where users can: - Participate in quests together - Chat with party members - Share achievements and progress Important Notes: - A user can only be in one party at a time. If already in a party, they must leave first. - Guilds are no longer supported by Habitica (removed August 2023). Only ‘party’ type works. - The authenticated user automatically becomes the party leader.

Input Parameters

string
required
The display name of the party (e.g., ‘Quest Warriors’, ‘Daily Challengers’)
string ("party" | "guild")
required
The type of group to create. Use ‘party’ (guilds are no longer supported by Habitica).
string ("public" | "private")
Privacy setting. Parties are always private. Only relevant for historical guild support.
string
An optional description for the party explaining its purpose or goals

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_CREATE_TAGTool to create a new tag. Use after determining the desired tag name.

Input Parameters

string
required
The tag’s name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_CREATE_TASKCreate a new task in Habitica. Supports four task types: - ‘habit’: Recurring positive/negative actions (use up/down to enable +/- buttons) - ‘daily’: Scheduled tasks that repeat on a schedule (configure with frequency, repeat, startDate) - ‘todo’: One-time tasks with optional due date (use date field) - ‘reward’: Custom rewards that cost gold (set value for the gold cost) Required fields: text (task title), type (habit/daily/todo/reward). Optional: notes, priority (0.1=Trivial, 1=Easy, 1.5=Medium, 2=Hard), tags, checklist.

Input Parameters

boolean
Enable + button (habit)
string
Due date for the To-Do
boolean
Enable − button (habit)
array
List of tag IDs to assign to the task
string
required
Title of the task
string ("habit" | "daily" | "todo" | "reward")
required
Type of the task: ‘habit’, ‘daily’, ‘todo’, or ‘reward’
string
Alias for the task, used as a unique identifier
string
Additional notes or description for the task
number
Reward cost in Gold; required when type = reward
integer
Interval step for recurrence
object
Weekly repeat flags: su,m,t,w,th,f,s
number
Difficulty multiplier: 0.1 (Trivial), 1 (Easy), 1.5 (Medium), 2 (Hard)
string ("str" | "int" | "per" | "con")
Primary attribute linked to the task
array
Checklist items for todo tasks
string
Recurrence rule base: daily, weekly, monthly
array
Reminders for the task
string
Start date (ISO 8601)
array
Specific days for monthly schedule
array
Specific weeks for monthly schedule
boolean
Whether checklist is collapsed by default

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_CREATE_WEBHOOKCreates a Habitica webhook for task activity, group chat, user activity, or quest activity events. Task activity options can select notifications for task creation, updates, deletion, or scoring.

Input Parameters

string
required
Destination URL that will receive webhook POST requests when events occur. Must be a valid HTTPS URL.
string ("taskActivity" | "groupChatReceived" | "userActivity" | "questActivity")
Event category to subscribe. Options: ‘taskActivity’ (task events), ‘groupChatReceived’ (group chat messages), ‘userActivity’ (user-level events), ‘questActivity’ (quest events)
string
Human-friendly label to identify this webhook
boolean
Whether the webhook is active and will receive events. Defaults to true.
object
required
Event-specific toggles controlling which events trigger the webhook. Required when type=‘taskActivity’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_DELETE_CHALLENGEPermanently delete a Habitica challenge. Only the challenge leader (creator) or an admin can delete a challenge. This action is irreversible - once deleted, the challenge and all associated tasks are permanently removed. Use HABITICA_GET_USER_CHALLENGES to find challenge IDs you own.

Input Parameters

string
required
The unique UUID of the challenge to delete. Must be owned by the authenticated user or the user must be an admin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_DELETE_GROUPLeave or delete a Habitica group (party or guild). This tool allows you to: 1. Leave a party: Pass ‘party’ as groupId or the party’s UUID to leave your current party. 2. Leave a guild: Pass the guild’s UUID to leave the guild. 3. Delete a guild: If you are the leader and there are no other members, passing the guild’s UUID will delete it (DELETE endpoint is tried if leave fails). Note: The Habitica API endpoint used is POST /groups/:groupId/leave. Only if that fails (e.g., you’re the leader trying to delete an empty guild), the DELETE /groups/:groupId endpoint is attempted.

Input Parameters

string
required
The unique identifier (UUID) of the Habitica group to leave or delete. Use ‘party’ to leave your current party. For guilds, provide the guild’s UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_DELETE_GROUP_CHAT_MESSAGETool to delete a chat message from a Habitica group (party, guild, or Tavern). Use when you need to remove a specific chat message. Note that only the message author or group moderators can delete messages.

Input Parameters

string
required
The UUID of the chat message to delete.
string
required
The unique identifier of the group. Use ‘party’ for the user’s party, ‘habitrpg’ for the Tavern, or provide a guild’s UUID.
string
The last message’s ID fetched by the client. If provided, the whole chat will be returned only if new messages have been posted in the meantime.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_DELETE_TAGTool to delete a tag for the authenticated user. Use when you need to remove an obsolete tag after confirming it’s no longer applied to any tasks.

Input Parameters

string
required
The unique identifier of the tag to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_DELETE_TASKPermanently deletes a user’s task (habit, daily, todo, or reward) by its ID. The task cannot be recovered after deletion. Use get_tasks to list tasks and their IDs first.

Input Parameters

string
required
The unique identifier (UUID) of the task to delete. Can be obtained from the get_tasks or create_task actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_DELETE_TASK_CHECKLIST_ITEMTool to delete a checklist item from a task. Use when you need to remove a specific checklist item from a todo or daily task.

Input Parameters

string
required
The checklist item _id. The unique identifier (UUID) of the checklist item to delete from the task.
string
required
The task _id or alias. The unique identifier (UUID) of the task containing the checklist item. Can be obtained from the get_tasks action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_DELETE_USER_MESSAGE_BY_IDTool to delete a message from the authenticated user’s inbox by its ID. Use when you need to remove a specific message from the user’s Habitica inbox.

Input Parameters

string
required
The unique identifier of the message to delete from the user’s inbox

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_DELETE_USER_PUSH_DEVICETool to remove a push device registration from the authenticated user’s account. Use when you need to unregister a device that should no longer receive push notifications.

Input Parameters

string
required
The registration ID of the push device to remove

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_EQUIP_ITEMTool to equip or unequip gear, pets, mounts, or costume items in Habitica. Use when you need to change the user’s equipped items. Equipping an already-equipped item will unequip it.

Input Parameters

string
required
The item key to equip (e.g., ‘weapon_warrior_0’, ‘armor_base_0’). To unequip, use the same item key that’s currently equipped.
string ("mount" | "pet" | "costume" | "equipped")
required
Type of equipment slot: ‘mount’ to equip a mount, ‘pet’ to equip a pet, ‘costume’ to equip costume gear, or ‘equipped’ to equip battle gear

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_EXPORT_CHALLENGE_CSVTool to export a Habitica challenge to CSV format. Use when you need to download challenge data as a CSV file. The CSV contains all challenge tasks and participant information.

Input Parameters

string
required
The unique UUID of the challenge to export as CSV

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_CHALLENGERetrieves details of a specific Habitica challenge by its ID.

Input Parameters

string
required
The unique identifier (UUID) of the challenge to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_CHALLENGESTool to retrieve challenges available in a specific group (guild, party, or tavern).

Input Parameters

string
required
ID of the group whose challenges to list. Use ‘party’ for the user’s party, ‘habitrpg’ for the Tavern (public challenges), or a specific guild UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_CHALLENGE_TASKRetrieve a task by its unique ID. Works for any Habitica task type (habit, daily, todo, reward) whether it belongs to a challenge or is a personal user task. Returns full task details including type-specific properties like completion status, streaks, and scheduling information.

Input Parameters

string
required
The unique identifier (UUID) of the task to retrieve. This can be a challenge task, user task, or any Habitica task ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_CHALLENGE_TASKSTool to get all tasks for a specified challenge. Use when you have a challenge ID and need to list its defined tasks, including challenge metadata per task.

Input Parameters

string
required
The unique identifier (UUID) of the challenge to retrieve tasks for. Obtain this from the get_user_challenges or get_challenges actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_CONTENTRetrieves Habitica game content definitions in a single request, including achievements, quests, gear, pets, mounts, food, backgrounds, and spells. An optional language can be supplied for localized content.

Input Parameters

string
ISO 639-1 language code for localized content text. Supported languages include ‘en’ (English, default), ‘es’ (Spanish), ‘de’ (German), ‘fr’ (French), ‘pt’ (Portuguese), ‘ja’ (Japanese), ‘zh’ (Chinese), ‘ru’ (Russian), etc. If not specified, defaults to English.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_CONTENT_BY_TYPERetrieves Habitica game content for a specified category, such as quests, gear, pets, mounts, backgrounds, or spells. It fetches the full content payload and returns the selected top-level category.

Input Parameters

string
required
Content category key to retrieve from Habitica’s game data. Common types include: ‘quests’ (quest definitions with boss info, rewards), ‘gear’ (equipment with stats organized by class), ‘pets’ (pet types), ‘mounts’ (mount types), ‘food’ (pet food items), ‘hatchingPotions’ (egg potions), ‘eggs’ (pet eggs), ‘backgrounds’ (avatar backgrounds), ‘spells’ (class abilities), ‘faq’ (FAQ entries), ‘classes’ (character class info).
string
ISO 639-1 language code for localized content text. Supported languages include ‘en’ (English, default), ‘es’ (Spanish), ‘de’ (German), ‘fr’ (French), ‘pt’ (Portuguese), ‘ja’ (Japanese), etc. If not specified, defaults to English.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_EXPORT_HISTORY_CSVTool to export user tasks history in CSV format. Returns CSV data with task completions and updates over time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_EXPORT_INBOX_HTMLTool to export inbox data in HTML format from Habitica. Use when you need to retrieve the user’s private messages and inbox content as an HTML document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_EXPORT_USERDATA_JSONExports the authenticated user’s complete data in JSON format. Use when you need a full backup or comprehensive snapshot of all user data. Returns the raw internal data structure with all fields and nested objects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_GROUPRetrieves detailed information about a Habitica group (guild or party). Use ‘party’ as groupId to get the user’s current party, or provide a specific group UUID obtained from HABITICA_GET_GROUPS.

Input Parameters

string
required
The group identifier. Can be a UUID for a specific group, or special values: ‘party’ (user’s party), ‘habitrpg’ (Tavern). Use HABITICA_GET_GROUPS to find group IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_GROUP_MEMBERSRetrieve members of a Habitica group (guild or party). Supports pagination via lastId parameter and optional search filtering. Use ‘party’ as groupId to get members of the current user’s party.

Input Parameters

integer
Maximum number of members to return per request (1-60). Defaults to 30.
string
UUID of the last member from a previous request for pagination. Use this to fetch the next batch of members.
Search term to filter members by profile name or username (case-insensitive).
string
required
The group identifier (UUID) or ‘party’ for the user’s current party
boolean
When true, returns all public fields for each member (stats, preferences, inventory, etc.). Defaults to false for basic profile info only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_GROUPSRetrieves Habitica groups based on type. Use ‘guilds’ to get all guilds the authenticated user belongs to, ‘party’ to get the user’s current party, or ‘tavern’ to get the global Tavern (the main public chat).

Input Parameters

string
Filter public guilds by name substring. Only applicable when querying public guilds.
integer
Page index for pagination (0-based). Only applicable when querying public guilds.
string ("guilds" | "party" | "tavern")
required
Type of groups to retrieve. ‘guilds’ returns all guilds the user is a member of. ‘party’ returns the user’s party. ‘tavern’ returns the global Tavern.
integer
Number of groups per page (max 30). Only applicable when querying public guilds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_GROUPS_HABITRPGTool to retrieve the Habitica Tavern (habitrpg) group details. The Tavern is the main public group where all Habitica users can chat and participate in community discussions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_GROUPS_PARTY_CHATTool to retrieve party chat messages from Habitica. Use when you need to fetch recent chat messages from the authenticated user’s party.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_MODELS_MODEL_PATHSRetrieves all available field paths and their data types for a specified Habitica model. Use this to discover the structure and available fields for user, group, challenge, tag, or task models. Helpful for understanding what fields can be queried or updated.

Input Parameters

string ("user" | "group" | "challenge" | "tag" | "habit" | "daily" | "todo" | "reward")
required
The model type to retrieve paths for. Available models include: ‘user’ (user profile fields), ‘group’ (group/guild fields), ‘challenge’ (challenge fields), ‘tag’ (tag fields), ‘habit’ (habit task fields), ‘daily’ (daily task fields), ‘todo’ (to-do task fields), ‘reward’ (reward task fields).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_NEWSTool to retrieve the latest Bailey announcement from Habitica. Use when you need to check current news, events, or updates posted by Bailey.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_PARTYRetrieves the authenticated user’s party details from Habitica. Returns information about the user’s current party including: - Party name, description, and member count - Party leader information - Current quest status and progress - Recent chat messages - Leader-only permissions Note: Returns an error if the user is not currently in a party. No parameters required - automatically fetches the party for the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_SHOPS_MARKET_GEARTool to retrieve the available gear for purchase in the market shop. Use when you need to check what equipment is available for each character class. Returns gear organized by class: healer, wizard, rogue, and warrior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_SHOPS_TIME_TRAVELERSTool to retrieve available items in the Time Travelers shop. Use when you need to see what quests, backgrounds, pets, or mounts can be purchased with hourglasses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_STATUSTool to check Habitica API server status. Use when you need to verify if the Habitica service is operational before making other API calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_TAGSRetrieve all tags for the authenticated Habitica user. Tags are labels that can be attached to tasks for organization. Returns both user-created tags and challenge-related tags. Use this to get tag IDs for filtering tasks or assigning tags to new tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_TASKSRetrieve the authenticated user’s Habitica tasks, optionally filtered by task type, including completed to-dos.

Input Parameters

string ("habits" | "dailys" | "todos" | "rewards" | "completedTodos")
Optional filter by a single task type. If not provided, all tasks are returned. Valid values: ‘habits’ (positive/negative habits), ‘dailys’ (recurring daily tasks), ‘todos’ (one-time tasks), ‘rewards’ (custom rewards), ‘completedTodos’ (completed to-do items).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_USER_CHALLENGESTool to retrieve challenges the authenticated user participates in. Use when you need a paginated list of user challenges.

Input Parameters

integer
Zero-indexed page number for pagination. Returns 10 challenges per page. Defaults to 0 (first page).
string ("owned" | "not_owned")
Filter by ownership; ‘owned’ or ‘not_owned’
boolean
If true, only return challenges the user has joined

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_USER_PROFILERetrieves the authenticated user’s Habitica profile, including stats and, when available, inventory, achievements, party information, preferences, task order, and tags. This read-only tool requires no parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_WEBHOOKSRetrieves all webhooks configured for the authenticated Habitica user. Returns a list of webhooks including their URLs, types, enabled status, and task activity options. Use this to check existing webhook configurations, monitor webhook health via failure counts, or get webhook IDs for updates/deletions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_GET_WORLD_STATERetrieves the current state of the Habitica game world including active events, world boss status, and seasonal NPC visual themes. Use when checking for active world events, monitoring world boss progress, or determining current seasonal themes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_INVITE_TO_GROUPTool to invite users to a specific group. Use when you need to send invitations by user UUID, email, or username.

Input Parameters

array
List of Habitica user UUIDs to invite
array
List of email addresses or objects to invite non-registered users. If strings are provided, they will be converted to objects {‘email’: ‘<address>’}.
string
required
The unique identifier (UUID) of the group to invite users to. ‘party’ is also accepted for inviting to your party.
string
Custom invitation message to include
array
List of Habitica usernames to invite

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_INVITE_TO_QUESTTool to invite party members to a quest. Use when you want to start a quest with a specific quest key in a group. The user must own the quest scroll to invite others.

Input Parameters

string
required
The group ID (use ‘party’ for the user’s party)
string
required
The quest key identifier (e.g., ‘dustbunnies’, ‘dilatory’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_JOIN_CHALLENGETool to join a challenge. Use after confirming the challenge ID to participate in a specific challenge.

Input Parameters

string
required
The UUID of the challenge to join. Must be a valid UUID format (e.g., ‘3646e192-5e01-4616-9339-6fd7e6ec5b8f’). Get challenge IDs from HABITICA_GET_CHALLENGES or HABITICA_GET_USER_CHALLENGES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_LEAVE_CHALLENGETool to leave a Habitica challenge. Use when you need to remove yourself from a specific challenge and decide whether to keep or remove its tasks.

Input Parameters

string ("keep-all" | "remove-all")
required
What to do with the challenge’s tasks upon leaving: keep-all to retain your tasks, remove-all to delete them.
string
required
The unique ID of the challenge to leave.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_LOCAL_LOGINTool to authenticate a user via local credentials. Use when needing an API token for subsequent Habitica requests.

Input Parameters

string
required
User’s password for local authentication
string
required
User’s Habitica username or email address for local authentication

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_LOCAL_REGISTERTool to register a new Habitica user via email and password. Use when creating a fresh account before authentication.

Input Parameters

string
required
Email address of the new user.
string
required
Password for the new user.
string
required
Login name; 1–36 characters; lowercase a–z, digits, hyphens (-), underscores (_).
string
required
Password confirmation; must match the password field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_MARK_GROUP_CHAT_SEENTool to mark all chat messages as read/seen for a specific group. Use when you need to clear unread message notifications in a group chat. Requires a valid group ID (‘party’ for user’s party, ‘habitrpg’ for Tavern).

Input Parameters

string
required
The group identifier. Can be a UUID for a specific group, or special values: ‘party’ (user’s party), ‘habitrpg’ (Tavern). Use HABITICA_GET_GROUPS to find group IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_MARK_NOTIFICATION_SEENTool to mark a single notification as seen in Habitica. Use this when you need to mark one specific notification as read after the user has viewed it.

Input Parameters

string
required
The ID of the notification to mark as seen. Get notification IDs from the Get Notifications action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_MARK_NOTIFICATIONS_SEENMarks specified Habitica notifications as read or seen using their IDs. The response may include updated notifications.

Input Parameters

array
required
List of notification IDs to mark as read. Get notification IDs from the Get Notifications action. At least one notification ID is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_MOVE_PINNED_ITEMTool to move a pinned item in the rewards column to a new position. Use when you need to reorder pinned items after sorting them.

Input Parameters

string
required
The full path of the pinned item to move (e.g., ‘gear.flat.weapon_warrior_1’, ‘potion’, ‘armoire’)
integer
required
The target position index (0-based) where the item should be moved to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_MOVE_TASK_TO_POSITIONMove a Habitica task to a new position in the task list. Use this when you need to reorder tasks by moving a specific task to the top (position=0), bottom (position=-1), or any specific position. The response returns the updated task order for the task type (habit, daily, todo, or reward) that the moved task belongs to.

Input Parameters

string
required
The task _id or alias to move
integer
required
Where to move the task. 0 = top of the list (push to top). -1 = bottom of the list (push to bottom). Other positive integers move the task to that specific position in the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_POST_NEWS_TELL_ME_LATERTool to dismiss the latest Bailey announcement in Habitica, allowing it to be read later. Use this when the user wants to clear the current news notification without reading it. The announcement will reappear later.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_POST_USER_RESETResets the authenticated user’s account to starting state. This permanently deletes all tasks, resets character to level 1, and clears progress while retaining some items and achievements. Use with caution as this action is irreversible.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_READ_CARDTool to mark a card as read in Habitica. Use when a user receives a special card (birthday, greeting, nye, thankyou, or valentine) and wants to acknowledge it. Updates user.flags.cardReceived and returns updated user.items.special.

Input Parameters

string ("birthday" | "greeting" | "nye" | "thankyou" | "valentine")
required
The type of card to read. Valid options are: birthday, greeting, nye (New Year’s Eve), thankyou, or valentine.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_REMOVE_FROM_PARTYRemoves a member from the authenticated user’s party. Requirements: - You must be the party leader to remove members - You cannot remove yourself (use Leave Party instead) - The member must be currently in your party Use Get Party Members first to obtain member IDs. This action is typically used to remove inactive members or those who no longer wish to participate.

Input Parameters

string
Optional message explaining why the member is being removed. This will be shown to the removed member in a notification.
string
required
The UUID of the party member to remove. Get member IDs from the Get Party Members action. Cannot be your own user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_SCORE_TASKScore a Habitica task to mark it as completed or incomplete. Use this tool to: - Mark a todo as complete (‘up’) or incomplete (‘down’) - Check off a daily task (‘up’) or uncheck it (‘down’) - Record a positive habit action (‘up’) or negative habit action (‘down’) - Redeem a reward (use ‘up’ direction for rewards) Returns updated user stats including health, mana, experience, gold, and level. Scoring tasks can trigger drops (food, eggs, potions) and quest progress.

Input Parameters

string
required
The task ID (UUID) or task alias to score. Use HABITICA_GET_TASKS to retrieve task IDs.
string ("up" | "down")
required
Score direction: ‘up’ marks task as completed (adds rewards), ‘down’ marks as incomplete (removes rewards). For habits, ‘up’ is positive action, ‘down’ is negative action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_SOCIAL_AUTHTool to authenticate a user via a social provider. Use after obtaining an OAuth token or code from Facebook, Google, GitHub, or Apple.

Input Parameters

string
GitHub authorization code (required if service is github)
string ("facebook" | "google" | "github" | "apple")
required
Social provider to authenticate with. One of: facebook, google, github, apple
string
Google or Apple ID token (required if service is google or apple)
string
Facebook access token (required if service is facebook)
string
Redirect URI for GitHub OAuth (required if service is github)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_SUBSCRIBE_WEBHOOKTool to enable (subscribe) an existing webhook by ID for the authenticated user. This aligns with Habitica’s documented API by updating the webhook resource to ensure it is enabled. Usage: obtain the webhook ID (e.g., via Get Webhooks or after creating a webhook) and call this action to set enabled=true.

Input Parameters

string
required
The UUID of the webhook to enable. Obtain this from the Get Webhooks action or when creating a webhook.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_UPDATE_GROUPTool to update a Habitica group (party or guild) by modifying its properties. Use when you need to change the name, description, or summary of an existing group. Only the group leader can update group properties.

Input Parameters

string
The new display name for the group
string
required
The group identifier to update. Can be a UUID for a specific group, or special values: ‘party’ (user’s party), ‘habitrpg’ (Tavern).
string
A brief summary of the group
string
The new description for the group explaining its purpose or goals

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_UPDATE_TAGTool to update an existing tag’s name. Use when you need to rename a tag after identifying its ID.

Input Parameters

string
required
The updated name for the tag
string
required
The unique identifier of the tag to update (UUID)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_UPDATE_TASKUpdate an existing task in Habitica. Use this to modify task properties like title, notes, priority, or other attributes. Only include fields you want to update - all body parameters are optional.

Input Parameters

array
Updated list of tag IDs to assign to the task. Replaces existing tags.
string
Updated title/name of the task
string
Updated task description or notes
string
required
The task ID (UUID) or alias to update. Can be obtained from get_tasks or create_task actions.
number
Updated difficulty multiplier: 0.1 (Trivial), 1 (Easy), 1.5 (Medium), 2 (Hard)
string ("str" | "int" | "per" | "con")
Updated player stat affected by this task: ‘str’ (Strength), ‘int’ (Intelligence), ‘con’ (Constitution), ‘per’ (Perception)
array
Updated checklist items for the task. Replaces existing checklist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_UPDATE_TASK_CHECKLIST_ITEMTool to update a checklist item in a task. Use when you need to modify the text of a specific checklist item in a todo or daily task.

Input Parameters

string
required
The updated text content for the checklist item.
string
required
The checklist item _id. The unique identifier (UUID) of the checklist item to update in the task.
string
required
The task _id or alias. The unique identifier (UUID) of the task containing the checklist item. Can be obtained from the get_tasks action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_UPDATE_USERUpdate supported fields of the authenticated user’s Habitica profile, preferences, and flags.

Input Parameters

string
User’s display name
boolean
Whether user has seen the ‘New Stuff’ alert
string
Character size: ‘slim’ or ‘broad’
string
Skin tone preference
string
Chair equipment name
string
Shirt color preference
boolean
Whether user is resting in the inn
boolean
Whether costume mode is enabled
integer
Hour of day when dailies reset (0-23)
string
User’s preferred language code (e.g., ‘en’, ‘es’, ‘fr’)
boolean
Whether user has been warned about low health
integer
Hair base style number
string
Background image name
integer
Hair bangs style number
integer
Beard style number
string
Hair color preference
integer
Hair flower style number
integer
Mustache style number
string
Stat allocation mode: ‘flat’, ‘classbased’, or ‘taskbased’
boolean
Whether class system is disabled

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HABITICA_VALIDATE_COUPON_CODEValidate a Habitica coupon code to check if it is valid and active. Use this tool to verify coupon codes before attempting to apply them to a user account. Returns information about the coupon’s validity and type (e.g., subscription, gems).

Input Parameters

string
required
The coupon code to validate. Must be a valid string identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not