You are using an unsupported browser. Please update your browser to the latest version on or before July 31, 2020.
close
You are viewing the article in preview mode. It is not live at the moment.
Our offices will be closed from Tuesday, December 24th through Wednesday, January 1st. We will reopen on Thursday, January 2nd. During this time, we will continue to monitor and handle critical support items, but responses to most tickets and inquiries will likely be delayed.
1. Intro to Webhooks
print icon

The BenchPrep platform supports the creation and use of outbound webhooks. Webhooks enable the automatic and instant delivery of learner data to other critical business apps and systems - unlocking the ability to instantly update learner records, issue digital credentials, trigger marketing communications, and more.

 

A webhook (also called a web callback or HTTP push API) is a way for an application to deliver other applications real-time data. Unlike a typical API, where you need to fetch data manually, webhooks deliver data to other applications immediately after a defined “trigger event” occurs. A webhook delivery is an HTTP POST containing a payload with data about the trigger event. 

 

Using Console, you can set up webhooks to deliver information from BenchPrep to another database or application whenever a certain event occurs. These events include: 
 

  • When a user completes a Study Task
  • When a user completes a Study Plan
  • When a user starts an exam
  • When a user completes an exam
  • When a user creates a custom score of an exam
  • When a user completes an external package
  • When a user completes an asset-based course 
  • When a user earns a course completion certificate
  • When a user completes a milestone

During the webhook creation process, you will define the destination for data delivered by webhooks. The destination should be a URL for the receiving application’s endpoint. It is likely you’ll need to set up a custom endpoint to receive webhooks from BenchPrep–we strongly recommend engaging an engineer or technical resource from your organization to help you with this process.

 

Benefits of Webhook configuration 

The automation webhooks offer has benefits across several different scenarios. 

 

Real-Time Reporting: Let’s say you want to ensure your CRM or AMS is synchronized with the BenchPrep platform, so that both show the same up-to-date learner activity data. Set up BenchPrep webhooks to send learner activity data from BenchPrep to your CRM/AMS, and you can automate the process of keeping these systems in sync and up-to-date. No matter which site your learners are using, they’ll see consistent data. 

 

Sample Configuration: 

  • Trigger Event: User completes a Study Task 

  • Data Destination: AMS (i.e. Fonteva, iMIS, etc.) or CRM (i.e. Salesforce, Zoho, etc.) 

  • Data Delivered: User info, course, completion data, status, etc. 
     

Learner Engagement & Marketing: Let’s say you want to drive learner engagement and upsell opportunities through targeted, automated marketing communications. You can set up a BenchPrep webhook to send learner activity data to your marketing automation tool whenever a learner completes a particular course or exam. Then, use the marketing tool to set up email templates and automation rules. Whenever a learner completes the content that triggers the webhook, they’ll receive timely, targeted communications (“Congrats on completing X, now try Y”) from your organization. 

 

Sample Configuration: 

  • Trigger Event: User completes a course 
  • Data Destination: Email/Marketing Solution (Marketo, Hubspot, Intercom, etc.) 
  • Data Delivered: User info, course, completion date, status, etc. 
     

Issuing Credentials: Let’s say you’re offering a course that, if the learner completes a final exam, awards them a digital credential. You can set up a BenchPrep webhook to send learner activity data to your digital credentialing solution whenever a learner completes that exam. Then, use the credentialing solution to set up rules so that it issues a credential upon receipt of the webhook. Instead of the learner having to verify their results and wait to receive their credential, they’ll receive their credential instantly. 

Sample Configuration: 

  • Trigger Event: User completes a test 
  • Data Destination: Digital Credentialing Solution (Credly, Accredible, Badgr, etc.)
  • Data Delivered: User info, course, completion date, status, etc. 
     

Who Can Set Up Webhooks? 

Webhooks are an add-on to BenchPrep’s core product. If you’re interested in using webhooks, reach out to your BenchPrep contact, who can provide you pricing and other information. 
After BenchPrep has enabled webhooks for your tenant, any Console Admin can create and manage webhooks via the Settings section of Console. Little to no technical expertise is required for these steps. If there are team members you want to manage webhooks only, you can create and assign this user a custom role with the following permissions:
 

  • read:webhooks
  • create:webhooks
  • update:webhooks 

Feedback
0 out of 0 found this helpful

scroll to top icon