Comment on page

Webhooks

Webhooks expose events happening in Digital Samba Embedded, allowing you to set custom callbacks to invoke behaviour on your app.
Digital Samba Embedded currently only supports the 'participant joined' and 'participant left' events.
To create a new webhook, go to the Webhooks section of the dashboard and clic on the 'Add webhook'. This is also where you'll be able to get the list of your team's created webhooks.
When creating or editing a webhook:
  • You'll need to add the URL to the endpoint that the webhook should send its data to process it as needed. This is a required field.
  • You may also optionally add a description to help other team members understand your purpose or even to keep it clear for yourself, over time.
  • The authorisation header field is also not required, but highly recommended if you want to authenticate the request and ensure that it is coming from a trusted source. The token or credentials should be generated by the server that is receiving the webhook, and should be kept secure.
  • Finally you'll need to select the event or events that should trigger the webhook on Digital Samba Embedded's side. Digital Samba supports the following events: 'session started', 'session ended', 'participant joined', 'participant left', 'recording started', 'recording stopped', and 'recording ready for download'.
You may also use the REST API to get the list of webhooks, get a specific one, create a new one, update or delete it.