You can either use our API or Zapier to integrate with other systems. Zapier can be set up by business users - whereas using the API requires some development expertise.
Zapier is a third party tool (www.zapier.com) that allows you to integrate to over 1500 different applications including all of the popular CRMs.
We have created a connector (using our API) in Zapier to give access to the data. You can get access to the connector by following this link.
Data Available Through the Zapier Connector
Using the zapier interface you have a limited subsect of the data available in the api:
- ResponseId
- BusinessName
- FirstName
- LastName
- CompletionDate
- Address1
- Address2
- City
- Postcode
- Country
- Longitude
- Latitude
- AdvisorName
- OrganisationLevel1
- OrganisationLevel2
- OrganisationLevel3
- OrganisationLevel4
- OrganisationLevel5
- ReportIdentifier
- GroupName
- CustomerType
- Rating (overall)
- Score (overall)
- RatingText (overall)
- RatingColour (overall)
- CustomQuestionResponse1 -10 (You can get the answers to 10 specified questions)
- AnswerText (either the answer selected or the text entered depending on the answer type)
- AnswerScore
- QuestionPath (Sn SSn Qnn)
- QuestionText
- Dashboard URL (uses the dashboard specified in the Individual Email Results field on the Feedback tab of the Assessment settings.)
- Reports (1 and above depending on the number of individual assessment reports available on the Feedback tab of the Assessment settings.)
- Report Details Text (C=Completion, I=Interim)
- Report Details Name
- Report Details ID Unique Identifier
- Report Details Report URL (the URL to access the report for this reponse.
Step-by-Step Instructions
Below is a step-by-step example of setting up integration with Hubspot using Zapier. Zapier calls these integrations Zaps. The CRM is referenced only in the last few steps of the Zap- the majority of this example applies regardless of the system being integrated to.
- In Brilliant Assessments, if an API key exists in the field on the Settings screen copy it to your clipboard. If the field is empty, create an API key by clicking the + button.
- Sign up to Zapier at Zapier.com. To use the integration on an ongoing basis you will need to use at least the Starter plan ($20 pm) because you need a 3 step zap. You will be able to use that plan for other integrations as well though.
- Get access to the connector by following this link.
- Once that is installed go to the My Zaps page in Zapier, click "Create" and New Zap.
- Select to specify a trigger app.
- Search for and select Brilliant Assessments. Ensure that you select the Latest version.
- The only choice for the Trigger is To Get Completed Responses. This passes Zappier recently completed responses as a list. Click Save and Continue.
- You will then be invited to Connect to an account, click Sign In
- A new window will be displayed asking you to enter the API key. Paste in the API key from Step 1.
- Test the account and then Save and Continue
- Next, Choose the Setup Trigger option and enter the External ID for your Assessment - this is copied from the External ID on the Assessment Settings. IMPORTANT - just copy the Code, don't use the Copy URL option.
-
- Select a Test Response. The responses will only show you a Response ID of a completed response.
- Once the Response codes have been selected, we need to tell Zapier what to do with them - adding an Action Step. Once again Select Brilliant Assessments, latest version.
- The Only choice is to Get Response. This api passes all the details about a response, based on a specified response ID.
- The system will then list all of the fields you can pass to this API. For the Response ID, select the value from the previous API
- From the dropdown List - pick the Response ID. The test response ID is shown as a sample.
- Next, if you want the system to pass the result to any questions, enter the Question Path using the notation "Sn SSn Qn" In the example below, Section 1, SubSection 1, Question 10, 20 and 30. You can specify 10 questions that you want the answer available to pass to the integration app (in this case Hubspot).
- You can then test that part. The system will list all the data that is returned from the response. Note especially the results of any Question Paths you have specified - the Answer to the specified Question that the respondent selected should appear.
- Once you are happy with what the system is passing to your zap, add another Action to specify where the data is going.
- Search for the name of the App. In our example, Hubspot
- In our Example, HubSpot has different options. We want to Create or Update a contact. We recommend the equivalent in the upload you are doing to avoid duplicate records being created.
- If you are logged on to HubSpot it will pick up your HubSpot instance automatically. Otherwise, log on to HubSpot. All of the fields available to be populated with HubSpot are now listed. This includes any custom fields you have created in HubSpot. To choose the field to populate each value, select the field list.
- Once you have specified all the fields you can test the integration. Check the target application that the record has been created correctly.
Comments
0 comments
Please sign in to leave a comment.