Overview

Using Webhook actions, you can configure the platform to call a third-party API whenever a particular event occurs. For example, you can create a webhook action to call an API on your own servers when a student completes a course. This article covers the basics of adding a Webhook action to a qualifying event.

Installing the Webhooks app

To use Webhooks, the app must first be installed. To install the Webhooks app, administrators:

1. Click Admin from the primary navigation menu.
   
2. Click App center from the fly-out menu.
   
3. Install the Webhooks app from the Integration tools section. 

Webhooks actions

1. Click Add in the action section of a qualifying event.
   
1. For more details on adding actions to qualifying events, visit the Rules knowledge based article.
   
2. Click the Integrations tab.
   
3. Click Webhook.

1. Enter a webhook Endpoint.
   
1. The webhook endpoint will be invoked using an HTTP POST. The endpoint can be HTTP or HTTPS. 
   
2. There is a 256 character limit for the endpoint.
2. Enter webhook Parameters.
   
1. The parameters can accept variables of the form @xxx, just like message templates.
   
3. If you only want the webhook action to occur for specific users, you can add a filter. To add a filter, click the Add  icon in the Filters section.
   
1. To learn more about filters, visit the Filters knowledge base article. 
   
4. Click Save.
   

You can add multiple Webhook actions to qualifying events. 

Webhooks widget

For additional visibility into webhook calls and errors, administrators can add the Webhooks widget to the Admin dashboard.

1. Click Home from the primary navigation menu.
   
2. Click the Admin tab.
   
3. Click the Edit widgets  button.
   

The Edit pop-up displays.

1. Click Center panel.
   

The Admin dashboard will display in edit mode.

1. Drag-and-drop the Webhooks widget from the Available widgets column to the Center panel.
   
2. Click Save.