When integrating iQualify with other apps using the API or the Event Hub, you can pass additional information about users to these other apps using tags. This information could help with the integration (e.g. the learner’s student ID in your SMS or an Employee ID in a HR system) or it could allow the filtering of users according to the programme they are enrolled in, their home campus, or any other additional criteria that is important to your organisation.
Once you have decided which information you want to add to users, you can enter this information in iQualify as custom tags using the API. This article shows you how to access the relevant API easily by using Google Sheets and Zapier. In this example we are adding a mobile phone number tag and a location tag to users.
This process can be repeated several times, should you want to add more information at a later stage, or when new users join.
Before you start you'll need:
- a Zapier account. Their free plan will work for this, but dependent on your needs you may want to choose one of their paid plans.
- a Google account. If you have a gmail address you already have a Google account. If you don't have a Google account you can easily set one up Create your Google Account
1. First, you will need to create a new Google Sheet. If you not sure where to start head to https://sheets.google.com. Enter the column headers like below (you can add as many or as little tags as you like):
2. Give your Google Sheet a title so it is easy to identify. Otherwise it will automatically save as Untitled spreadsheet.
3. Add in a row of test data as shown below. This won't be added to your course but will be used to test that Zapier is working. Don't add your real learners details into this spreadsheet yet.
4. Log into your Zapier account and Make a zap.
5. Under Trigger, Choose App - search and select Google Sheets then Continue
6. Select New or Updated Spreadsheet Row and Continue
7. It will then ask you to Connect an Account (choose the appropriate Google account and allow permission to connect to Zapier). Save + Continue
8. You should now see the screen below. Click on the drop-down for the Spreadsheet field and select the Google sheet you have created. For the worksheet field select Sheet 1 (or the label on the tab of your spreadsheet). Then select continue.
9. It will then ask you to select the sample data in your Google Sheet. Choose the sample and click Continue
Now we need to set up the Action
10. Select the Webhooks icon and Custom request and Continue. This is what Zapier uses to communicate with the iQualify Developer API.
11. See the screen below for guidance on how this should be filled in.
Patch from the drop down menu.
URL: Copy or type https://api.iqualify.com/v1/users into the URL field and then click on the insert a field icon on the right-hand side. Choose the relevant fields, this will insert them in the URL section.
Data Pass-Through?: Set to
Data: The data you pass through needs to be in
JSON format. You can find out the expected format for any of our API endpoints by visiting our Developer API docs. Using the insert a field icon on the right-hand side, you can the relevant fields from your spreadsheet. Please note they have to be contained in quotation-marks
"" as shown in the example below.
Note: In this example we've included two tags. You can add as many or as little as you like by specifying them in your spreadsheet and passing those additional tags in the data field ie.
Unflatten: Set to
Headers: Two headers will need to be setup as shown in the image below. One header to specify the
Content-Type and one for
Authorization to authorize the request by using your API access token. Click here for further information on accessing your API token.
Note: You can copy the Headers above to ensure correctness (American spelling).
12. Click continue to see the sample data. Select Skip Test to continue.
13. Give your Zap a name and make sure the toggle is set at ON and then you are ready to go. It will automatically run every 15 minutes or you can choose to run it manually.
14. You can now add your learner information to your Google sheet. The learner will need to have been already added to your environment.
15. You can either manually run your Zap or wait for the next scheduled update. Any learners details added to your Google Sheet will now be added as a tag for the learner.
For more information on the iQualify Developer API you can go to https://iqualify.readme.io/