Webhooks collection

Media related events

Transform media events

In-video AI events

Live stream related events

Simulcast target events

Media related events

These events notify your system about the upload, creation, availability, or failure of media assets, such as videos or audio files. They also track when media assets are updated or deleted, allowing your system to respond accordingly.

Webhook event	Description	Use Case
`video.media.created`	Triggered when a new media has been successfully created (Pull from URL).	Notify your system when media is available on the platform.
`video.media.upload`	Indicates that a direct upload has been initiated. The user or system requests an upload URL. (Push media)	Useful for tracking when users start uploading media through your app.
`video.upload.media_created`	A media asset has been created from an upload. Triggered when an end user finishes uploading a file through a direct upload URL.	Track when a media is successfully created after an upload.
`video.media.ready`	Triggered when the media (video or audio) is ready for playback. Used for both Push and Pull.	Use the `playbackId` to initiate streaming of the media.
`video.media.failed`	Triggered when the media asset encounters an error during processing (e.g., invalid input URL).	Notify your system about errors for debugging or user notifications.
`video.media.deleted`	Triggered when a media asset has been deleted.	Remove references to the media, as it is no longer available.
`video.media.updated`	Triggered when an existing media is updated.	Sync your system to reflect any changes made to the media.
`video.media.live_stream.created`	Triggered when a live stream is recorded into an on-demand media. A manifest file is created and a `playbackId` is generated for streaming.	Useful for handling live stream recordings and initiating on-demand playback.

Transform media events

These events notify your system when specific transformations, enhancements, or modifications to media assets have been successfully applied. Use these events to trigger downstream workflows like updating your UI, notifying users, or moving media to the next processing stage.

Webhook event	Description
`video.media.intro.ready`	Triggered when an intro clip has been successfully added to the beginning of the media asset.
`video.media.outro.ready`	Triggered when an outro clip has been successfully added to the end of the media asset.
`video.media.expunge.ready`	Triggered when specified segments of the media have been successfully removed. Useful for cutting out unwanted sections.
`video.media.splicing.ready`	Triggered when multiple media segments have been successfully stitched together into a single file.
`video.media.imposeAudio.ready`	Triggered when a secondary audio track (such as background music or narration) has been successfully imposed onto the media.
`video.media.swapAudio.ready`	Triggered when the original audio track has been successfully replaced with a new one.
`video.media.watermark.ready`	Triggered when watermarking has been successfully applied to the media for branding or content protection.
`video.media.optimize_audio.ready`	Triggered when audio optimization—such as loudness normalization or noise reduction—has been completed.
`video.media.mp4Support.ready`	Triggered when an MP4-compatible version of the media has been successfully generated for playback or device fallback.
`video.media.subtitle.generated.ready`	Triggered when subtitles or captions have been automatically generated and are ready for use.
`video.media.track.created`	Triggered when a new track, such as an additional audio or subtitle track, has been added to the media asset.
`video.media.track.ready`	Triggered when an added track (audio or subtitle) has been successfully processed and is ready for playback.
`video.media.track.failed`	Triggered when a track (audio or subtitle) encounters an error during processing. Useful for debugging or alerting.

In-video AI events

These events notify your system when AI-powered tasks—such as chapter generation, content summarization, named entity recognition, or moderation checks - are completed for a media asset.

Event Name	Description
`video.mediaAI.chapters.ready`	Triggered when chapters have been successfully generated for the media, including start times, titles, and summaries.
`video.mediaAI.namedEntities.ready`	Triggered when named entities like people, organizations, or locations have been identified within the media.
`video.mediaAI.summary.ready`	Triggered when a summary of the media has been generated, providing a brief overview of the content.
`video.mediaAI.moderation.ready`	Triggered when moderation analysis is complete, with results for categories like violence, adult content, or offensive language.

Live stream related events

These events track the full lifecycle of live streams, including creation, connection, and when the stream goes live or becomes idle. Additionally, they monitor the recording process and provide updates when streams are updated, enabled, disabled, or deleted.

Webhook	Description
`video.live_stream.created`	A new live stream has been created. Broadcasters possessing a stream key can commence transmitting their encoder feed to this particular live stream.
`video.live_stream.preparing`	Status indicates that the live stream is being initialized and set up. During this phase, the system is validating inputs and allocating resources before going live.
`video.live_stream.connected`	The live stream is in a "connected" status for video live streaming, confirming that an encoder has established a successful connection to it.
`video.live_stream.recording`	The live stream's video recording is now in progress.
`video.live_stream.active`	The live stream is currently marked as "active," signifying that it is presently "live" and actively broadcasting.
`video.live_stream.disconnected`	When the stream is stopped, causing the encoder to become disconnected.
`video.live_stream.idle`	The live stream enters an "idle" state as there is no ongoing streaming activity.
`video.media.live_stream.created`	This event is triggered when a live stream gets recorded and a new media has been successfully created as video-on-demand. Use this to notify your system when media is available in the platform.
`video.live_stream.updated`	The live stream has been either updated, or the stream key for this livestream has been reset.
`video.live_stream.deleted`	The live stream has been deleted.

Simulcast target events

Simulcast target events give real-time updates on the status of third-party endpoints used in live streaming. They help you track the creation and deletion of simulcast targets, allowing your system to reflect their current status accurately in the user interface.

Webhooks	Description
`video.live_stream.simulcast_target.created`	A new simulcast has been created for a live stream.
`video.live_stream.simulcast_target.deleted`	When the simulcast of a live stream has been deleted.
`video.live_stream.simulcast_target.updated`	When the simulcast of a live stream has been updated.