View as Markdown
Habitica icon

Habitica ACTION

Create Challenge

Creates a challenge. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Habitica account once, then configure and run Create Challenge from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "habitica-create-challenge",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    habitica: { authProvisionId: "apn_xxxxxxx" },
    type: "Type",
    group: "Group",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Challenge inputs
Property Type Description
type Type string
Type of the group
Required
group Group string
ID of the group to which the challenge belongs
Required Dynamic
name Name string
Full name of the challenge
Required
shortName Short Name string
A shortened name for the challenge, to be used as a tag
Required
summary Summary string
A short summary advertising the main purpose of the challenge
Optional
description Description string
A detailed description of the challenge
Optional
official Official boolean
Whether or not a challenge is an official Habitica challenge
Optional
prize Prize string
Number of gems offered as a prize to challenge winner
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
habitica-create-challenge
Version
0.0.2
App
Habitica
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes