Quick Start

Set up badge issuing for your Open edX instance with Credly or Accredible. By the end of this guide you will have a working badge template that awards badges to learners automatically.

1. Prerequisites and installation

The Credentials service must be installed and running on your Open edX instance.

Option A: Using Tutor (recommended)

1. Install the tutor-credentials plugin (provides the Credentials service):

   pip install tutor-credentials
   

2. Install the tutor-contrib-badges plugin (configures badge settings, event bus, and feature flags automatically):

   pip install git+https://github.com/raccoongang/tutor-contrib-badges@main
   

   See the tutor-contrib-badges README for additional details, including a sample Pipfile and manual service commands.

3. Enable the necessary plugins:

   tutor plugins enable discovery mfe credentials badges
   

4. Rebuild images and launch:

   tutor images build openedx discovery credentials
   tutor local launch
   

The plugin automatically enables badge feature flags, configures the event bus, and registers the following consumer services:

• credentials-eventbus-consumer

• credentials-certificates-eventbus-consumer

• lms-eventbus-consumer

• cms-eventbus-consumer

Option B: Other installations

1. Install the Credentials service following the Getting Started guide.

2. Enable badges in both services:

   # openedx-platform (LMS) settings:
   FEATURES["BADGES_ENABLED"] = True
   
   # Credentials service settings:
   BADGES_ENABLED = True
   

3. Configure the event bus and consumer processes. See Badging Settings for the full reference:

   • Event Bus Configuration - producer signals for LMS and Credentials.

   • Consumer Setup - running the consume_events management command.

2. Configure integration

Set up your provider account and connect it to the Credentials admin panel for your instance.

For Credly:

1. Register on Credly and create your organization.

2. Create at least one badge template and publish it.

3. Retrieve your organization UUID and API key.

4. In the Credentials admin panel, navigate to https://<your-credentials-host>/admin/badges/credlyorganization/ and add a new organization.

   1. Set the UUID to your Credly organization identifier.

   2. Set the API key used to authenticate with the Credly organization.

   

5. Verify the system pulls the organization’s data and updates its name.

For Accredible:

1. Register on Accredible and create your account.

2. Create at least one group.

3. Retrieve your API key from account settings.

4. In the Credentials admin panel, navigate to https://<your-credentials-host>/admin/badges/accredibleapiconfig/ and add a new configuration.

   1. Set the API key from your Accredible account.

   2. Set a name for the configuration.

   

See also

Credly

Credly Configuration

Full Credly setup, webhooks, and synchronization details.

Credly Authentication Methods

How to authenticate with the Credly API.

Auth Tokens for Authorization

How to generate and manage Credly auth tokens.

Accredible

Accredible Configuration

Full Accredible setup and synchronization details.

How Do I Find My Integration API Key?

Finding your Accredible API key for integration setup.

3. Synchronize badge templates

Synchronization imports badge templates from your provider into the Credentials service.

For Credly:

1. Navigate to https://<your-credentials-host>/admin/badges/credlyorganization/ and select the organization(s) you want to use.

2. Run the Sync organization badge templates action.

   

3. Navigate to https://<your-credentials-host>/admin/badges/credlybadgetemplate/ and verify the newly created templates.

See Credly Configuration for details on template synchronization and webhook setup.

For Accredible:

1. Navigate to https://<your-credentials-host>/admin/badges/accredibleapiconfig/ and select the configuration(s) you want to use.

2. Run the Sync groups action.

   

3. Navigate to https://<your-credentials-host>/admin/badges/accrediblegroup/ and verify the newly created groups.

See Accredible Configuration for details on group synchronization.

4. Set up badge requirements

Requirements define what must happen for a learner to earn a badge. At least one requirement must be associated with a badge template.

In the Credentials admin panel, open the badge template or group record you want to configure from https://<your-credentials-host>/admin/badges/credlybadgetemplate/ or https://<your-credentials-host>/admin/badges/accrediblegroup/:

1. Find the “Badge Requirements” section.

2. Add a new item and select an event type (what is expected to happen).

   • Optionally, add a description.

3. Save and navigate to the requirement detail page by using the Change link in the inline requirements list. Requirement detail pages use the admin URL pattern https://<your-credentials-host>/admin/badges/badgerequirement/<id>/change/.

   • Optionally, specify data rules in the “Data Rules” section:

     1. Select a key path (specific data element).

     2. Select an operator (how to compare the value).

     3. Enter a value (expected parameter’s value).

A badge template can have more than one requirement. For example, a badge template issued on a specific course completion:

• Requirement 1:

  • event type: org.openedx.learning.course.passing.status.updated.v1

  • description: On the Demo course completion.

• Data rule 1:

  • key path: course.course_key

  • operator: "=" (equals)

  • value: course-v1:OpenedX+DemoX+Demo_Course

• Data rule 2:

  • key path: is_passing

  • operator: "=" (equals)

  • value: true

See also

Badge Requirements

Full reference for badge requirements.

Data Rules

Full reference for data rules.

5. Activate badge templates

1. Navigate to https://<your-credentials-host>/admin/badges/credlybadgetemplate/ or https://<your-credentials-host>/admin/badges/accrediblegroup/.

   

2. Open the badge template or group detail page and check the Is active checkbox.

   

3. Click Save at the bottom of the page to save and activate the configuration.

Warning

Changing configuration of active badge templates may cause inconsistent learner experience.

See also

Activation and Deactivation

Full reference for badge template activation.