Documentation

Overview SDKs API Reference Dashboard Integrations How To's
API Reference > WebHooks > List of WebHooks

List of WebHooks

List of all of our webhooks, when they fire and what to expect from the same

List of webhooks and their description

  • Video WebHooks
  • video_create [ create ]
    Fires when... A new video has been created.
    This webhook includes:
    1. video (Created Video)
  • video_delete [ delete ]
    Fires when... A video has been deleted.
    This webhook includes:
    1. video (Deleted Video)
    2. event_origin (Information related to who initiated the delete request)
  • video_marked_as_deleted [ delete ]
    Fires when... A video has been as deleted and will be deleted shortly.
    This webhook includes:
    1. video (Deleted Video)
    2. event_origin (Information related to who initiated the delete request)
  • video_restored [ info ]
    Fires when... A video previously marked for deletion as been restored.
    This webhook includes:
    1. video (Restored Video)
    2. event_origin (Information related to who initiated the restore request)
  • video_ready [ submit ]
    Fires when... A video is ready to be played
    This webhook includes:
    1. video (Affected Video)
  • video_transit_success [ info ]
    Fires when... A video has been emptied because of the Video Transit Security feature
    This webhook includes:
    1. video (Affected Video)
  • video_failed [ error ]
    Fires when... A video has failed
    This webhook includes:
    1. video (Failed Video)
  • video_approve [ submit ]
    Fires when... A video has been manually approved
    This webhook includes:
    1. video (Approved Video)
  • video_reject [ submit ]
    Fires when... A video has been manually rejected
    This webhook includes:
    1. video (Rejected Video)
  • video_transcription [ info ]
    Fires when... A video has been transcribed to text
    This webhook includes:
    1. video (Transcribed Video)
    2. transcription_result (Transcription details)
  • video_transcription_failed [ error ]
    Fires when... A video could not be transcribed
    This webhook includes:
    1. video (Failed Video)
    2. error (Error Type)
  • video_analysis [ info ]
    Fires when... A video has been analysed
    This webhook includes:
    1. video (Analysed Video)
  • video_nsfw_analysis [ info ]
    Fires when... A video has been analysed with the NSFW filter
    This webhook includes:
    1. video (Analysed Video)
    2. nsfw_analysis_result (NSFW Analysis result)
  • audio_create [ create ]
    Fires when... A new audio has been created.
    This webhook includes:
    1. audio (Created Audio)
  • audio_confirm [ info ]
    Fires when... The audio has been confirmed.
    This webhook includes:
    1. audio (Confirmed Audio)
  • audio_delete [ delete ]
    Fires when... A audio has been deleted.
    This webhook includes:
    1. audio (Deleted Audio)
    2. event_origin (Information related to who initiated the delete request)
  • audio_marked_as_deleted [ delete ]
    Fires when... A audio has been as deleted and will be deleted shortly.
    This webhook includes:
    1. audio (Deleted Audio)
    2. event_origin (Information related to who initiated the delete request)
  • audio_restored [ info ]
    Fires when... A audio previously marked for deletion as been restored.
    This webhook includes:
    1. audio (Restored Audio)
    2. event_origin (Information related to who initiated the restore request)
  • audio_ready [ submit ]
    Fires when... A audio is ready to be played
    This webhook includes:
    1. audio (Affected Audio)
  • audio_failed [ error ]
    Fires when... A audio has failed
    This webhook includes:
    1. audio (Failed Audio)
  • audio_approve [ submit ]
    Fires when... A audio has been manually approved
    This webhook includes:
    1. audio (Approved Audio)
  • audio_reject [ submit ]
    Fires when... A audio has been manually rejected
    This webhook includes:
    1. audio (Rejected Audio)
  • audio_transcription [ info ]
    Fires when... A audio has been transcribed to text
    This webhook includes:
    1. audio (Transcribed Audio)
    2. transcription_result (Transcription details)
  • audio_transcription_failed [ error ]
    Fires when... A audio could not be transcribed
    This webhook includes:
    1. audio (Failed Audio)
    2. error (Error Type)
  • audio_analysis [ info ]
    Fires when... A audio has been analysed
    This webhook includes:
    1. audio (Analysed Audio)
  • audio_nsfw_analysis [ info ]
    Fires when... A audio has been analysed with the NSFW filter
    This webhook includes:
    1. audio (Analysed Audio)
    2. nsfw_analysis_result (NSFW Analysis result)
  • live_call_create [ create ]
    Fires when... A new live call object has been created
    This webhook includes:
    1. live_call (Created Live Call)
  • live_call_delete [ delete ]
    Fires when... A live call object has been deleted
    This webhook includes:
    1. live_call (Deleted Live Call)
    2. event_origin (Information related to who initiated the delete request)
  • live_call_join [ info ]
    Fires when... A new user has joined a live call
    This webhook includes:
    1. live_call (Live Call information)
    2. participants_info (Info about the people who joined the call)
  • live_call_end [ info ]
    Fires when... The live call has ended
    This webhook includes:
    1. live_call (Live Call information)
  • live_call_left [ info ]
    Fires when... A user has left the call
    This webhook includes:
    1. live_call (Live Call information)
    2. participant_info (Info about the person who left the call)
  • live_call_failed [ error ]
    Fires when... A live call has failed in any of its states
    This webhook includes:
    1. live_call (Live Call information)
    2. error_info (Information about the error that happened during the call)
  • Streams WebHooks
  • video_streams_ready [ submit ]
    Fires when... A video, including all streams, is ready to be played
    This webhook includes:
    1. video (Affected Video)
    2. stream (Source Stream)
  • video_stream_accept [ submit ]
    Fires when... A stream has been accepted and will be used
    This webhook includes:
    1. stream (Accepted Stream)
  • video_stream_push_success [ submit ]
    Fires when... A stream was successfully pushed
    This webhook includes:
    1. video (Source Video)
    2. push_stream_data (Push Service Return Data)
    3. stream (Source Stream)
    4. push (Push Source)
  • video_stream_push_failed [ error ]
    Fires when... A stream push failed
    This webhook includes:
    1. video (Source Video)
    2. stream (Source Stream)
    3. push (Push Source)
  • video_stream_direct_push_success [ submit ]
    Fires when... A stream was successfully pushed directly from dashboard.
    This webhook includes:
    1. video (Source Video)
    2. push_stream_data (Push Service Return Data)
    3. stream (Source Stream)
    4. integration (Destination)
  • video_stream_direct_push_failed [ error ]
    Fires when... A stream push directly from dashboard. failed
    This webhook includes:
    1. video (Source Video)
    2. stream (Source Stream)
    3. integration (Destination)
    4. error (Problem when pushing)
  • audio_streams_ready [ submit ]
    Fires when... A audio, including all streams, is ready to be played
    This webhook includes:
    1. audio (Affected Audio)
    2. stream (Source Stream)
  • audio_stream_accept [ submit ]
    Fires when... A stream has been accepted and will be used
    This webhook includes:
    1. stream (Accepted Stream)
  • audio_stream_push_success [ submit ]
    Fires when... A stream was successfully pushed
    This webhook includes:
    1. audio (Source Audio)
    2. push_stream_data (Push Service Return Data)
    3. stream (Source Stream)
    4. push (Push Source)
  • audio_stream_push_failed [ error ]
    Fires when... A stream push failed
    This webhook includes:
    1. audio (Source Audio)
    2. stream (Source Stream)
    3. push (Push Source)
  • audio_stream_direct_push_success [ submit ]
    Fires when... A stream was successfully pushed directly from dashboard.
    This webhook includes:
    1. audio (Source Audio)
    2. push_stream_data (Push Service Return Data)
    3. stream (Source Stream)
    4. integration (Destination)
  • audio_stream_direct_push_failed [ error ]
    Fires when... A stream push directly from dashboard. failed
    This webhook includes:
    1. audio (Source Audio)
    2. stream (Source Stream)
    3. integration (Destination)
    4. error (Problem when pushing)