One way to automatically retrieve data from of your learning site in real-time, is to set up webhook notifications. There are a number of events that can be broadcast in real-time to any enterprise system (e.g., email marketing, CRM, etc.), in JSON format, via webhooks.
You can set up webhook notifications for particular events, and the data will be sent to the indicated URL automatically. You can then pull this data using a web service and transform the webhook into a format consumable by various third party systems.
For example, you could set up a notification for "course is completed by learner," send that webhook to your third-party email system, and then setup an automatic email to those learners who completed a particular course.
Where do I find this?
Settings > Integrations > Notifications
How do I do this?
- From your homepage, select Settings.
- From the left menu, select Integrations and then Notifications.
- Click New Notification to add a new notification.
- From here you will find a complete list of available events. Select the event that you'd like to receive notifications for (e.g. instructor is messaged).
- Once your selection in made, you will be prompted to select your preferred format. Click Webhook.
- Enter the appropriate webhook server URL. This is the server that will receive the webhook.
- You can also choose to be notified about a specific course but the default setting applies to all courses within your learning site.
- Click Test Event.
- Once you've received your sample, click Save Notification.
What else do I need to know?
- Integrating with a third-party system may require your technical team to write the necessary scripts.
- All webhooks, except subscription purchases, are sent in real-time as the event is performed.
- Each event will fire a separate webhook in JSON format.
- The connection will time out in 15 seconds. If your endpoint does not respond before the connection times out, or if your endpoint returns a status code outside the range of 200–308, we will consider the delivery of the message as a failed attempt.
- Thought Industries will automatically retry failed webhook notifications.
- You can download a sample CSV or JSON file for any particular event by clicking on that event and then Download Sample CSV or Download Sample JSON. If the sample is empty, you may need to trigger that event within the site.
What does this look like?