Integration with Accredible

Published November 09, 2021
Modules
Difficulty

Industry

You can integrate a full-service digital credentialing solution, Accredible, with Synerise to issue digital certificates, diplomas, badges, and many other credentials to the users based on their profiles and activity in Synerise.

This use case presents the integration used for the purposes of user certification in Synerise. The workflows include sending data of users who reached a certification level in Synerise to Accredible in order to issue their certificate and badge.

Important: In this use case, we cover only the part of issuing the digital credentials.
Accredible integration
Accredible integration

Prerequisites


  • Access to Accredible.
  • If you want to trigger the workflow by occurrence of a custom event, you must add one in Synerise in Data Management > Events and implement it in your application. You can read more about adding events here.
  • Create a schema that stores the certification questions in Schema Builder.

Process


In this use case, you will go through the following steps:

  1. Create credentials in Accredible.
  2. Create a catalog.
  3. Create a workflow.
  4. Test your integration.

Create credentials in Accredible


In this part of the process, in your Accredible account, create a group of credentials.

Groups in Accredible
Groups in Accredible
Note: You can find the full documentation here.

A group receives a unique identifier.

ID of the group
ID of the group

Create a catalog


In this part of the process, prepare a CSV file that contains Accredible group identifier and Synerise ID of the certificate level. Next, create a catalog to which you import the file.

  1. Go to Data Management > Catalogs > Create new.
  2. Enter the name of the catalog.
    Important: Don’t use diacritical letters, underscores (_), and spaces.
  3. Click Import CSV.
    Warning for MacOS users
    If you prepared a CSV file in Excel, open it in a text editor to check whether commas are used as separators. If not, replace them with commas.
  4. Upload the file by clicking Upload file.
  5. In the Order key field, type the name of the column which values are treated as the key - syneriseID.
    Note: The value of syneriseID is the ID of the schema created as a part of prerequisites.
  6. Complete the process by clicking Import.
    Result:
    CSV file imported to catalog
    CSV file imported to catalog

Create a workflow


In this part of the process, create a workflow that is triggered by receiving a certification. Then, a request is sent to Accredible to issue credentials for the user who received the required score.

  1. In Synerise, go to Automation > Workflows > New workflow.

  2. Enter the name of the workflow.

  3. As the first node, add Profile Event. In the configuration of the node, select the event that triggers the workflow. In this use case, it’s a custom event - certification.acquired.

    Tip: If it suits your business scenario, you may use default Synerise events, or instead of Profile Event, you may use the Audience node to trigger the workflow for the selected group.

  4. Confirm the settings by clicking Apply.

  5. Add the Outgoing Integration node. In the configuration of the node:

    1. Select Custom and no authentication.
    2. Enter the name of the node.
    3. Enter the value of the name parameter that is sent in the webhook.response event.
    4. Select the POST method.
    5. In the URL field, enter https://api.accredible.com/v1/credentials
      Note: You can find more information about this endpoint here.
    6. In the Headers section, use the following headers:
      • Set Content-type to application/json.
      • Set Authorization to Token token=YOUR ACCREDIBLE API_KEY
    7. Enter the request body, you may reuse and modify the example request below according to your needs:
        
          {
              "credential": {
                  "recipient": {
                      "name": "{{ event.params.firstName }} {{ event.params.lastName }}",
                      "email": "{% customer email %}",
                  "group_id":"{% set key = event.params.certificationId %}{% catalogitem.certificationList(key) %}{% set object = catalog_result %}{{ object.get('accredibleid')}}{% endcatalogitem %}"
              }
          }}
              
      Note:

      The example request contains three Jinjava inserts:

      1. Customer’s name sourced from Profile Event node, read more about reusing information in nodes
      2. Customer’s email address according to the context
      3. Reference to the catalog column
        You can read more about inserts in Automation here.
    Configuration of the Outgoing Integration node
    Configuration of the Outgoing Integration node
    1. Confirm by clicking Apply.
  6. Add the End node.

  7. Click Save&Run.

Final configuration of the workflow
Final configuration of the workflow

Testing


  1. Use the API to send a test event and simulate a user completing a certification
  2. Open the Statistics tab available in your workflow.
  3. Click the Outgoing Integration node. If the Entered and Executed counters have incremented after you sent the test certification, your survey triggered the workflow and completed it.
  4. Go to the profile of the test user, look for the automation event. Double-click it to see the details. If the status parameter is 200, the workflow works.
Event generated on the customer's profile
Event generated on the customer's profile

You can use this webhook response to trigger further campaigns to the user as well as create analytical dashboards with clear information on how many users received their credentials.

Check the use case set up on the Synerise Demo workspace


You can check the configuration of use case in Synerise Demo workspace:

If you don’t have access to the Synerise Demo workspace, please leave your contact details in this form, and our representative will contact you shortly.

Read more


😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

Close modal icon Placeholder alt for modal to satisfy link checker