Integrations & SDKs

Webhooks

Introduction

Webhooks Consumption 101

Webhooks are how services notify each other of events. At their core they are just a POST request to a pre-determined endpoint. The endpoint can be whatever you want, and you can just add them from the UI. You normally use one endpoint per service, and that endpoint listens to all of the event types. For example, if you receive webhooks from Acme Inc., you can structure your URL like: https://www.example.com/acme/webhooks/.

The way to indicate that a webhook has been processed is by returning a 2xx (status code 200-299) response to the webhook message within a reasonable time-frame (15s). It's also important to disable CSRF protection for this endpoint if the framework you use enables them by default.

Another important aspect of handling webhooks is to verify the signature and timestamp when processing them.

HotMic Webhooks

HotMic uses webhooks to allow you to receive the following events:

  • Stream Events
    • stream.created
    • stream.live_countdown
    • stream.ended
  • Moderation Events
    • user.blocked