Documentation

  • 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)
  • video_ready [ submit ]
    Fires when... A video is ready to be played
    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)
  • 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)
  • 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. stream (Source Stream)
    3. 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)