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:- video (Created Video)
- video_delete [ delete ]
Fires when... A video has been deleted.
This webhook includes:- video (Deleted Video)
- 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:- video (Deleted Video)
- 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:- video (Restored Video)
- 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:- video (Affected Video)
- video_transit_success [ info ]
Fires when... A video has been emptied because of the Video Transit Security feature
This webhook includes:- video (Affected Video)
- video_failed [ error ]
Fires when... A video has failed
This webhook includes:- video (Failed Video)
- video_approve [ submit ]
Fires when... A video has been manually approved
This webhook includes:- video (Approved Video)
- video_reject [ submit ]
Fires when... A video has been manually rejected
This webhook includes:- video (Rejected Video)
- video_transcription [ info ]
Fires when... A video has been transcribed to text
This webhook includes:- video (Transcribed Video)
- video_transcription_failed [ error ]
Fires when... A video could not be transcribed
This webhook includes:- video (Failed Video)
- error (Error Type)
- video_analysis [ info ]
Fires when... A video has been analysed
This webhook includes:- video (Analysed Video)
- video_nsfw_analysis [ info ]
Fires when... A video has been analysed with the NSFW filter
This webhook includes:- video (Analysed Video)
- nsfw_analysis_result (NSFW Analysis result)
- Streams WebHooks
- video_streams_ready [ submit ]
Fires when... A video, including all streams, is ready to be played
This webhook includes:- video (Affected Video)
- stream (Source Stream)
- video_stream_accept [ submit ]
Fires when... A stream has been accepted and will be used
This webhook includes:- stream (Accepted Stream)
- video_stream_push_success [ submit ]
Fires when... A stream was successfully pushed
This webhook includes:- video (Source Video)
- push_stream_data (Push Service Return Data)
- stream (Source Stream)
- push (Push Source)
- video_stream_push_failed [ error ]
Fires when... A stream push failed
This webhook includes:- video (Source Video)
- stream (Source Stream)
- push (Push Source)
- video_stream_direct_push_success [ submit ]
Fires when... A stream was successfully pushed directly from dashboard.
This webhook includes:- video (Source Video)
- push_stream_data (Push Service Return Data)
- stream (Source Stream)
- integration (Destination)
- video_stream_direct_push_failed [ error ]
Fires when... A stream push directly from dashboard. failed
This webhook includes:- video (Source Video)
- stream (Source Stream)
- integration (Destination)
- error (Problem when pushing)