Credly Acclaim Integration

Owned by Seth Petry-Johnson
Last updated: Oct 29, 2024 by Steve Ross
3 min read

Overview

Credly Acclaim is a digital badging platform. LearningBuilder can issue and replace/update badges for Practitioners when they achieve various milestones.

Supported features

  • Badges are defined through the Credly site

  • Badges are issued via LearningBuilder’s Workflow engine

  • Expiration dates can be configured in LearningBuilder

  • License Numbers (or other data) can be attached to the badge as “ID Evidence”

  • Email notifications from Credly to the earner can be optionally sent

Limitation:

Credly uses email as a the identifier as to who owns the badge. As such it does not support email changes on issued badges that have been claimed. If an email does need to be updated prior to a claim, the client admin can go into Credly and change the email directly.  If the badge recipient wants the badge associated with a different email after it's claimed, they just need to merge accounts in Credly, or add a new email to the existing Credly account and make it primary. See Can I add multiple emails to my account? for more details. Future badge notifications will then go to the new email. Email changes in LearningBuilder will never be reflected in Credly.

Configuring the Credly integration

1

Create a Badge Template in Credly’s system

In the Credly system, create a Badge Template.

image-20240429-141854.png
Creating a Badge Template in Credly
2

Record the Organization and Template IDs

Once the Badge Template is created, click on the “Developers” link in the sidebar and make note of the Organization Id and Template Id values that were assigned by Credly.

image-20240429-142740.png
Obtaining the IDs needed for the integration
3

Generate a Credly authorization token

Under the “Developers” section in Credly, click on “Authorization Tokens” and generate a new token.

Make a note of its value.

4

Configure the API Endpoint credentials

This step requires System Administrator access in LearningBuilder.

In Sys Admin → App Config, edit the RestApiEndpoints setting and define a Credly endpoint. (See the REST API Endpoints docs)

The URL contains the Organization Id, the username is the Auth Token, and the password is irrelevant. (See the purple section below)

For more info, see Credly’s web service authentication docs

{ "Name": "CredlyAcclaim", "Url": "https://api.credly.com/v1/organizations/{OrganizationId}/badges", "BasicAuthUsername": "{AuthToken}", "BasicAuthPassword": "CREDLY", "HttpMethod": "POST", "Headers": { "Content-Type": "application/json" } }
5

Configure a System Template to manage the API payload

6

Configure a Workflow Attribute to hold the Badge Template Id

If you will be issuing the badge as part of a Complete Learning Plan Workflow, then use the Configure Learning Plan Workflow to enter the Badge Template Id for each Learning Plan.

If you plan to also issue badges from the Member Role Workflow, then instead consider creating a Template attribute on the Member Role so store the Badge Template Id so it can be shared with the Complete Learning Plan Workflow.

If you will be issuing the badge as part of a Complete Activity Workflow, then use the Create Activity Workflow to enter the Badge Template Id at the Activity Definition level.

7

Configure a Workflow Behavior to issue the badge

Use the Issue or Replace Credly Badge Behavior to issue a badge at the appropriate place in your Workflow.