Digital Samba Embedded
  • Getting started
    • Sign up to create a new team
    • Choose your subdomain
    • Authenticate to the API
    • Regenerate your developer key
  • Setting up your team
    • Update your subdomain
    • Customise your domain
    • Customize Access to Recordings, Transcripts, and Files
    • Add members to your team
    • Assign a team-role to your team members
    • Remove members
  • Configuring your room defaults
    • General settings
    • Branding
    • Components
    • Content Library
    • Recordings
    • Chat
    • Captions
    • Polls
    • Q&A
    • Transcription
    • Join settings
  • Creating a room
    • General settings
    • Branding
    • Components
    • Content Library
    • Recordings
    • Chat
    • Breakout rooms
    • Polls
    • Captions
    • Q&A
    • Transcription
    • Join settings
    • Telephony
    • External stream
  • Managing rooms
  • Adding moderation to your rooms with roles
    • Add roles to a room
    • Create a custom role
    • Permissions
  • Managing roles
  • Controlling room entry
  • Libraries
  • Recordings
  • Webhooks
  • Tokens
  • Troubleshooting sessions
    • Session details
    • Participant details
    • Participant log
  • Retrieving session data and reports
  • Understanding usage data
  • System check
  • REST API docs
  • SDK docs
  • LTI docs
Powered by GitBook
On this page

Webhooks

Webhooks expose events happening in Digital Samba Embedded, allowing you to set custom callbacks to invoke behaviour on your app.

PreviousRecordingsNextTokens

Last updated 4 months ago

Digital Samba Embedded currently support ed events: ‘session started’, ‘session ended’, ‘participant joined’, ‘participant left’, ‘recording started’, ‘recording stopped’, ‘recording ready for download’

To create a new webhook, go to the 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'.

  • In addition Digital Samba supports the following Library Events

    • Folder added to library

    • Folder renamed

    • Folder deleted from library

    • File added to library

    • File processing failed

    • File renamed

    • File deleted from library

You may also use the to get the list of webhooks, get a specific one, create a new one, update or delete it.

REST API
Webhooks section