Tribal Habits has the ability for all organisations to create webhooks to send data to external platforms as part of an integration.
NOTE: Only Super Admins can create and manage webhooks.
How can webhooks be enabled?
To enable webhooks in your platform, there is a two step process.
Navigate to Admin -> Accounts -> Subscription and toggle the Webhooks feature on.
Reload Admin in your browser and then navigate to Admin -> Accounts -> Integrations and a new Webhook menu option will now be visible.
How are webhooks created?
Navigate to Admin -> Accounts -> Integrations -> Webhooks to create and manage your webhooks. There is an 'I want to...' menu on the top right of the screen with the option to 'Create webhook'.
When creating a webhook:
Select the webhook event.
Enrolment created. Triggered for any new topic or pathway enrolment
Enrolment completed. Triggered when any topic or pathway is completed
Enrolment deleted. Triggered when any topic or pathway enrolment is unenrolled. This includes a Reset Enrolment (which unenrolls and then re-enrolls a learner)
Insert the URL for the webhook payload to be sent to. This must be HTTPS. You will this URL from the platform the payload is being sent to.
Optionally, make any notes about the webhook. This can be useful for identifying why each webhook was created and where it is used.
Enable the webhook. This option allows you to temporarily disable a webhook without deleting it.
How are webhooks managed?
On the same page (Admin -> Accounts -> Integrations -> Webhooks), there is a table of active webhooks. Admins can...
Edit a webhook to update its URL or notes.
Edit a webhook to disable it.
Edit a webhook to delete it.
View the logs of a webhook. The logs show every instance of a webhook occurrence include the date/time, target URL, response and payload information.
What information is send in the webhook payload?
Please see our Developers documentation for examples of each webhook payload.