Habitica¶
The Habitica modules allow you to monitor, create, update, send, retrieve, list, and delete the groups, tags, messages, and challenges in your Habitica account.
Getting Started with Habitica¶
Prerequisites
- A Habitica account - create an account at habitica.com.
Connecting Habitica to Ibexa Connect¶
To connect your Habitica account to Ibexa Connect you need to obtain the User ID and API Token from your Habitica account and insert them in the Create a connection dialog in the Ibexa Connect module.
1. Log in to your Habitica account.
2. Click Your Profile Icon > Settings > API.
3. Copy the User ID. Click Show API Token and copy the token to a safe place.
4. Log in to your Ibexa Connect account and add a module from the Habitica app into an Ibexa Connect scenario.
5. Click Add next to the Connection field.
6. In the Connection name field, enter a name for the connection.
7. In the User ID and API Key field, enter the details copied in step 3 in the respective fields and click Continue.
The connection has been established.
Groups¶
Search Groups¶
Searches group by criteria.
Type |
Add the type details:
Note: At least one type must be selected. |
||||||||||
Limit |
Set the maximum number of groups Ibexa Connect should return during one execution cycle. The default value is 10. |
Get a Group¶
Get a group.
| Group ID | Select or map the Group ID whose details you want to retrieve.Note: Public guilds groups are not displayed in the list. |
Create a Group¶
Creates a group.
Name |
Enter (map) a name for the group. |
Type |
Select or map the group type you want to create.
|
Privacy |
Select or map the privacy settings for the group.
Note: For the group-type party, the privacy should be set to private. |
Update a Group¶
Modifies a group. (Only for the group leader)
| Group ID | Select or map the Group ID whose details you want to update. |
| Group Name | Enter (map) a new name for the group. |
Leave a Group¶
Leaves a group.
Group ID |
Select or map the Group ID which you want to leave.Note: Public guild groups are not displayed in the list. |
Keep |
Select whether you want to keep all the challenges belonging to the group being left.
|
Keep Changes |
Select whether you want to leave or remain in the challenges of the group.
|
Join a Group¶
Joins a group.
| Group ID | Enter (map) the Group ID you want to join. |
Reject a Group Invite¶
Rejects a group invite.
| Group ID | Enter (map) the Group ID whose invite you want to reject. |
Remove a Member From a Group¶
Remove a member from a group. (only for the group leader)
| Group ID | Select or map the Group ID from which you want to remove the member. |
| Member ID | Select or map the Member ID whom you want to remove from the group. |
Invite Users to a Group¶
Invites users to a group.
Group ID |
Select or map the Group ID to which you want to invite the users. |
||||
Emails |
Add the email addresses of the users:
|
||||
User IDs |
Add the User IDs of the users:
|
Tags¶
List Tags¶
List all tags
| Limit | Set the maximum number of tags Ibexa Connect should return during one execution cycle. The default value is 10. |
Get a Tag¶
Gets a tag.
| Tag ID | Select or map the Tag ID whose details you want to retrieve. |
Create a New Tag¶
Creates a new tag.
| Name | Enter (map) a name for the tag. |
Update a Tag¶
Modifies a tag.
| Tag ID | Select or map the Tag ID whose details you want to update. |
| Name | Enter (map) a new name for the tag. |
Delete a Tag¶
Deletes a tag.
| Tag ID | Select or map the Tag ID you want to delete. |
Tasks¶
Ibexa Connect automatically creates a webhook in Habitica once you add an instant trigger to your scenario.
Watch Task Activity¶
Watches for a task activity.
Webhook name |
Enter the name of the webhook. |
Options |
Select or map the following options:
|
Enabled |
Select whether you want to enable the webhook. |
Label |
Enter (map) the label for the webhook. |
List Tasks¶
Lists all tasks.
| Limit | Set the maximum number of tasks Ibexa Connect should return during one execution cycle. The default value is 10. |
Get a Task Belonging to User¶
Gets a task belonging to the user.
| Task ID | Select or map the Task ID of the user whose detail you want to retrieve. |
Create a Task Belonging to User¶
Creates a task belonging to the user.
Text |
Enter (map) the text to be displayed for the task. |
||||||||||||||||||||||
Task Type |
Select or map the task type:
|
||||||||||||||||||||||
Habit |
|
||||||||||||||||||||||
Daily |
Select the day on which you want the task to be repeated:
|
||||||||||||||||||||||
Date |
Enter (map) the due date to be shown in the task list. |
||||||||||||||||||||||
Value |
Enter (map) the value of the reward. This value should be greater than or equal to 0. |
||||||||||||||||||||||
Tags |
Select or map the type of tag you want to create. |
||||||||||||||||||||||
Alias |
Enter (map) the alias name to be displayed for the task. |
||||||||||||||||||||||
Attributes |
Select or map the task attributes:
|
||||||||||||||||||||||
Collapse Checklist |
Select whether to collapse the checklist. |
||||||||||||||||||||||
Notes |
Enter (map) any additional information about the task. |
||||||||||||||||||||||
Priority |
Select or map the task priority:
|
||||||||||||||||||||||
Reminders |
Enter (map) the fields for setting reminders:
|
||||||||||||||||||||||
Frequency |
Select or map the frequency level:
Note: Values Weekly and Monthly enable the use of the Repeat field. All frequency values enable the use of the Every X field. Value Monthly enables the use of the Weeks of Month and Days of Month fields. Frequency is only valid for the type Daily. |
Update a Task Belonging to User¶
Update a task belonging to the user.
Task ID |
Select or map the task ID of the user you want to update. |
||||||||||||||
Text |
Enter (map) the text to be displayed for the task. |
||||||||||||||
Up |
Select, if the task is a habit to enable the + under the directions/action in the good habits. |
||||||||||||||
Down |
Select, if the task is a habit to enable the - under the directions/action in the bad habits. |
||||||||||||||
Repeat |
Select the day on which you want the task to be repeated:
|
||||||||||||||
Streak |
Enter (map) the number of days that the task needs to be consecutively been checked off. This is valid only for type daily. |
||||||||||||||
Days of Month |
Enter (map) the days of the month. |
||||||||||||||
Weeks of Month |
Enter (map) the weeks of the month. |
||||||||||||||
Start Date |
Enter (map) the start date of the task. |
||||||||||||||
Date |
Enter (map) the due date of the task. This is valid only for type to do. |
||||||||||||||
Value |
Enter (map) the value. This is valid only for type reward. The value should be greater than or equal to 0. |
||||||||||||||
Attribute |
Select or map the task attribute:
|
||||||||||||||
Collapse Checklist |
Select whether to collapse the checklist. |
||||||||||||||
Notes |
Enter (map) any additional information about the task. |
||||||||||||||
Priority |
Select or map the task priority:
|
||||||||||||||
Reminders |
Enter (map) the fields for setting reminders:
|
||||||||||||||
Frequency |
Select or map the frequency level:
Note: Values Weekly and Monthly enable the use of the Repeat field. All frequency values enable the use of the Every X field. Value Monthly enables the use of the Weeks of Month and Days of Month fields. Frequency is only valid for the type Daily. |
Delete a Task Belonging to User¶
Delete a task belonging to the user.
| Task ID | Select or map the Task ID you want to delete. |
Messages¶
Send a Private Message¶
Sent a private message.
| To User ID | Enter (map) the User ID to whom you want to send the message. |
| Message | Enter (map) the message text. |
Mark Private Message as Read¶
Mark private messages as read.
Post Chat Message to a Group¶
Posts chat Message to a group.
| Group ID | Select or map the Group ID to which you want to post the message. |
| Message | Enter (map) the message text. |
| Previous Message | Enter (map) the previous chat Message UUID that will force a return of the full group chat. |
Mark All Messages as Read¶
Marks all messages as read for a group.
| Group ID | Select or map the Group ID whose messages you want to mark as read.Note: The public guild groups are not displayed in the list. |
Challenges¶
List Challenges¶
Lists all challenges.
| Group ID | Select or map the Group ID whose challenges you want to list.Note: The public guild groups are not displayed in the list. |
| Limit | Set the maximum number of challenges Ibexa Connect should return during one execution cycle. The default value is 10. |
Get a Challenge¶
Get a challenge.
| Group ID | Select or map the Group ID whose challenge details you want to retrieve.Note: The public guild groups are not displayed in the list. |
| Challenge ID | Select or map the Challenge ID whose details you want to retrieve. |
Create a Challenge¶
Create a challenge.
| Group ID | Select or map the Group ID for which you want to create a challenge.Note: The public guild groups are not displayed in the list. |
| Name | Enter (map) the full name of the challenge you want to create. |
| Short Name | Enter (map) the shortened name for the challenge you want to create, to be used as a tag. |
| Summary | Enter (map) the summary advertising the main purpose of the challenge you want to create. If not supplied, the challenge name will be used. Must be at most 250 characters long. |
| Description | Enter (map) the detailed description of the challenge you want to create. |
| Prize | Enter (map) the number of gems offered as a prize to the winner of the challenge. |
| Official | Select whether the challenge is an official Habitica challenge. This requires admin permissions. |
Update a Challenge¶
Updates a challenge. (For challenge leaders only)
| Group ID | Select or map the Group ID whose challenge details you want to update. |
| Challenge ID | Select or map the Challenge ID whose details you want to update. |
| Name | Enter (map) the new name for the challenge you want to update. |
| Short Name | Enter (map) the shortened name for the challenge you want to update, to be used as a tag. |
| Summary | Enter (map) the summary advertising the main purpose of the challenge you want to update. If not supplied, the challenge name will be used. Must be at most 250 characters long. |
| Description | Enter (map) the detailed description of the challenge you want to update. |
Delete a Challenge¶
Removes a challenge.
| Group ID | Select or map the Group ID for whose challenge you want to delete.Note: The public guild groups are not displayed in the list. |
| Challenge ID | Select or map the Challenge ID you want to delete. |
Join a Challenge¶
Joins a challenge.
| Group ID | Select or map the Group ID whose challenges you want to join. |
| Challenge ID | Select or map the Challenge ID which you want to join. |
Leave a Challenge¶
Leaves a challenge.
| Group ID | Select or map the Group ID whose challenge you want to leave.Note: The public guild groups are not displayed in the list. |
| Challenge ID | Select or map the Challenge ID you want to leave. |
Others¶
Performs an arbitrary authorized API call.
URL |
Enter a path relative to For the list of available endpoints, refer to the Habitica API Documentation. |
Method |
Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
Headers |
Enter the desired request headers. You don't have to add authorization headers; we already did that for you. |
Query String |
Enter the request query string. |
Body |
Enter the body content for your API call. |
Example of Use - List Groups¶
The following API call returns all the groups from your Habitica account:
URL:
/v3/groups
Method:
GET
Matches of the search can be found in the module's Output under Bundle > Body > data.
In our example, 1 group was returned:
