Webhooks

By using webhooks, Coursepath can automatically trigger your application when important events happen.

In your academy under Setup > Webhook, define your Webhook endpoint URL and subscribe to the events you would like to be notified about. Your endpoint must support SSL/HTTPS.

When something happens, we POST a good old application/x-www-form-urlencoded form, containing the parameters as described below.

In most cases, Coursepath will only attempt to call your server once. If your server is temporarily unavailable, we will not try again. Therefore, it is good practice to not rely solely on webhooks for data synchronization. You'll also want to implement a script that proactively retrieves data from our API.

Events

Member enrolls in a course

When a member (self)enrolls in, or is assigned to a course, we POST to your endpoint URL:

courseId={courseId}&memberId={memberId}&event=COURSEMEMBER_CREATED

Member completed a course

When a learner has completed a course (regardless of their success), we POST to your endpoint URL:

courseId={courseId}&memberId={memberId}&event=COURSEMEMBER_COMPLETED

Then you could call Course API endpoint GET /api/v1/courses/{courseId}/members/{memberId}/coursemember to fetch information about the learner's result, such as score, success and the certificate.

Member removed from a course

When a member is removed form a course, we POST to your endpoint URL:

courseId={courseId}&memberId={memberId}&event=COURSEMEMBER_DELETED