Actions23
- Task Actions
- Chat Message Actions
- Skill (Spell) Actions
- User Actions
- Quest Actions
- Group Actions
- Content Actions
- Inbox Actions
Overview
This node interacts with the Habitica API to retrieve inbox messages. Specifically, the "Get Inbox Messages" operation fetches messages from a user's Habitica inbox. It supports fetching either all messages at once or paginated results, allowing users to manage and review their Habitica inbox efficiently.
Common scenarios where this node is beneficial include:
- Automating the retrieval of Habitica inbox messages for monitoring or processing.
- Integrating Habitica inbox data into other workflows or dashboards.
- Fetching conversation-specific messages by providing a conversation identifier.
For example, a user might use this node to periodically pull new messages from their Habitica inbox and trigger notifications or logging actions based on message content.
Properties
Name | Meaning |
---|---|
All Messages | Boolean option to load all inbox messages at once (true) or use pagination (false). |
Conversation GUID | The unique identifier (GUID) of a specific conversation to fetch messages from. If empty, retrieves messages from all conversations. Typically corresponds to a user UUID. |
Page Number | When not loading all messages, specifies which page of messages to load. Each page contains 10 messages. |
Output
The node outputs JSON data representing the retrieved inbox messages. The structure typically includes an array of message objects corresponding to the requested conversation or all messages if no conversation ID is specified.
If pagination is used, the output contains only the messages for the selected page (10 messages per page).
No binary data output is indicated in the source code or properties.
Dependencies
- Requires an active connection to the Habitica API.
- Needs an API key credential for authentication with the Habitica service.
- The base URL for the API can be configured to use either the official Habitica API endpoint or a self-hosted instance, depending on user credentials.
Troubleshooting
Issue: No messages returned when specifying a Conversation GUID.
- Cause: The provided GUID may be incorrect or does not correspond to any existing conversation.
- Resolution: Verify the GUID value or leave it empty to fetch messages from all conversations.
Issue: Pagination returns empty pages.
- Cause: The requested page number exceeds the total number of available pages.
- Resolution: Adjust the page number within the valid range based on the total messages count.
Issue: Authentication errors.
- Cause: Invalid or missing API key credential.
- Resolution: Ensure that a valid API key credential is configured in n8n for the Habitica node.