Zapier Integration

The Zapier connection with Habitica is now in beta!

If you're not familiar with Zapier, it's a platform that allows you to connect apps together. So if you need to link together Habitica with Google Calendar, Todoist, Slack or many other services, this is your lucky day!

Here's a step by step guide for getting started with Zapier. For this example, we'll walk through how to create a new todo every time someone posts to your party's chat. It's a bit of a contrived example, but it'll show you how to set up Zapier and allow you to swap out the trigger and action with whatever apps you want to use.

Step 1 - Sign up for Zapier

If you already have an account, you should just login instead and go to step 2. :)

Otherwise, head over to zapier.com and fill in the form on the home page to get started.

Step 2 - Join the Habitica Beta

Most apps on Zapier are public, so you can search for them in the app selector. Habitica's integration is still in beta, which means you need to follow this invite link to get access to it. Zapier requires at least 10 beta users before we can make the app public. Once it's public, new users will be able to find it from the app selector.

Follow the button that says Accept Invite and get ready to make a zap.

Step 3 - Setup the Trigger for your Zap

To get started, press the "Create this Zap" button. This will bring you to a page where you'll be able to choose a trigger. The two options available now are Task Activity (trigged when a task is created, updated, deleted or scored) or New Group Chat (triggered when a new message appears in a group chat).

We'll choose New Group Chat.

The next page will have a button that asks you to Connect Your Account. Press the button and a new window will appear that prompts you for your user id and API token. You can find these credentials on the settings page.

Next, you'll need to choose a group. For this example, we'll choose our party.

The final page on the trigger section will test to make sure the connection is working. It'll ask you to send a chat message in the group you selected. Once you've done it, you'll get a green success message.

Step 4 - Set an Action

You should see a page with a link that says "Your Zap currently lacks an Action step. Add one now!". Follow that link.

For this example, we'll just choose Habitica again and choose the "Create Task" option.

You'll be asked to choose a Habitica account. Use the one you created in step 3.

Next, you'll be able to create the template for your new task.

Under type, choose todo.

Under name, put "New Message From " and then press the insert a field button to the right of the input. A selection of options should appear, pick User Name.

In the notes field, select the insert field button and choose Chat Text.

You can skip the rest of the options for this example. Many pertain to specific task types other than To-Dos.

There will be a test page to make sure that Zapier can successfully create the To-Do. Test the connection and make sure that a new To-Do appears on your Habitica account (you may have to select the sync button).

Step 5 - Test out your zap!

All that's left to do is try it out. Go to your party page and send a message. Wait a few seconds, go to the task page, and press the sync button. You should see your new task with the details from your chat in the To-Dos column.

Now, every time someone posts a message in your party, you'll get a new To-Do!

Step 6 - Make something useful

I get it, what we made isn't particularly useful. But I hope it inspires you to make something that is.

Now that you've signed up for the Beta, Habitica will show up in the list of your apps to use when making a new Zap. Here are some ideas for zaps you could make:

  • Whenever you add an event to your Google Calendar, create a new To-Do
  • Whenever a new issue is added to a Github Repo, create a new To-Do
  • Whenever someone follows you on Twitter, score a habit

Got a great idea? Share it in the Aspiring Comrade's Guild!