Webhook Integrations

What is a Webhook? #

A webhook is used for event-driven integrations and is one of the many ways applications can communicate with each other. They allow you to send real-time data from one system to another when a given event occurs.

— Referenced from https://cyclr.com/blog/what-is-a-webhook

NOTE: To utilize direct integrations, you or your web developer must understand how to listen for REST Webhooks. Alternatively, you can use Zapier to create integrations with your assessments without coding.

 

Send Notifications via REST Webhooks #

With AdvancedPrivate Label, and Enterprise plans, you can automatically send a notification to your website or a third party tool anytime someone takes your assessment.

To set up these notifications, edit your assessment and go to the “Results” tab. In the “Results Setup” section, enter the URL of your endpoint:

Custom Webhook URL Example

Data Structure Formats #

The results will be sent to that URL as JSON-structured data when your assessment is completed.

Simple Assessments #

Here is the data structure for Simple assessments:

{  
"name":"Test Respondent",
"first_name":"Test",
"last_name":"Respondent",
"email":"[email protected]",
"group":null,
"assessment_title":"Example Assessment",
"date":"2019-03-29",
"time":"20:35:38",
"datetime":"2019-03-29T20:35:38+00:00",
"Score":13,
"pdf_report":null
}

Type and Multi-Type Assessments #

Here is the data structure for Type and Multi-type assessments:

{  
"name":"Test Respondent",
"first_name":"Test",
"last_name":"Respondent",
"email":"[email protected]",
"group":null,
"assessment_title":"Example Assessment",
"date":"2019-03-29",
"time":"20:35:38",
"datetime":"2019-03-29T20:35:38+00:00",
"Type One":13,
"Type Two":10,
"Type Three":6,
"total_score":29,
"high_scoring_types":"Type One",
"pdf_report":null
}

Send PDF Report #

If you choose to generate a PDF in your results setup, the URL to the PDF for this result will be included in the “pdf_report” field.

Send Responses to Individual Questions #

Additionally, suppose you’ve provided an identifier for any of your questions. In that case, the text of the response to that question will be included in the POST data, with the field name equal to the identifier you set. You can read more about how that works here.

Please review the rest of the User Guide to learn more about our software.

Thank you for choosing Assessment Generator!

Powered by BetterDocs