Habitica

Habitica API

Actions23

Task Actions
Chat Message Actions
Skill (Spell) Actions
- Apply Skill
User Actions
- Get User Profile Info
- Equip or Unequip an Item
Quest Actions
Group Actions
Content Actions
- Get All Objects
Inbox Actions
- Get Inbox Messages
- Send Private Message

Overview

This node integrates with the Habitica API to perform various operations related to Habitica resources. Specifically, for the Chat Message resource and the Mark All As Read operation, it marks all chat messages in a selected group as read. This is useful for users who want to clear unread message notifications in Habitica groups efficiently without manually opening each message.

Practical scenarios include:

Automatically marking all messages as read after processing or reviewing them externally.
Keeping the Habitica chat interface clean by programmatically clearing unread indicators.
Integrating Habitica group chat management into broader automation workflows.

Properties

Name	Meaning
Group	Selects the Habitica group whose chat messages will be marked as read. Options:
	- List mode: Choose from a list of available groups.
	- ID mode: Enter a specific group ID (UUID format).

The "Group" property is required and supports two modes for specifying the target group:

List: Presents a selectable list of groups fetched via the API.
ID: Allows manual input of a group UUID matching the pattern xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

Output

The node outputs JSON data representing the result of the "mark all as read" action on the specified group's chat messages. The exact structure depends on the Habitica API response but typically includes confirmation of success or details about the updated read status.

No binary data output is involved in this operation.

Dependencies

Requires an API key credential for authenticating with the Habitica API.
The node uses the Habitica API base URL, which can be customized if using a self-hosted instance.
Network access to Habitica's API endpoints is necessary.

Troubleshooting

Invalid Group ID: If the provided group ID does not match the UUID format, the node will reject the input. Ensure the ID matches the pattern xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key credential is correctly configured.
Network Issues: Connectivity problems to the Habitica API endpoint may cause request failures. Check network settings and API availability.
Permission Denied: The authenticated user must have permission to access the specified group. Lack of membership or rights will prevent marking messages as read.