Academy LMS 4.0 IS LIVE

00
Days
:
00
Hours
:
00
Minute
:
00
Second

Webhooks

The Webhooks add-on connects Academy LMS to other apps. It can send events out to an external URL when things happen in your LMS, or (with Pro) accept incoming requests from apps like Zapier and Make to trigger LMS actions.

Before you start

WebHook Addon activation

Go to Academy → Add-ons, find Webhooks, and turn it on. This adds a new Webhooks menu item to the Academy LMS sidebar.

Step 1: Add a new webhook

Add new webhook

Go to Academy LMS → Webhooks and click Add New Webhook. Fill in:

1.Webhook Type: choose Outgoing to send events out to an external URL. Incoming is a Pro feature for receiving calls into Academy from Zapier, Make and custom apps, to automate account creation, enrollment, or course completion.
2.Events Type: pick one or more events to send data about.

Step 2: Choose the events

Click the Events Type field to see the full list, including:

Click on Event
Course Publish, Course Completed
Lesson Publish, Lesson Completed
New Enroll
New Student Registration, New instructor Registration
New Course Review
New Question in a Course, New Reply to a question in a Course
Quiz Publish, Quiz Completed, and the three Quiz Attempt Status events (Pending, Failed, Passed)
Announcement Publish

If the matching add-on is active, more events appear: Assignment Publish, Submitted Assignment, Evaluate Submitted Assignment and Assignment Completed (Assignments), Zoom Publish and Zoom Completed (Zoom), Tutor Booking Published, Booked, Completed and Review (Tutor Booking), and Course Bundle Publish (Course Bundle).

Step 3: Set the delivery URL and status

Enter the delivery URL

Enter the Delivery URL where you want to send data, and an optional Secret to verify the data wasn’t tampered with in transit.

Set to publish

Set Status to Publish to make the webhook active. Only Publish status webhooks trigger their selected events, a webhook left as Private never fires even with events selected. Click Add Webhook to save.

Incoming Webhooks

Switching Webhook Type to Incoming gives Academy its own endpoint that other apps can call to trigger actions here, for example creating a student account from a CRM or checkout, enrolling a student when an external system says so, or marking a course complete from another platform. This is a Pro feature; the Free plan can still select it to see what it offers, but needs Academy Pro active to configure and use it.

Add new webhook

Go to Incoming tab to create a incoming webhook. Click on Add New Webhook.

Add details to webhook.

To configure add:

Endpoint Name: To clarify that what will be the webhook endpoint name.
Action: To set that what will happen when this webhook will fire.
Authentication: To set that what type of authentication will be needed for this

Set the Webhook status to publish.

Incoming webhook status to publish