You are using an unsupported browser. Please update your browser to the latest version on or before July 31, 2020.
close
This article preview will expire in 30 minutes, after which it will no longer be accessible.
Home > Create and Manage Learning Products > Configuring BenchPrep Courses > Recognitions > Configuring Recognition Webhooks and Integrating with Credly
Configuring Recognition Webhooks and Integrating with Credly
print icon

After your recognition types are set up and your courses are published, you’ll be able to send recognition information to third party systems using webhooks. Whenever a learner is issued a recognition, it will trigger the corresponding webhook. For more information about webhooks, you can check out our articles here.

 

You’ll also be able to integrate your recognitions with Credly if you’d like your badges to display more information in the Learning Hub. To enable recognitions for a course in Learning Hub, check out our article here.

 

Creating a Recognition Issuance Webhook

To create a new webhook for your recognitions, follow the instructions in our Managing Webhooks article. If you’re using both Credit Units and Credly Badges, you will need to have two different webhooks. They should be configured according to the details below.


Creating a Webhook for Credit Units

  1. On the Webhook Details page, input the name, status, and destination URL of your webhook. Custom headers are not needed.
  2. On the Content Selection page, select Issuance of a Recognition as the trigger event type.
  3. Select your course and recognition. If all recognitions in the course should trigger the webhook, select Any Recognition.
  4. Select Default as the formatter.
    NOTE: If “Any Recognition” was selected as the recognition, all types of recognitions will be sent as a part of the webhook. If you only need information for Credit Units and not Credly Badges, the badge information will need to be filtered out by your external system after the data is sent from our platform.

 

Creating a Webhook for Credly Badges

  1. On the Webhook Details page, input the name, status, and destination URL of your webhook. The destination URL should be set as the following with your Organization ID:
    1. Production:
      https://api.credly.com/v1/organizations/<organization_id>/badges
    2. Integration/Staging:
      https://sandbox-api.credly.com/v1/organizations<organization_id>/badges
  2. Add the following custom header:
    1. Key: Authorization
    2. Value: The result from following the steps in Credly’s Web Service API
  3. On the Content Selection page, select Issuance of a Recognition as the trigger event type.
  4. Select your course and recognition. If all recognitions in the course should trigger the webhook, select Any Recognition.
  5. Select Credly as the formatter.
    NOTE: This will set the webhook to only send information related to Credly Badges.

After creating a webhook, test it out by earning the corresponding recognition in your course. Once earned, it will trigger the webhook and send that information to your external system. Ensure that your external system is receiving the data and that the data is correct.

 

Setting Up an Integration with Credly

To integrate your recognitions with Credly so that badge information is displayed in the Learning Hub, follow these steps:
 

  1. Navigate to Console, and click on Settings.
  2. Click on Integrations.
  3. Click on Add Integration.
  4. Select Credly Badge as the integration type.
  5. Input your Account Name, Org ID, and Authorization Token. The account name field can be a generic name for your integration. Org ID and Authorization Token can be found from your account with Credly.
  6. Click on Save.

Once the integration has been set up, your badges will now display information from Credly in the Learning Hub. To view a Credly badge, click on View Badge.

Feedback
0 out of 0 found this helpful

scroll to top icon