Page Comparison

...

To begin setting up your integration you will need the following:

• An account with Zapier

• A project space on CommCareHQ with an application.

• Have submitted a form with the application you want to setup the integration for.

• A google sheet setup to collect your data.

...

1. Proceed to your Zapier and log in to your account.

1. If you have not created an account, proceed to www.zapier.com and sign up for one.

2. Once logged in, select Make a Zap at the top of the page

3. On the next page, you will be prompted to ‘Choose a Trigger App.’ Search for and select CommCareHQ.

   Image RemovedImage Added

4. For ‘Select CommCare’ trigger, choose New Form. This should be the only option you can choose. Select continue.

5. When on the page that asks you to ‘Select CommCareHQ Account,’ select create a new account. 

6. A new window should pop up asking for your username and API key.

   1. The user name should be a web user account that you login to CommCareHQ with.

   2. The API Key can be found by proceeding to My Account Settings of CommCareHQ. Select the Gear icon in the top right, followed by My Account Settings: 

      Image RemovedImage Added
      
      

   3. On the My Information page, you should see the API key. Copy and paste this string into the corresponding field in Zapier:

      Image RemovedImage Added

       

7. You should now be on the Set up CommCareHQ Form

1. Select the Domain, Application and Form that you would like to trigger the action for. Select continue once you choose the form.

1. NOTE: You need to have submitted a form for the application you are setting the zap up for. It does not matter when this form was submitted, just that the application has been used before.  If you're defining your domain through Use a Custom Value, you must enter your domain as it appears in your browser's URL. For example, a project named Test Domain will appear in the URL as "test-domain" and must be entered into Zapier as such.

8. After selecting the Domain, Application and Form, you will be brought to a page where you can test the setup. Select ‘Fetch and Continue’

...

1. After setting up the trigger, you should be prompted to add an Action. Select to add one.

2. Choose Google Sheets.

3. For an action, select Create Spreadsheet Row. Select ‘Save + Continue.

4. You should now be on Select Google Sheets Account. Click Connect a New Account and allow Zapier access. When you click continue, you will be prompted to link the Spreadsheet and Worksheet you've created.

5. On the Set Up Template page, select the Spreadsheet dropdown. Select the spreadsheet you just set up.

6. Select the worksheet that you added the headers to. The headers should now appear as drop down fields beneath the worksheet field.

   Image RemovedImage Added
   

7. Proceed to match up the column headers as follows:
   Image Removed Image Added

   1. username = Form Meta Username

   2. timestart = Form Time Start
   3. timeend = Form Time End
   4. caseid = Form Case @case ID
   5. case_name = Form CasenameCase Create Case Name

8. After matching up the fields, select continue.

9. You should be brought to a page where you can test the integration. Select Create and Continue. 

10. You should receive a notification that the action was successful or not.

1. If successful, proceed to the spreadsheet and confirm it now has some data in it!

2. If unsuccessful, please review the steps to ensure everything is setup correctly.

11. After receiving the notification that the action was successful, select Finish.
12. Turn on your zap!

...