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.

Info
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.

Installing the Webhooks app

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

Webhooks actions

Then a new "Webhooks" 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.

After select to add a Webhook action, the Webhook pop-up will display.

  1. Enter a Webhook Endpoint.
    1. The Webhook endpoint will be invoked using an HTTP POST. The endpoint can be HTTP or HTTPS. 
    2. Their is a 256 character limit for the endpoint.
  2. Enter Webhook Parameters.
    1. The parameters can accept variables of the form @xxx, just like our message templates.
Please note that the platform automatically applies URL encoding. When entering endpoints, make sure to use a decoded URL to prevent double encoding.
  1. For example, if your endpoint includes encoded characters such as %2F, replace the %2F-encoded component with the decoded character of / so the endpoint just contains the decoded URL.
  2. The HTML URL Encoding Reference is a great resource to assist you in decoding an encoded URL.

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

      • Profile settings for administrators

        Overview Every user has a profile page that includes various information such as their basic info, their account details, their friends, photos, social media links, and more. Users can have access to different profile information depending on the ...

      • Best practices for administrators

        Overview The following are recommended best practices for new administrators. Choose a short URL Keep your URL short—ideally fewer than 10 characters. For example, if your company is called 'The Academy of Digital Photography,' a URL like 'ADP' is ...

      • CYPHER Agent for administrators

        Overview CYPHER Agent is an indispensable tool that uses the power of AI to take your learning platform to the next level. CYPHER Agent currently support three key features. Click the links below to explore each feature: CYPHER Agent course creation: ...

      • 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 ...

      • Password settings

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