CommCare

Modified on Fri, 16 Aug at 4:59 PM

The Commcare modules allow you to watch the forms, and cases in your Commcare account.

Getting Started with Commcare

Prerequisites

  • A Commcare account

In order to use Commcare with Make, it is necessary to have a CommCare account. If you do not have one, you can create a Commcare account at dimagi.com/commcare.

Notice

The module dialog fields that are displayed in bold (in the Make scenario, not in this documentation article) are mandatory!

Connecting Commcare to Make

To connect your Commcare account to Make you need to obtain the API Key from your CommCare account and insert it in the Create a connection dialog in the Make module.

  1. Log in to your CommCare account.

  2. Click Settings (the cog-wheel) > My Account Settings > API Keys.

    61d5ae4c91507.gif

  3. Enter a name for the API Key, select the permissions, and click Generate API Key.

    61d5ae4f0e7e1.png

  4. Copy the API key to your clipboard.

    61d5ae500caa8.png

  5. Go to Make and open the CommCare module's Create a connection dialog.

    61d5ae51284c9.gif

  6. In the Connection name field, enter a name for the connection.

  7. In the Username field, enter your account's username.

  8. In the API Key field, enter the API details copied in step 4 and Continue.

The connection has been established.

Forms

To trigger the watch modules, see Setting Up the CommCare Webhooks.

Cases

To trigger the watch modules, see Setting Up the CommCare Webhooks.

Other

Setting up the CommCare Webhooks

  1. Open any Watch module, establish a connection, click Save, and copy the URL address to your clipboard. Click OK and save the trigger.

    61d5ae559ff82.gif

  2. Log in to your CommCare account. From the Dashboard, click Settings > Connection Settings > Add Connection Settings.

    61d5ae581af0e.gif

  3. Enter the details for the connection and click Save.

    Name

    Enter a name for the webhook.

    Address to send notifications

    Enter the email address to which you want to send the trigger notifications.

    URL

    Enter the URL address copied in step 1.

    Auth Type

    Select the authentication type and enter the details:

    • None

    • HTTP Basic

    • HTTP Digest

    • Bearer Token

    • OAuth1

    • OAuth 2.0 Password Grant

    Skip Certificate Verification

    Select the checkbox to skip the certificate verification.

    61d5ae5a6e2ce.png

You have created the connection successfully.

61d5ae5b98a23.png

Once you have created the webhook connection, setup the required data forwarding as mentioned here.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article

Preview
0 of 0