Lets Talk About Webhooks – What Are They And How Do We Use Them In Teachstack

When we hear people talking of Webhooks,  we might get a weird image of hooks and other objects which have nothing to do with the term. So what are Webhooks in reality? 

Let’s have a look then at what Webhooks are really all about!

What are Webhooks?

Webhook is a method of augmenting or altering the behavior of a web page or web application with custom callbacks. It allows us to send real-time data from our application to your application whenever a given event occurs. It notifies you of our supported events, so you’d be able to run any processes that you had in your application once this event is triggered. In brief, Webhooks allows you to send automated messages from your application whenever an event occurs. 

Teachstack allows you a set of custom webhooks that you can enable as required. For example: Suppose a Webhook is assigned to the event “Room_closed”. This means that whenever a classroom session ends in Teachstack, an alert message will be sent to the endpoint URL that was set up have assigned. The endpoint URL is basically the URL set by you where the alert message will be sent.

In short, all you have to do is

  • Use incoming webhooks to get real-time updates.
  • Listen for events on your account so your integration can automatically trigger reactions.

How to Add Webhooks?

In Teachstack, you can subscribe to webhook events directly from the dashboard. THis can be done in 3 easy steps:

  • Log in to Dashboard.  
  • Select Webhooks under the Integration tab.
  • Just provide the endpoint URL and check the events to be subscribed.

Some Points To Remember About Selecting The Endpoint

  • You can create a webhook endpoint by setting up an HTTPS endpoint on your local machine that can accept unauthenticated webhook requests with a POST method and expects request payload data in JSON format.
  • Make sure the endpoint is configured to handle requests from Teachstack. The events sent to your webhook endpoint are part of a POST request in JSON format only.

Types of Webhooks          

Teachstack mainly offers 7 types of Webhooks for your convenience.

Webhook Name Description
  • room.created
This webhook is triggered when a class/room is started by the teacher.
  • room.closed
This webhook is activated whenever a class/room ends.
  • peer.joined
When a new participant joins a class/room, this is activated and the endpoint URL is notified of the same.
  • peer.left
Similar to the above, the endpoint URL receives an alert message that someone has left a class/room.
  • recording.processed
This is activated when the classroom video recording event is complete.
  • recording.failed
This webhook is used to alert the user in case a video recording process has failed.
  • whiteboard.new_file_saved
Triggers when a whiteboard is saved during a live class.

Conclusion

Webhooks provide a seamless, real-time communication method for online applications. Teachstack can notify and share information with one another about events taking place and form a chain of automated workflows bringing more value to themselves and their users. Now that you have learned how to use them with Teachstack, go ahead and use them to their fullest potential.

Leave a Reply

Your email address will not be published.