Skip to main content
CommCare logo
  • Category: forms & surveys
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 6
  • Triggers: 0
  • Slug: COMMCARE
  • Version: 20260615_00

Tools

Slug: COMMCARE_CREATE_LOOKUP_TABLETool 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.

Input Parameters

string
required
The name/identifier of the lookup table. This is used to reference the table in applications.
string
required
The CommCare domain/project identifier where the lookup table will be created.
array
required
Array of field definitions for the lookup table. Each field must have a field_name and optional properties array.
boolean
Indicates whether the lookup table is accessible to all users in the domain. Defaults to false if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMMCARE_CREATE_WEB_USER_INVITATIONTool 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.

Input Parameters

string
required
Role designation for the user (e.g., ‘App Editor’, ‘Admin’)
string
required
Email address of the user to invite
string
required
CommCare domain name where the invitation will be created
string
Profile to assign to the user
object
Custom data fields associated with the user
string
Tableau role (Explorer, ExplorerCanPublish, SiteAdministratorExplorer, Viewer, Unlicensed)
array
List of Tableau groups for user assignment
string
Location ID for primary assignment (must be in assigned locations)
array
List of location IDs the web user will access

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMMCARE_LIST_REPORTSTool 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.

Input Parameters

string
required
The CommCare project identifier. This is the project space name where reports are configured.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMMCARE_SINGLE_SIGN_ONTool 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.

Input Parameters

string
required
The CommCare domain/project identifier where the user account exists.
string
required
The user’s authentication password for login validation.
string
required
The user’s login identifier (mobile worker or web user username).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMMCARE_SUBMIT_FORM_ODK_COMPATIBLETool 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.

Input Parameters

string
required
The CommCare project domain name where the form will be submitted.
string
required
Complete XForm XML data as a string. Must include root <data> element with xmlns, name, and version attributes. Must contain an n1:meta node with required fields: deviceID, timeStart (ISO 8601), timeEnd (ISO 8601), username, userID (UUID), and instanceID (UUID4, must be unique).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMMCARE_SUBMIT_FORM_TO_APPTool to submit an XForm to a specific CommCare application. Use when you need to submit form data and tag it with a specific application ID. The form is submitted as XML following the OpenRosa standard with required metadata fields.

Input Parameters

string
required
The CommCare project domain/space where the form will be submitted.
string
required
Complete XForm XML content following OpenRosa standard. Must include root <data> element with xmlns, name, and version attributes. Must contain a <meta> section with required fields: deviceID, timeStart (ISO 8601 format), timeEnd (ISO 8601 format), username, userID, and instanceID (must be a unique UUID4 in format ‘uuid:…’ or just the UUID).
string
required
Application ID to tag the form submission with. This associates the submission with a specific CommCare application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not