Subscribe to Events

Apps can subscribe to all the Caliper events generated by StudyReel for their app via a webhook, such as Composite Attempt events, Tool Use events, and SpeedBump events. These subscriptions allow apps to monitor user behavior, time on tasks, and identify patterns that could benefit from targeted interventions.

To subscribe, use the following endpoint:

HTTP Method: POST

Base Production URL: https://prod-studyreel.alpha1edtech.com/

Base Staging URL: https://studyreel.alpha1edtech.com/

Endpoint URL: /webhooks/register

Headers

Name	Value
Content-Type	application/json
x-api-key	<your-api-key>

Body

Name	Required	Description
toolId		Your toolId received in your tool registration response
url		The URL where you want StudyReel to send the caliper events to
active		Flag to enable/disable the webhook

Response

201

{
  "id": "a970544d-f91e-4dcb-81ce-2793dd4ad960",
  "toolId": "6e55fa37-66d5-4bd7-868a-4c41d3ed427f",
  "url": "https://0f38-2401-4900-8819-2ce3-b022-3018-be73-35b6.ngrok-free.app",
  "active": true,
  "created_at": "2024-10-09T18:09:36.680Z",
  "updated_at": "2024-10-09T18:09:36.680Z"
}

400

401

500