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 send a private message to a specific user within the Habitica platform. It is useful for automating communication tasks such as sending reminders, notifications, or personalized messages to Habitica users directly from an n8n workflow.

Practical examples include:

Sending motivational messages to team members in a Habitica party.
Notifying a user about task updates or achievements.
Automating support or engagement messages based on external triggers.

Properties

Name	Meaning
Recipient User ID	The unique identifier of the Habitica user to whom the private message will be sent. Can be selected from a list of party members or entered manually as a UUID string.
Message	The content of the private message to send. Supports multiline text input.

Output

The node outputs JSON data representing the response from the Habitica API after attempting to send the private message. This typically includes confirmation details such as success status and any returned metadata from the API call.

No binary data output is involved.

Dependencies

Requires an active connection to the Habitica API via an API key credential configured in n8n.
The node uses the Habitica API base URL, which can be customized if using a self-hosted instance.
The node depends on the habiticaApiRequest method internally to perform authenticated HTTP requests to the Habitica API.

Troubleshooting

Invalid Recipient User ID: If the provided user ID does not match the expected UUID format or does not correspond to a valid user, the API request will fail. Ensure the user ID is correct and belongs to a member of your Habitica party.
Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key credential is correctly set up in n8n.
API Rate Limits or Downtime: Habitica API may enforce rate limits or experience downtime. In such cases, retrying after some time or checking Habitica's status page is recommended.
Empty Message: Sending an empty message might result in an error or no action. Always provide meaningful message content.