Webhooks
Webhooks are outgoing HTTP POST notifications from Knowspread to a client endpoint. They are useful when the client does not want to poll the REST API.
Events
Section titled “Events”The current model includes:
| Event | When it makes sense |
|---|---|
content_assignment_created | A user received a new study task. |
content_assignment_completed | A user completed assigned content. |
content_assignment_overdue | Assigned content is overdue. |
test_attempt_completed | A user completed a test attempt. |
Endpoint settings
Section titled “Endpoint settings”Webhook settings belong to a company space and include:
endpoint_url,auth_type,- optional secret for payload signing,
- configuration data for OAuth2.
Endpoint URL must use HTTPS.
Authentication
Section titled “Authentication”Supported modes:
- no authentication,
- Basic Auth,
- OAuth2 client credentials.
If a secret is set, the client should verify the payload signature from the raw request body. This helps detect whether the payload changed in transit.