Habitica

habitica

Habitica is an open-source task management application that gamifies productivity by turning tasks into role-playing game elements.

Productivity Task Management Gaming Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (47)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add Task to ChallengeHABITICA_ADD_CHALLENGE_TASKAcción

Tool 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.

Parámetros de entrada

datestring
ISO 8601 date string for the due date (for todos)
tagsstring[]
List of tag IDs to assign to the task
textstringObligatorio
Title of the task
typestringObligatorioenum
Type of the task
habitdailytodoreward
notesstring
Additional notes for the task
everyXinteger
Interval for recurrence (e.g., every X days)
prioritynumber
Priority of the task: one of [0.1 (Trivial), 1.0 (Easy), 1.5 (Medium), 2.0 (Hard)]
remindAtstring
ISO 8601 datetime string to set a reminder at
attributestringenum
Attribute associated with the task (strength, intelligence, perception, constitution)
strintpercon
frequencystringenum
Recurrence frequency for daily tasks
dailyweeklymonthlyyearly
challengeIdstringObligatorio
ID of the challenge to which to add the task

Parámetros de salida

dataobjectObligatorio
The created Task object with its properties
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates if the API call was successful
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Cancel SubscriptionHABITICA_CANCEL_SUBSCRIPTIONAcción

Attempts to cancel the authenticated user's subscription. Since Habitica's public API does not provide a cancellation endpoint, this action checks the current subscription state and returns: - success=True with a no-op message if there is no active subscription - success=False with guidance to cancel via the website/app if a subscription appears active

Parámetros de entrada

notestring
Additional notes or feedback (ignored).
reasonstring
Free-text reason for cancellation (ignored).
dry_runboolean
If True, do not attempt any changes (ignored).
immediateboolean
If True, request immediate cancellation (ignored).

Parámetros de salida

dataobjectObligatorio
Normalized subscription data snapshot
errorstring
Error if any occurred during the execution of the action
messagestring
Message about the cancellation outcome or guidance
successbooleanObligatorio
True if cancellation succeeded or no-op
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ChallengeHABITICA_CREATE_CHALLENGEAcción

Tool to create a new challenge. Use when you need to start a challenge in a specific group with title, summary, and optional tasks.

Parámetros de entrada

namestringObligatorio
Full name of the challenge
groupstringObligatorio
ID of the group (party or guild) in which to create the challenge
prizeinteger
Number of gems awarded to the winner; use 0 for free challenges
tasksobject[]
List of task templates to create with the challenge
leaderstring
User ID to set as the challenge leader; defaults to the authenticated user
summarystringObligatorio
One-line summary or subtitle for the challenge
officialboolean
Marks the challenge as official (visible in the public challenge directory)
shortNamestringObligatorio
URL-friendly unique identifier (slug) for the challenge
descriptionstring
Detailed description or rules of the challenge

Parámetros de salida

dataobjectObligatorio
Created challenge object with all its properties
errorstring
Error if any occurred during the execution of the action
messagestring
Error or informational message returned by Habitica
successbooleanObligatorio
Whether the API call was successful
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Habitica GroupHABITICA_CREATE_GROUPAcción

Tool to create a Habitica party or guild. Use when you want to initialize a new group with name, type, and optional privacy and description.

Parámetros de entrada

namestringObligatorio
The display name of the group (party or guild)
typestringObligatorioenum
The type of group to create: 'party' or 'guild'
partyguild
privacystringenum
Visibility setting for guilds: 'public' or 'private'. Required if type is 'guild'
publicprivate
descriptionstring
An optional description for the group

Parámetros de salida

dataobjectObligatorio
The created group object
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create TagHABITICA_CREATE_TAGAcción

Tool to create a new tag. Use after determining the desired tag name.

Parámetros de entrada

namestringObligatorio
The tag's name

Parámetros de salida

dataobjectObligatorio
The created tag object
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates if the request was successful
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create TaskHABITICA_CREATE_TASKAcción

Tool to create a new user task in Habitica. Use after gathering task details like text, type, and optional properties.

Parámetros de entrada

upboolean
Enable + button (habit)
datestring
Due date for the To-Do
downboolean
Enable − button (habit)
tagsstring[]
List of tag IDs to assign to the task
textstringObligatorio
Title of the task
typestringObligatorioenum
Type of the task: 'habit', 'daily', 'todo', or 'reward'
habitdailytodoreward
aliasstring
Alias for the task, used as a unique identifier
notesstring
Additional notes or description for the task
valuenumber
Reward cost in Gold; required when type = reward
everyXinteger
Interval step for recurrence
repeatobject
Weekly repeat flags: su,m,t,w,th,f,s
prioritynumber
Difficulty multiplier: 0.1 (Trivial), 1 (Easy), 1.5 (Medium), 2 (Hard)
attributestringenum
Primary attribute linked to the task
strintpercon
checklistobject[]
Checklist items for todo tasks
frequencystring
Recurrence rule base: daily, weekly, monthly
remindersobject[]
Reminders for the task
startDatestring
Start date (ISO 8601)
daysOfMonthinteger[]
Specific days for monthly schedule
weeksOfMonthinteger[]
Specific weeks for monthly schedule
collapseChecklistboolean
Whether checklist is collapsed by default

Parámetros de salida

dataobjectObligatorio
The created task object with its properties
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Whether the API call was successful
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create WebhookHABITICA_CREATE_WEBHOOKAcción

Tool to create a new webhook for taskActivity events. Use when you need real-time notifications of task creation, updates, deletion, or scoring.

Parámetros de entrada

urlstringObligatoriouri
Destination URL for webhook POSTs
typestringObligatorio
Event category to subscribe; only 'taskActivity' is supported
labelstring
Optional human-friendly label for the webhook
enabledboolean
Whether the webhook is enabled immediately upon creation
optionsobjectObligatorio
Event-specific toggles; required when type='taskActivity'

Parámetros de salida

dataobjectObligatorio
The newly created webhook resource
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
True if the webhook was created successfully
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a Habitica ChallengeHABITICA_DELETE_CHALLENGEAcción

Tool to delete a challenge. Use when you need to permanently remove a challenge after confirmation.

Parámetros de entrada

challengeIdstringObligatorio
The unique ID of the challenge to delete.

Parámetros de salida

dataobject
Empty object on success.
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Whether the deletion was successful.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Challenge TaskHABITICA_DELETE_CHALLENGE_TASKAcción

Tool to delete a specific task from a challenge. Use when removing an unwanted or outdated task from a challenge. Use after confirming the task belongs to the target challenge.

Parámetros de entrada

task_idstringObligatorio
The ID of the challenge task to delete

Parámetros de salida

dataobjectObligatorio
Empty object returned on success
errorstring
Error if any occurred during the execution of the action
messagestring
Optional success message returned by the API
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Habitica GroupHABITICA_DELETE_GROUPAcción

Tool to delete a Habitica group (guild) or leave a party. - For parties: Habitica does not support deleting via DELETE /groups/{id}. The correct flow is to leave the party via POST /groups/party/leave. - For guilds: If you are the leader and there are no members, you can delete the guild via DELETE /groups/{id}. Otherwise, you may need to manage membership first.

Parámetros de entrada

groupIdstringObligatorio
The unique identifier of the Habitica group to delete/leave

Parámetros de salida

dataobjectObligatorio
Data returned by the API (may be empty object)
errorstring
Error if any occurred during the execution of the action
messagestring
Human-readable message describing the result
successbooleanObligatorio
Indicates if the operation was successful
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Habitica TagHABITICA_DELETE_TAGAcción

Tool 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.

Parámetros de entrada

tagIdstringObligatorio
The unique identifier of the tag to delete

Parámetros de salida

dataobjectObligatorio
Additional data returned by the API (usually empty object)
errorstring
Error if any occurred during the execution of the action
messagestringObligatorio
Human-readable message describing the result
successbooleanObligatorio
Whether the deletion was successful
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete TaskHABITICA_DELETE_TASKAcción

Tool to delete a Habitica task. Use when you have the task ID and want to remove it permanently.

Parámetros de entrada

taskIdstringObligatorio
The unique identifier of the task to delete

Parámetros de salida

dataobjectObligatorio
The deleted task object returned by the API
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Whether the deletion succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Habitica AchievementsHABITICA_GET_ACHIEVEMENTSAcción

Tool to retrieve all available Habitica achievements. Use after authenticating to list achievements and their progress.

Parámetros de entrada

languagestring
Optional ISO 639-1/BCP-47 language code for localized content (e.g., 'en', 'es', 'pt-BR')

Parámetros de salida

dataobjectObligatorio
Achievements content payload from Habitica's content API
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates if the API call was successful
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ChallengeHABITICA_GET_CHALLENGEAcción

Tool to retrieve details of a specific challenge. Use when you have the challenge ID and need its full data.

Parámetros de entrada

challengeIdstringObligatorio
The unique identifier (UUID) of the challenge to retrieve

Parámetros de salida

dataobjectObligatorio
Challenge object returned
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Group ChallengesHABITICA_GET_CHALLENGESAcción

Tool to retrieve challenges available in a specific group (guild, party, or tavern).

Parámetros de entrada

pageinteger
Deprecated: Ignored by this endpoint.
limitinteger
Deprecated: Ignored by this endpoint.
groupIdstringObligatorio
ID of the group whose challenges to list. Use 'party' for the user's party and 'habitrpg' for the Tavern.

Parámetros de salida

dataobject[]Obligatorio
List of retrieved challenges
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Challenge TaskHABITICA_GET_CHALLENGE_TASKAcción

Tool to retrieve a specific task from any challenge. Use after you have the task ID and need its full details.

Parámetros de entrada

task_idstringObligatorio
The unique identifier (UUID) of the challenge task to retrieve

Parámetros de salida

dataobjectObligatorio
The task object returned by the API
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Challenge TasksHABITICA_GET_CHALLENGE_TASKSAcción

Tool 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.

Parámetros de entrada

challengeIdstringObligatorio
The unique identifier (UUID) of the challenge to retrieve tasks for

Parámetros de salida

dataobject[]Obligatorio
List of task objects defined in the challenge
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ContentHABITICA_GET_CONTENTAcción

Tool to retrieve global game content definitions. Use when loading Habitica items, equipment, pets, quests, and other definitions. Call once per session to cache content.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Global game content payload (items, equipment, pets, quests, etc.)
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Content By TypeHABITICA_GET_CONTENT_BY_TYPEAcción

Tool to retrieve game content for a specified category. Use when you need to fetch specific Habitica content by its type (e.g., items, quests). Use after identifying the content type.

Parámetros de entrada

typestringObligatorio
Content group key to retrieve, e.g., 'items', 'quests', 'backgrounds', etc.
languagestring
Optional ISO 639-1 language code for localized content

Parámetros de salida

dataobjectObligatorio
Content payload for the requested type
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates if the request was successful
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get EquipmentHABITICA_GET_EQUIPMENTAcción

Tool to retrieve the authenticated user’s equipped gear and costume. Use when you need to inspect current battle gear and costume slots.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
The user’s equipment state.
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates whether the API call was successful.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get GroupHABITICA_GET_GROUPAcción

Tool to retrieve details of a specific group. Use when you have a groupId and need its metadata.

Parámetros de entrada

groupIdstringObligatorio
The unique identifier (UUID) of the group to retrieve

Parámetros de salida

dataobjectObligatorio
Group object returned by the API
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Group MembersHABITICA_GET_GROUP_MEMBERSAcción

Tool to retrieve members of a specific group. Use when you have a groupId and need its member list.

Parámetros de entrada

groupIdstringObligatorio
The unique identifier (UUID) of the group to retrieve members for

Parámetros de salida

dataobject[]Obligatorio
List of group member objects returned by the API
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Habitica GroupsHABITICA_GET_GROUPSAcción

Tool to retrieve Habitica groups (guilds, parties, taverns). Use when browsing or searching available groups by type or name before joining.

Parámetros de entrada

namestring
Filter groups by name substring
pageinteger
Page index for pagination (0-based)
typestring
Type of groups to retrieve: 'guild', 'party', 'tavern'
limitinteger
Number of items to retrieve per page

Parámetros de salida

dataobject[]Obligatorio
List of group objects matching the query
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates whether the request succeeded
paginationobject
Pagination details if supported by the endpoint
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get NotificationsHABITICA_GET_NOTIFICATIONSAcción

Tool to retrieve notifications for the authenticated user. Use when you need to fetch the user's current notification list after authenticating.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
List of the user's notifications
errorstring
Error if any occurred during the execution of the action
messagestring
Optional informational message from the server
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get PartyHABITICA_GET_PARTYAcción

Tool to retrieve the authenticated user's party details. Use when you need to fetch the current party information after authenticating.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Party (group) object returned by the API
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Whether the API call was successful
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Party MembersHABITICA_GET_PARTY_MEMBERSAcción

Tool to retrieve members of the authenticated user's party. Use after authenticating to list current party members.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
List of party member objects returned by the API
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get TagsHABITICA_GET_TAGSAcción

Tool to retrieve authenticated user's tags. Use when you need to list the authenticated user's tags after confirming credentials.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
List of the user's tags
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get TasksHABITICA_GET_TASKSAcción

Tool to retrieve all tasks for the authenticated user. Use when you need the user's current tasks list after authenticating.

Parámetros de entrada

typestring[]
Optional filter by one or more task types. Valid values: 'habits', 'dailys', 'todos', 'rewards', 'completedTodos'.

Parámetros de salida

dataobject[]Obligatorio
List of task objects for the authenticated user
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User AchievementsHABITICA_GET_USER_ACHIEVEMENTSAcción

Tool to retrieve the authenticated user's achievements. Use after authenticating to fetch the current user's achievements.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Mapping of achievement keys to their progress details
errorstring
Error if any occurred during the execution of the action
messagestring
Optional human-readable message from the server
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User ChallengesHABITICA_GET_USER_CHALLENGESAcción

Tool to retrieve challenges the authenticated user participates in. Use when you need a paginated list of user challenges.

Parámetros de entrada

pageinteger
Zero-indexed page number; returns 10 challenges per page
ownedstringenum
Filter by ownership; 'owned' or 'not_owned'
ownednot_owned
memberboolean
If true, only return challenges the user has joined

Parámetros de salida

dataobject[]Obligatorio
List of challenges the user has access to
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User InventoryHABITICA_GET_USER_INVENTORYAcción

Tool to retrieve the authenticated user's full inventory. Use after authentication to list all owned items.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
The user's complete inventory data.
errorstring
Error if any occurred during the execution of the action
messagestring
Optional human-readable message from the server.
successbooleanObligatorio
Indicates whether the API call was successful.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User ProfileHABITICA_GET_USER_PROFILEAcción

Tool to retrieve the authenticated user's profile information. Use after authenticating to fetch user details.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Authenticated user's full profile object
errorstring
Error if any occurred during the execution of the action
messagestring
Optional localized message from the server
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User Quest ProgressHABITICA_GET_USER_QUEST_PROGRESSAcción

Tool to retrieve the authenticated user's quest progress. Use after authenticating to fetch the current user's quest progress.

Parámetros de entrada

notestring
Optional note for testing purposes; ignored by the API call and response normalization.
group_idstring
Group identifier to inspect for quest progress. Use 'party' to target the caller's party.

Parámetros de salida

dataobjectObligatorio
Mapping of quest keys to their progress details
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User StatsHABITICA_GET_USER_STATSAcción

Tool to retrieve the authenticated user's Habitica statistics. Use after authentication to fetch user's stats block.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Container for the user's stats
errorstring
Error if any occurred during the execution of the action
messagestring
Optional message from the server
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User SubscriptionHABITICA_GET_USER_SUBSCRIPTIONAcción

Tool to retrieve the authenticated user's subscription details. Use after authenticating to verify current subscription status.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Subscription data for the authenticated user.
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates if the request succeeded.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get WebhooksHABITICA_GET_WEBHOOKSAcción

Tool to retrieve webhooks for the authenticated user. Use when you need to list the user's webhooks after authenticating.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
List of the user's webhooks
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates whether the request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Invite To GroupHABITICA_INVITE_TO_GROUPAcción

Tool to invite users to a specific group. Use when you need to send invitations by user UUID, email, or username.

Parámetros de entrada

uuidsstring[]
List of Habitica user UUIDs to invite
emailsarray
List of email addresses or objects to invite non-registered users. If strings are provided, they will be converted to objects {'email': '<address>'}.
groupIdstringObligatorio
The unique identifier (UUID) of the group to invite users to. 'party' is also accepted for inviting to your party.
messagestring
Custom invitation message to include
usernamesstring[]
List of Habitica usernames to invite

Parámetros de salida

dataobjectObligatorio
Details of invitations sent by the API
errorstring
Error if any occurred during the execution of the action
messagestring
Informational message returned by Habitica
successbooleanObligatorio
Indicates if the invitation request was successful
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Invite To PartyHABITICA_INVITE_TO_PARTYAcción

Tool to invite users to the authenticated user's party. Use when you have a list of identifiers (UUIDs, emails, or usernames) ready and want to add them to your current party.

Parámetros de entrada

uuidsstring[]
List of Habitica user UUIDs to invite to the party
emailsstring[]
List of email addresses to invite non-registered users
messagestring
Optional custom invitation message
usernamesstring[]
List of Habitica usernames to invite

Parámetros de salida

dataobjectObligatorio
Data containing details about invitations sent
errorstring
Error if any occurred during the execution of the action
messagestring
Informational message returned by Habitica
successbooleanObligatorio
Indicates whether the invitation request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Join ChallengeHABITICA_JOIN_CHALLENGEAcción

Tool to join a challenge. Use after confirming the challenge ID to participate in a specific challenge.

Parámetros de entrada

challengeIdstringObligatorio
Unique identifier of the challenge to join

Parámetros de salida

dataobjectObligatorio
Response data returned by the API
errorstring
Error if any occurred during the execution of the action
messagestring
A message from Habitica about the join status
successbooleanObligatorio
Whether the API call was successful
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Leave ChallengeHABITICA_LEAVE_CHALLENGEAcción

Tool 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.

Parámetros de entrada

keepstringObligatorioenum
What to do with the challenge’s tasks upon leaving: `keep-all` to retain your tasks, `remove-all` to delete them.
keep-allremove-all
challengeIdstringObligatorio
The unique ID of the challenge to leave.

Parámetros de salida

dataobjectObligatorio
Result payload for the operation (may be empty).
errorstring
Error if any occurred during the execution of the action
messagestring
Human-readable message about the result.
successbooleanObligatorio
Whether the API call was successful.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Local LoginHABITICA_LOCAL_LOGINAcción

Tool to authenticate a user via local credentials. Use when needing an API token for subsequent Habitica requests.

Parámetros de entrada

passwordstringObligatorio
User's password for local authentication
usernamestringObligatorio
User's Habitica username for local authentication

Parámetros de salida

dataobjectObligatorio
Authenticated user object and credentials
errorstring
Error if any occurred during the execution of the action
messagestring
Error message in case of failed login
successbooleanObligatorio
Indicates whether the login was successful
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Local User RegistrationHABITICA_LOCAL_REGISTERAcción

Tool to register a new Habitica user via email and password. Use when creating a fresh account before authentication.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
The created user object returned by Habitica
errorstring
Error if any occurred during the execution of the action
messagestring
Optional message returned by the API
successbooleanObligatorio
Whether the API call was successful
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Mark Notifications SeenHABITICA_MARK_NOTIFICATIONS_SEENAcción

Tool to mark specific notifications as read. Use when you want to clear unread notification badges after reviewing your notifications.

Parámetros de entrada

notificationIdsstring[]Obligatorio
List of notification IDs to mark as read

Parámetros de salida

dataarrayObligatorio
Array returned by the API; typically an empty list
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates if the API call was successful
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Party MemberHABITICA_REMOVE_FROM_PARTYAcción

Tool to remove a member from your party. Use when you need to eject a user from your party as the party leader.

Parámetros de entrada

messagestring
Optional message/reason displayed to the removed member
memberIdstringObligatorio
UUID of the party member to remove

Parámetros de salida

dataobjectObligatorio
Updated party object or status returned by the API
errorstring
Error if any occurred during the execution of the action
messagestring
Optional status message returned by Habitica
successbooleanObligatorio
Whether the API call was successful
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Score TaskHABITICA_SCORE_TASKAcción

Tool to score (check/uncheck) a Habitica task. Use when you need to mark a task as completed or undone.

Parámetros de entrada

taskIdstringObligatorio
UUID of the task to score
directionstringObligatorioenum
Score direction; 'up' to check (complete), 'down' to uncheck
updown

Parámetros de salida

dataobjectObligatorio
Updated user stats and task data
errorstring
Error if any occurred during the execution of the action
messagestring
Message returned by Habitica
successbooleanObligatorio
Whether the API call was successful
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Social AuthHABITICA_SOCIAL_AUTHAcción

Tool to authenticate a user via a social provider. Use after obtaining an OAuth token or code from Facebook, Google, GitHub, or Apple.

Parámetros de entrada

codestring
GitHub authorization code (required if service is github)
servicestringObligatorioenum
Social provider to authenticate with. One of: facebook, google, github, apple
facebookgooglegithubapple
id_tokenstring
Google or Apple ID token (required if service is google or apple)
access_tokenstring
Facebook access token (required if service is facebook)
redirect_uristring
Redirect URI for GitHub OAuth (required if service is github)

Parámetros de salida

dataobjectObligatorio
Authentication data payload, including user details and API token
errorstring
Error if any occurred during the execution of the action
messagestring
Optional localized message from the server
successbooleanObligatorio
Indicates whether authentication succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Subscribe WebhookHABITICA_SUBSCRIBE_WEBHOOKAcción

Tool 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.

Parámetros de entrada

webhookIdstringObligatorio
Unique identifier of the webhook to subscribe the user to

Parámetros de salida

dataobjectObligatorio
The updated webhook object with subscription status
errorstring
Error if any occurred during the execution of the action
successbooleanObligatorio
Indicates whether the subscription request succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not