EthosCE Webhooks

EthosCE supports the configuration of webhooks. EthosCE webhooks can be configured to send data payloads in real-time when events on the EthosCE site occur. Webhook events are available for all EthosCE web service endpoints. We refer to EthosCE events as ‘Actions’. Actions include EthosCE site events such as records Created, Updated, and Deleted. Traditionally, customers consuming data from EthosCE would need to ‘poll’ the available web service endpoints in order to gather new data payloads as actions occur in the system. The implementation of webhooks eliminates the need to constantly ‘poll’ the EthosCE web service endpoints. Webhooks are configured to send a specific data payload to an external url whenever the specified EthosCE action occurs. The webhook data payloads are sent in real-time immediately when a specified event occurs. Administrators may set up an unlimited amount of webhooks in EthosCE.

Webhook Configuration

Open

1. Navigate to /admin/structure/rest-hooks/

2. Select the option to ‘Add rest hooks’

Open

3. Select the ‘Entity type’ to specify what type of data payload EthosCE should send when a site action occurs. All available EthosCE webservice data structures are selectable.

4. Specify the site ‘Action’ which triggers the webhook payload to send. Actions include: records Created, Updated, and Deleted.

5. Specify the external url which will consume the webhook data payload. More information on webhook support here.

Example Webhook Payload data structure

The payload example below is for a webhook configured whenever a new course enrollment record action occurs on an EthosCE site.

Webhook testing resources

https://webhook.site/ provides a free tool administrations can use to test EthosCE webhook configurations. Add the provided Webhook.site url to the ‘Target URL’ field in EthosCE. Once the EthosCE site begins triggering the specified actions, Webhook.site will provide the full webhook payload from EthosCE.