Home | API reference

Configuring a compatibility integration

PublicAPI endpoints

Accessing the PublicAPI endpoints requires the use of client credentials.

Information is available at Bracken docs:

• Information on OAuth 2.0
• How to get an Access Token

Legacy REST endpoints

The supported Legacy REST endpoints have different authorization mechanisms depending on the call.

Legacy webhook endpoints

To use a Legacy webhook endpoint, contact hello@brackenlearning.com to add the domain credentials to the compatibility API. These are needed for transforming the webhook.

Registering a webhook

Use the standard Public API to register the webhook:

PUT /api/webhook/merge/domain/<domainkey>/event/<eventname>

Query parameters

Property	Sample value
domainkey	15435
eventname	User_Create, User_Delete, Module_Start, Module_Complete

Query body

Property	Sample value
target	https://compat-api.brackenserver.net/webhook/passthrough?target=https%3a%2f%2fwebhook.site%2f...
secret	8ke3...
active	true

Login requests

Domains making login requests using LTI via the compatibility API need to be configured in Bracken identity server. Please contact hello@brackenlearning.com.