This article explains webhooks. What are they? How do they work? How do I use them to set up an integration?

What are webhooks?

At first webhooks can seem overwhelming and it can take some time to wrap your head around the idea. However, when you understand what webhooks can do and how they work, they can be extremely powerful. The easiest way to think about a webhook is like it's a notification on steroids. The notification can carry a payload of data which can be used by the receiving party. 

Why should I use webhooks?

Webhooks are the easiest way to set up an integration. Webhooks can be used to send data from our software to another system when a participant finishes an Exam, Course or Assessment.

Webhooks explained

There are different formats available for webhooks: form encoded, JSON and XML.

Form-encode:first_name=John&last_name=Doe&gender=maleJSON: {    "first_name": "John",    "last_name": "Doe",    "gender": "male"}XML: JohnDoemale

Our webhooks use the JSON encoding.

If you enabled webhooks and a participant finishes a Course, Exam or Assessment we generate the message with the payload. The next thing you need is a URL to send the message to. We call this the API endpoint URL. You can obtain this URL from the receiving system. If you put this URL in our system we send the data to that URL. The receiving software will listen to this URL, and every time it receives a notification it will process the data.

Note: the API endpoint URL for webhooks must use an encrypted HTTPS connection, and not an insecure HTTP connection.

Now that you know about more webhooks let's get them to work! Read the following article about how to use webhooks and zapier to set up your first integration. 

You need at least a Corporate Owl plan to get the webhooks working.
Was this article helpful?
Cancel
Thank you!