Webhooks

Webhooks

Overview

Using our rules engine, you can configure our platform to call a third-party API whenever a particular event occurs. For example, you can tell the platform to call an API on your own servers whenever a student completes a particular course.

Please note that our webhook's header content-type is "application/x-www-form-urlencoded", if your endpoint is configured to accept only "application/json", then the request will fail.

Creating

To activate Webhooks, first install them from the App Center.

Then a new "" option will appear whenever you add a rule action. You can add rules for courses, groups, modules, sections, assignments, and accounts. For more details, visit the Rules topic.

A requires an endpoint and parameters, which will be invoked using an HTTP POST. The endpoint can be HTTP or HTTPS. The parameters can accept variables of the form @xxx, just like our message templates.

Webhook jobs allow a full 10 seconds for a webhook to respond to the call from our job servers. If the server that is called by a webhook does not respond within 10 seconds, the connection will terminate with the remote service, wait for five seconds, then attempt to invoke the webhook again. The system will repeat this retry logic up to 10 times, doubling the delay each time (5s, 10s, 20s, 40s, 80s, etc.) before registering the entire operation as failed due to timeout.

Webhooks widget

Administrators can add the webhooks widget to the admin dashboard. To add the widget go to the dashboard and click the "Edit widgets" button.

Then select "Center Panel" from the pop-up.

From the "Available widgets" area you can add the Webhooks widget to the center panel using drag-and-drop, then click Save.

The Webhooks widget shows the number of webhook calls and the number of errors.

To learn more about dashboard widgets visit the Widgets topic.


    • Related Articles

    • Best practices for administrators

      Overview Here are some best practices that we recommend for administrators. Choose a short URL We recommend that you keep your URL short, ideally less than 10 characters long. For example, if your company is called "The Academy of Digital ...

    • Networks

      Overview You can organize businesses into a network, which is a great way for members of the businesses to collaborate, share resources, and teach/enroll in each other's courses. Each network has a description, one or more member businesses, one or ...

    • Passwords

      Overview For security reasons every user has a User ID (3+ characters) and a Password (5+ characters). They can log in with their credentials or they can use the available SSO options if it is enabled. Add password When users sign up and create ...

    • API

      Overview CYPHER Learning’s API allows you to integrate your learning platform with third party tools and systems that help elevate your user’s experience. The CYPHER API is the intermediary between the features of our LMS and your website or ...

    • Teams

      Overview Teams is a feature that allows you to mirror your corporate hierarchy and provide a way to define a reporting and management structure. The Teams feature is disabled by default since it only generally applies to large businesses. To start ...