Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add description of habitica update_tasks action #35211

Open
wants to merge 3 commits into
base: next
Choose a base branch
from
Open

Add description of habitica update_tasks action #35211

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
70e00f8
add description for Habitica update_tasks action
catsmanac Oct 13, 2024
7df6fba
oxford comma
tr4nt0r Nov 15, 2024
c3afd0a
suggested changes
tr4nt0r Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions source/_integrations/habitica.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,77 @@ Use a transformation item from your Habitica character's inventory on a member o
- **Seafoam**: `seafoam` (transforms into a starfish)
- **Shiny seed** `shiny_seed` (transforms into flower)

### Task update actions

The Habitica integration offers four actions to update the details and configuration of dailies, to-do's, habits, and rewards.

#### Common attributes

Habitica tasks share a common set of details and configuration options, and as such, the attributes listed below are available for all task update actions.

| Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------|
| config_entry | no | Select the Habitica account to update a task. |
| task | no | The name or task ID of the task you want to update. |
| rename | yes | The new title for the Habitica task. |
| description | yes | The new description for the Habitica task. |
| priority | yes | Update the difficulty of a task. |
| tag | yes | Add one or more tags to the task. Non-existent tags will be created automatically. |
| remove_tag | yes | Remove one or more tags the Habitica task. |
| alias | yes | A task alias can be used instead of the name or task ID. Only dashes, underscores, and alphanumeric characters are supported. The task alias must be unique among all your tasks. |

{% note %}
The `priority` attribute is not available for rewards.
{% endnote %}


#### Action `habitica.update_daily`

| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| add_checklist_item | yes | Add new checklist items to a task's checklist. |
| remove_checklist_item | yes | Remove checklist items from a task's checklist. |
| score_checklist_item | yes | Mark checklist items from a task's checklist as completed. |
| unscore_checklist_item | yes | Undo completion of checklist items from a task's checklist. |
| start_date | yes | Update the start date of a daily to define when it becomes active. Also determines the specific weekday or day of the month on which the habit repeats. |
| frequency | yes | Update the repetition interval of a daily. |
| every_x | yes | Set the number of days, weeks, months, or years after which the daily repeats. A value of 0 means the daily will never be due (a 'Grey-Daily'). |
| repeat | yes | Update the days of the week the daily repeats. |
| repeat_monthly | yes | Update if a monthly recurring task repeats on the same day or the same week and weekday of the month, determined by the start date. |
| reminder_time | yes | Add reminders to a Habitica task. |
| remove_reminder_time | yes | Remove specific reminders from a Habitica task. |
| clear_reminder | yes | Remove all reminders from a Habitica task. |
| streak | yes | Adjust or reset the streak counter of the daily. |

#### Action `habitica.update_todo`

| Data attribute | Optional | Description |
| ---------------------- | --------- | ----------------------------------------------------------------------------------------------------------------- |
| add_checklist_item | yes | Add new checklist items to a task's checklist. |
| remove_checklist_item | yes | Remove checklist items from a task's checklist. |
| score_checklist_item | yes | Mark checklist items from a task's checklist as completed. |
| unscore_checklist_item | yes | Undo completion of checklist items from a task's checklist. |
| date | yes | Update or set the to-do's due date. |
| clear_date | yes | Remove the due date from the to-do. |
| reminder | yes | Add reminders to a Habitica task. |
| remove_reminder | yes | Remove specific reminders from a Habitica task. |
| clear_reminder | yes | Remove all reminders from a Habitica task. |

#### Action `habitica.update_habit`

| Data attribute | Optional | Description |
| ---------------------- | --------- | ----------------------------------------------------------------------------------------------------------------- |
| up_down | yes | Update if the habit is good and rewarding (positive), bad and penalizing (negative), or both. |
| frequency | yes | Update the reset frequency of a habit's counter: daily at the start of a new day, weekly after Sunday night, and monthly at the end of the month. |
| counter_up | yes | Update the up counter of a positive habit. |
| counter_down | yes | Update the down counter of a negative habit. |

#### Action `habitica.update_reward`

| Data attribute | Optional | Description |
| -------------- | --------- | -----------------------------|
| cost | yes | Update the cost of a reward. |

## Automations

Get started with these automation examples for Habitica, each featuring ready-to-use blueprints!
Expand Down