Developer Tools

Commcare

Learn how to use Commcare with Composio

Overview

SLUG: COMMCARE

Description

Design Powerful Mobile and Web Apps

Authentication Details

generic_api_key
stringRequired
generic_id
stringRequired

Connecting to Commcare

Create an auth config

Use the dashboard to create an auth config for the Commcare toolkit. This allows you to connect multiple Commcare accounts to Composio for agents to use.

1

Select App

Navigate to Commcare.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Commcare Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4commcare_auth_config_id = "ac_YOUR_COMMCARE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Commcare for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, commcare_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Commcare toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Create Lookup Table

Description

Tool to create a new lookup table in a CommCare domain. Use when you need to set up reference data structures like product catalogs, price lists, or configuration tables. Requires 'Edit Apps' permission.

Action Parameters

domain
stringRequired
fields
arrayRequired
is_global
boolean
tag
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Web User Invitation

Description

Tool to create an invitation for a new web user in CommCare. Use when you need to invite a user with specific role and permissions. Requires 'Edit Web Users & Edit Access API' permissions.

Action Parameters

assigned_location_ids
array
domain
stringRequired
email
stringRequired
primary_location_id
string
profile
string
role
stringRequired
tableau_groups
array
tableau_role
string
user_data
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Reports

Description

Tool to retrieve available reports configured in a CommCare project. Use when you need to discover what reports exist before downloading report data via the Download Report Data API.

Action Parameters

project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Single Sign On

Description

Tool to validate login credentials and retrieve user profile for a mobile worker or web user. Use when you need to authenticate a user and obtain their profile information including roles, permissions, locations, and configuration details.

Action Parameters

domain
stringRequired
password
stringRequired
username
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Submit Form to CommCare

Description

Tool to submit an XForm to CommCare following the OpenRosa standard. Use when you need to submit form data with complete XML including required metadata fields (deviceID, timeStart, timeEnd, username, userID, instanceID).

Action Parameters

domain
stringRequired
form_xml
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Submit Form ODK Compatible

Description

Tool to submit form data using ODK-compatible endpoint for Android client compatibility. Use when submitting XForm data to CommCare. Requires properly formatted XML with metadata including unique instanceID.

Action Parameters

domain
stringRequired
xml_form_data
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired