See Configuring a compatibility integration for information about setting up compatibility webhooks.
Compatibility endpoint that receives and transforms webhooks. The Bracken webhooks should be configured to use this endpoint.
| Parameter | Notes |
|---|---|
secret |
Set to domain Client Secret. |
target |
The parameter must be URL-encoded. |
This forwards the received webhook to the specified target without change.
| Parameter | Sample value | Description |
|---|---|---|
transform |
passthrough | Specifies the data transform to apply. |
target |
https://webhook.site/... | URL-encoded target URL to receive the transformed webhook. |
A Vault-style webhook can be configured for the Module_Complete event.
| Parameter | Sample value | Description |
|---|---|---|
eventname |
Module_Complete | |
transform |
vault | |
target |
https://token.vaultgrc.com/bracken.php | Check address with Vault. |
The parameters passed to Vault (all as strings) are:
| Property | Sample value | Description |
|---|---|---|
username |
testuser | Registered username. |
joincode |
17435 | Identifier of lesson that was completed.ยน |
mark |
0 | The value is not used. |
passed |
true | Value indicating that the lesson was passed. |
certificate |
URL where the certificate can be retrieved, if any. |
Notes:
joincode was formerly an alphanumeric code.A Liquigas style webhook to send emails for Module_Complete or
Course_Complete events.
| Parameter | Sample value | Description |
|---|---|---|
eventName |
Course_Complete | |
transform |
liquigas | Uses the emailevent-liquigas.html template. |
target |
info@me.com,(user) | Comma-separated list, plus (user) to send to the user who completed the content. |
This forwards the webhook to the configured LTI (e.g. Moodle) Gradebook and Assessment service.
The LTI platform must be configured as an LTI external scheme, and the lesson launched with a Resource Link Request.
| Parameter | Sample value | Description |
|---|---|---|
eventname |
Module_Complete | |
transform |
lti-ags | |
target |
http://moodle.container.work | Match the scheme of the LTI external provider. |
The server makes a request to the LTI platform to obtain an access token, then uses this to update the lineitem score based on the Bracken webhook.
This creates an email and sends it to the configured recipients for supported webhooks:
| Parameter | Sample value | Description |
|---|---|---|
eventname |
User_Create, Module_Complete, Course_Complete | |
transform |
||
target |
sam@me.com,kim@me.com | Comma-separated list of email recipients. |
List recent webhook transformations.
| Property | Sample value | Description |
|---|---|---|
x-client-id |
demo | Domain name of webhooks to list. |
x-client-secret |
Eb3X... | Secret to access client credentials. |
An array of log strings containing the signature and original webhook data as received before transformation.
The log will also include error messages if there is a problem processing the data.