Skip to main content
LearnInk uses webhooks to notify your application in real time when something happens in your organisation — for example, when a user registers, completes a course, or earns a certificate. Rather than polling the LearnInk API for updates, your backend receives an HTTP POST request the moment an event occurs.

​
When you need webhooks

Webhooks are useful any time you want to react to learning activity in your own systems. Common use cases include:
  • Push notifications — If you’re using the WebView integration, LearnInk uses webhooks to deliver push notification triggers. Your backend should receive these and forward them to users via your own notification infrastructure. This is the most critical webhook use case for WebView customers.
  • Progress tracking — Record course completions or certificate awards in your own database
  • Automations — Trigger downstream workflows when users hit milestones (e.g. unlock content, update a CRM record)
  • Compliance reporting — Log training completion events for audit purposes

​
How it works

  1. An event occurs in LearnInk (e.g. a user completes a course)
  2. LearnInk creates an event object and sends it as an HTTP POST to your registered endpoint URL
  3. Your endpoint processes the event and returns a 200 response to acknowledge receipt
  4. If no 200 is returned, LearnInk retries delivery on a fixed schedule
LearnInk uses Svix to manage webhook delivery, which provides built-in retries, signature verification, and a delivery log in the dashboard.

​
Event structure

Every webhook payload follows the same structure: 
{
  "object": "event",
  "type": "user.course.started",
  "api_version": "2022-11-15",
  "data": { ... },
  "timestamp": "2022-11-04T09:58:58.233Z"
}
The type field identifies the event. The data object contains the relevant details — its shape varies by event type. A full Event Catalog with every available event, its payload schema, and example data is available inside the LearnInk admin dashboard under Settings → Developers → Webhook.
The timestamp field reflects when the event occurred, not when it was delivered. Users in offline mode have events queued and delivered when they reconnect — your backend may receive events from several days ago if a user has been offline for an extended period.

​
Ready to set up your webhook?

Step-by-step setup guide

Follow the four-step guide to create your endpoint, test it in staging, and register it in production.

​
The two event categories

There are two key categories of events you can subscribe to:

​
1. Notifications events

The notifications.sent event contains an array of push notification payloads to be forwarded to users. These are generated by both scheduled training reminders and manual notifications sent from the LearnInk dashboard. If you’re using the WebView integration, subscribing to this event and forwarding the notifications to users is essential — the WebView cannot receive notifications any other way. See the Push notifications guide for full details on how to handle this event.

​
2. User events

User events fire on key actions — for example, when a user registers for the first time, starts a course, or completes a course. These are useful for deeper integration: recording progress in your own systems, triggering downstream workflows, or building compliance reports. The full list of available user events is in the Event Catalog in the LearnInk admin dashboard under Settings → Developers → Webhook.