Skip to content

Set up webhooks

Have Linqur send a message to your own system as soon as something happens on your platform.

Webhooks are an optional feature. Contact sales@linqur.com for access.

A webhook is a message that Linqur sends to a URL of your own when an event happens, for example when a user enrols in a course or completes it. Your own system, or a tool such as Make or n8n, can use that message to start an automation.

Video: setting up webhooks in Linqur (1:06)

Before you start

You need a URL that receives the messages. Make and n8n give you one when you add a webhook trigger. How that works on their side is explained in our blogs Build Smart E-Learning Automations with Linqur & Make and Automating E-Learning with Linqur and n8n.

The Webhooks screen

Click Configuration in the side menu and then the Webhooks tab. The Configuration tab starts with three blocks:

  • Marketing Webhook (1): for learners who opt in to marketing when they register.
  • Default Webhook (2): one URL for all events.
  • Webhook Authentication (3): the Bearer token for your receiving system.

The Webhooks screen with the Marketing Webhook, the Default Webhook and Webhook Authentication highlighted

Below these blocks you find the events. Each event has a status icon (1), a Custom endpoint (optional) field (2), a check mark to save (3) and a Test button (4).

The first events in the list with the status icon, the URL field, the check mark and the Test button highlighted

One URL for everything, or one per event

You wantDo this
All events on one URLFill in the Default Webhook.
A separate URL for one eventFill in Custom endpoint (optional) next to that event.

An event without a URL of its own goes to the Default Webhook. If an event has no URL of its own and there is no Default Webhook either, the event stays off.

Step by step

1. Paste the URL

Paste the URL of your receiving system in Custom endpoint (optional) next to the event, in this example Course Completed. For all events at once, paste it under Default Webhook.

The Course Completed event with a URL in the Custom endpoint field

2. Save with the check mark

Click the check mark next to the field. There is no general save button: every field has its own check mark. Linqur shows Webhook endpoint updated (3) and the status icon turns green (1).

Course Completed with a green status icon, the saved URL and the notification Webhook endpoint updated

3. Send a test

Click Test (1) in the same row. Linqur sends a test message to the URL and shows a notification (2). The Test button only works once a URL is saved for that event.

The Test button of Course Completed and the notification after the test

The test message is a POST request with a JSON body. It contains sample data, not the data of a real learner. This is what our receiving URL got after a test of Course Completed:

{
  "event": "core_event_course_completed",
  "data": {
    "test": true,
    "timestamp": 1793304056
  }
}

Which fields a real event sends depends on the event. You can see them in the Logbook with Show data (see below).

4. Check the Logbook

Click the Logbook tab (1). The table shows webhook activity with the columns Timestamp, Event Name, User ID and Data. Click Show data (4) to see the data of a call. Filter with the Custom Search Builder (2) or the search field, and export the list with Excel or PDF (3).

The Logbook tab with the Custom Search Builder, the export buttons and the Show data button highlighted

A test with the Test button does not appear in the Logbook.

The events

EventTechnical nameWhen
Marketing WebhookA user opts in to marketing when registering. This block has no Test button.
User Enrolled in Coursecore_event_user_enrolment_createdA user is enrolled in a course.
User Logged Incore_event_user_loggedinA user logs in to Linqur.
User Account Createdcore_event_user_createdA new user is created in Linqur.
Course Completedcore_event_course_completedA user completes a course. Includes the grade if there is one.
Course Viewedcore_event_course_viewedA user views a course.
User Enrolment Updatedcore_event_user_enrolment_updatedAn enrolment of a user is updated.
TinCan Activity Completedmod_tincanlaunch_event_activity_completedAn xAPI (TinCan) activity is marked as completed.
Activity Completedcore_event_course_module_completion_updatedA user completes an activity.

The opt-in for marketing comes from the optional policy that learners see when they sign up. How to set it up is explained in set up sign-up policies. More about xAPI activities: add an xAPI activity.

Check requests with the Bearer token

Under Webhook Authentication you find a Bearer token. Your receiving system uses it to check that a request really comes from your Linqur platform. Click the eye to show the token.

Treat the Bearer token like a password. Don’t share it and keep it out of screenshots.

Good to know

  • User Logged In and Course Viewed can trigger a lot of calls. Only turn them on if you need them.
  • To stop a webhook, clear the field and click the check mark. Linqur shows Webhook endpoint empty, endpoint disabled (3) and the status icon turns red (1).

Course Completed with an empty field, a red status icon and the notification Webhook endpoint empty, endpoint disabled

Next step

Last updated on