Configuring Skillable Lab Webhooks

Using Webhooks is an efficient way of receiving information from the Skillable platforms. Studio Webhooks can be configured to automatically send data when there is any change in the status of a Lab instance lifecycle as well as a change to a lab assignment or the Lab Profile itself.

The following sections will help guide you to effectively set up and use Webhooks in Skillable Studio.

Best Practices

Webhooks, like API endpoints, provide an easy method of retrieving data or notifications of events. Follow these best practices to get the most of your webhook configurations.

• Webhooks, unlike APIs, do not require a request. Configure the webhook to activate on the most appropriate event for the best results.
• Always ensure that the receiving URL is properly configured and available. If you receive an error when you navigate to the receiving URL you will not receive the webhook payload.
• Be careful when configuring the Delay, Timeout and Maximum Retries as this can cause confusion when multiple webhooks are configured or triggered at the same time.

Add a Skillable Studio Webhook

In Skillable Studio, Webhooks are tied directly to the API Consumer to which Lab Profiles are published to, enabling you to configure different webhooks for different labs in multiple scenarios. You can set up one or more Skillable Studio Webhooks for each API Consumer directly from the API Consumer details page in Studio.

1. From the Site Administration page on the Integration tile, select API Consumers.

   

2. Search for the specific API Consumer that you wish to configure Webhooks for.

3. To open the API Consumer details page, select the API Consumer name, or , from the list.

4. In order to add a new Webhook, scroll down the Webhooks section, beneath the LTI section, and select + Add Webhook.

   Section availability

   If this section is not available to you, please open a support ticket to have additional permissions aaded to your user account to be able to configure webhooks.

   

5. Use the next section Setting up your Studio Webhook to complete the fields in the Add Webhook dialog.

6. To save your webhook select OK.

   Example Webhook configuration:

   

Setting up your Studio Webhook

Once you have opened the Add Webhook dialog there are a number of fields that can be configured. The following table describes each field in detail.

Sending Lab Details as the Content Body JSON

When selecting the Send Lab Details as Content Body option, the content body of your webhook response will contain JSON-formatted information about the lab instance including the following fields.

This is an example of a JSON-formatted content-body containing the results of selecting the Send Lab Details as Content Body field.

{
    "Id": 998592321,  
    "UserId": 5023932,  
    "UserExternalId": "Example.User",  
    "UserFirstName": "Example",  
    "UserLastName": "User",  
    "LabProfileId": 19376,  
    "LabProfileName": "Example Lab",  
    "LabProfileNumber": "ABC",  
    "LabSeriesId": 10296,  
    "LabSeriesName": "Example Series",  
    "ClassId": null,  
    "ClassExternalId": null,  
    "ClassName": null,  
    "Start": 1671565852,  
    "End": null,  
    "Expires": 1671587452,  
    "LastActivity": null,  
    "LastSave": null,  
    "State": 20,  
    "CompletionStatus": 2,  
    "CustomData": null,  
    "ExamPassed": null,  
    "ExamScore": null,  
    "ExamMaxPossibleScore": 10,  
    "ExamPassingScore": 7  
}

Skillable Studio Webhook Events

Webhooks are an event-driven activity. This means that virtually any event or change in an application could be used to develop a Webhook. However, the list of possibilities could quickly become cumbersome. Therefore, Skillable has targeted the following specific events for webhooks and is always considering additions to this list.