Subscribe to transform events
Learn about the events that monitor FastPix media processing, including intros, outros, splicing, audio, subtitles, watermarks, and source management, to enable efficient tracking and automation.
FastPix emits a variety of events related to media transformation processes, allowing you to monitor and respond to changes in the status of your media assets effectively. These events cover a range of transformations, including the addition of intro and outro clips, splicing of media segments, imposing tracks, swapping audio, adding watermarks, optimizing audio, generating subtitles, managing media tracks, and handling media sources. By subscribing to these events, you can automate workflows, trigger notifications, or perform additional processing based on the specific transformations occurring within your media assets.
video.media.intro.ready
Triggered when an intro clip has been successfully added to the beginning of a media asset. This confirms that the intro has been stitched into the main video, making the content ready for playback or distribution with the intro in place.
| Name | Type | Description |
|---|---|---|
| type | string | Type of event (e.g., "video.media.intro.ready"). |
| object | object | Object information. |
| -object.type | string | Type of the object (e.g., "media"). |
| -object.id | string | Unique identifier for the object (e.g., "22a9a5ca-8b76-4d81-871b-ca718ad5e418"). |
| id | string | Unique identifier for the event. |
| workspace | object | Workspace information. |
| -workspace.name | string | Name of the workspace (e.g., "Development"). |
| -workspace.id | string | Unique identifier for the workspace. |
| status | string | Status of the media (e.g., "ready"). |
| data | object | Media-specific data. |
| -data.thumbnail | string (URL) | URL for the thumbnail image. |
| -data.id | string | Unique identifier for the media. |
| -data.workspaceId | string | Unique identifier for the workspace. |
| -data.metadata | object | Metadata associated with the media. |
| —data.metadata.key1 | string | Key-value pair for metadata (e.g., "key1": "value1"). |
| -data.maxResolution | string | Maximum resolution for encoding, storing, and streaming (e.g., "1080p"). |
| -data.sourceResolution | string | Source resolution of the media. |
| -data.playbackIds | array | List of playback IDs. |
| —data.playbackIds[].id | string | Unique identifier for the playback ID. |
| —data.playbackIds[].accessPolicy | string | Access policy (e.g., "public"). |
| —data.playbackIds[].accessRestrictions | object | Playback access restrictions. |
| ---data.playbackIds[].accessRestrictions.domains | object | Domain-based access restrictions. |
| ----data.playbackIds[].accessRestrictions.domains.defaultPolicy | string | Default domain policy (e.g., "allow"). |
| ----data.playbackIds[].accessRestrictions.domains.allow | array | List of allowed domains. |
| ----data.playbackIds[].accessRestrictions.domains.deny | array | List of denied domains. |
| ----data.playbackIds[].accessRestrictions.userAgents | object | User agent-based access restrictions. |
| ----data.playbackIds[].accessRestrictions.userAgents.defaultPolicy | string | Default user agent policy (e.g., "allow"). |
| ----data.playbackIds[].accessRestrictions.userAgents.allow | array | List of allowed user agents. |
| ----data.playbackIds[].accessRestrictions.userAgents.deny | array | List of denied user agents. |
| -data.tracks | array | List of media tracks. |
| —data.tracks[].id | string | Unique identifier for the track. |
| —data.tracks[].type | string | Type of track (e.g., "video"). |
| —data.tracks[].width | integer | Width of the track (e.g., 1920). |
| —data.tracks[].height | integer | Height of the track (e.g., 1080). |
| —data.tracks[].frameRate | string | Frame rate (e.g., "30/1"). |
| —data.tracks[].status | string | Status of the track (e.g., "available"). |
| —data.tracks[].languageCode | string | Language code for audio/subtitle track (e.g., "und"). |
| —data.tracks[].languageName | string | Full language name for audio/subtitle track (e.g., "default"). |
| -data.sourceAccess | boolean | Indicates if source access is enabled. |
| -data.mp4Support | string | Indicates MP4 support (e.g., "none"). |
| -data.optimizeAudio | boolean | Indicates if audio optimization is enabled. |
| -data.duration | string | Duration of the media (e.g., "00:00:20"). |
| -data.aspectRatio | string | Aspect ratio of the media (e.g., "16:9"). |
| -data.createdAt | string (ISO 8601) | Timestamp when the media was created. |
| -data.updatedAt | string (ISO 8601) | Timestamp when the media was last updated. |
| -data.mediaQuality | string | Media quality tier for the media (e.g., "pro"). |
| createdAt | string (ISO 8601) | Timestamp when the event was created. |
| attempts | array | List of attempts made to deliver the webhook. |
| -attempts[].webhookId | string | Unique identifier for the webhook attempt. |
| -attempts[].responseStatusCode | integer | HTTP status code of the response. |
| -attempts[].responseHeaders | object | Response headers. |
| —attempts[].responseHeaders.contentType | string | Content type (e.g., "application/json"). |
| —attempts[].responseHeaders.transfer | string | Transfer encoding (if applicable). |
| —attempts[].responseHeaders.server | string | Server used for the response (e.g., "nginx"). |
| —attempts[].responseHeaders.date | string | Date of the response. |
| —attempts[].responseHeaders.cacheControl | string | Cache control headers (if any). |
| -attempts[].responseBody | string | Body of the response (e.g., {"success":false,...}). |
| -attempts[].maxAttempts | integer | Maximum number of retry attempts (e.g., 30). |
| -attempts[].id | string | Unique identifier for the attempt. |
| -attempts[].createdAt | string (ISO 8601) | Timestamp when the attempt was created. |
| -attempts[].address | string | URL address of the webhook. |
video.media.outro.ready
Triggered when an outro clip has been successfully added to the end of a media asset. Use this event to confirm that the outro has been appended and the final media is prepared with the outro included.
| Name | Type | Description |
|---|---|---|
| - type | string | Type of event (e.g., "video.media.outro.ready") |
| - object | object | Object information |
| — object.type | string | Type of the object (e.g., "media") |
| — object.id | string | Unique identifier for the object |
| - id | string | Unique identifier for the event |
| - workspace | object | Workspace information |
| — workspace.name | string | Name of the workspace (e.g., "Development") |
| — workspace.id | string | Unique identifier for the workspace |
| - status | string | Status of the media (e.g., "ready") |
| - data | object | Media-specific data |
| — data.thumbnail | string (URL) | URL for the thumbnail image |
| — data.id | string | Unique identifier for the media |
| — data.workspaceId | string | Unique identifier for the workspace |
| — data.metadata | object | Metadata associated with the media |
| --- data.metadata.key1 | string | Key-value pair (e.g., "key1": "value1") |
| — data.maxResolution | string | Max resolution for encoding/streaming (e.g., "1080p") |
| — data.sourceResolution | string | Source resolution of the media |
| — data.playbackIds | array | List of playback IDs |
| --- data.playbackIds[].id | string | Unique identifier for the playback ID |
| --- data.playbackIds[].accessPolicy | string | Access policy (e.g., "public") |
| --- data.playbackIds[].accessRestrictions | object | Access restrictions (domains, user agents) |
| ---- domains.defaultPolicy | string | Default domain policy (e.g., "allow") |
| ---- domains.allow | array | List of allowed domains |
| ---- domains.deny | array | List of denied domains |
| ---- userAgents.defaultPolicy | string | Default user agent policy (e.g., "allow") |
| ---- userAgents.allow | array | List of allowed user agents |
| ---- userAgents.deny | array | List of denied user agents |
| — data.tracks | array | List of media tracks |
| --- data.tracks[].id | string | Track ID |
| --- data.tracks[].type | string | Type of track (e.g., "video") |
| --- data.tracks[].width | integer | Track width (e.g., 1920) |
| --- data.tracks[].height | integer | Track height (e.g., 1080) |
| --- data.tracks[].frameRate | string | Frame rate (e.g., "30/1") |
| --- data.tracks[].status | string | Track status (e.g., "available") |
| --- data.tracks[].languageCode | string | Language code for audio/subtitle track (e.g., "und") |
| --- data.tracks[].languageName | string | Full language name for audio/subtitle track (e.g., "default") |
| — data.sourceAccess | boolean | Whether source access is enabled (e.g., false) |
| — data.mp4Support | string | MP4 support (e.g., "none") |
| — data.optimizeAudio | boolean | Whether audio optimization is enabled (e.g., false) |
| — data.duration | string | Duration of media (e.g., "00:00:20") |
| — data.aspectRatio | string | Aspect ratio of media (e.g., "16:9") |
| — data.createdAt | string (ISO 8601) | Timestamp when media was created |
| — data.updatedAt | string (ISO 8601) | Timestamp when media was last updated |
| — data.mediaQuality | string | Media quality tier for the media (e.g., "pro") |
| - createdAt | string (ISO 8601) | Timestamp when event was created |
| - attempts | array | Delivery attempts |
| — attempts[].webhookId | string | Webhook attempt ID |
| — attempts[].responseStatusCode | integer | HTTP status code of response |
| — attempts[].responseHeaders | object | Response headers |
| --- contentType | string | e.g., "application/json" |
| --- transfer | (optional/unspecified) | |
| --- server | string | Server (e.g., "nginx") |
| --- date | string | Date of response |
| --- cacheControl | (optional/unspecified) | |
| — attempts[].responseBody | string | Response body |
| — attempts[].maxAttempts | integer | Max retry attempts |
| — attempts[].id | string | Unique identifier for the attempt |
| — attempts[].createdAt | string (ISO 8601) | Timestamp of the attempt |
| — attempts[].address | string | Webhook target URL |
video.media.expunge.ready
Triggered when specified segments of the media have been successfully removed. This is typically used for scenarios like cutting out ads, trimming unwanted sections, or removing objectionable content from the video.
| Name | Type | Description |
|---|---|---|
| type | string | Type of event (e.g., “video.media.expunge.ready”). |
| object | object | Object information. |
| - object.type | string | Type of the object (e.g., “media”). |
| - object.id | string | Unique identifier for the object (e.g., “242923d6-1669-467a-9626-8b41862fb2b6”). |
| id | string | Unique identifier for the event (e.g., “1904e6f3-3e2e-4206-8299-85fb1846b930”). |
| workspace | object | Workspace information. |
| - workspace.name | string | Name of the workspace (e.g., “Development”). |
| - workspace.id | string | Unique identifier for the workspace (e.g., “338acdeb-29d4-438b-a40c-1d4105134462”). |
| status | string | Status of the media (e.g., “ready”). |
| data | object | |
| - data.thumbnail | string (URL) | URL for the thumbnail image. |
| - data.id | string | Unique identifier for the media (e.g., “242923d6-1669-467a-9626-8b41862fb2b6”). |
| - data.workspaceId | string | Unique identifier for the workspace (e.g., “338acdeb-29d4-438b-a40c-1d4105134462”). |
| - data.metadata | object | Metadata associated with the media. |
| — data.metadata.key1 | string | Key-value pair for metadata (e.g., “key1”: “value1”). |
| - data.maxResolution | string | Maximum resolution for encoding, storing, and streaming media (e.g., “1080p”). |
| - data.sourceResolution | string | Source resolution of the media (e.g., “1080”). |
| - data.playbackIds | array | List of playback IDs. |
| — data.playbackIds[].id | string | Unique identifier for the playback ID (e.g., “49ae2ef3-0a6c-4a7b-8641-00d1c98c70ec”). |
| — data.playbackIds[].accessPolicy | string | Access policy for playback IDs (e.g., “public”). |
| — data.playbackIds[].accessRestrictions | object | Access restrictions for domains and user agents. |
| --- data.playbackIds[].accessRestrictions.domains | object | Domain-based access restrictions. |
| ---- data.playbackIds[].accessRestrictions.domains.defaultPolicy | string | Default policy for domains (e.g., “allow”). |
| ---- data.playbackIds[].accessRestrictions.domains.allow | array | List of allowed domains. |
| ---- data.playbackIds[].accessRestrictions.domains.deny | array | List of denied domains. |
| --- data.playbackIds[].accessRestrictions.userAgents | object | User agent-based access restrictions. |
| ---- data.playbackIds[].accessRestrictions.userAgents.defaultPolicy | string | Default policy for user agents (e.g., “allow”). |
| ---- data.playbackIds[].accessRestrictions.userAgents.allow | array | List of allowed user agents. |
| ---- data.playbackIds[].accessRestrictions.userAgents.deny | array | List of denied user agents. |
| - data.tracks | array | List of tracks in the media. |
| — data.tracks[].id | string | Unique identifier for the track (e.g., “c6dc4a74-8958-4115-9c7a-469949539892”). |
| — data.tracks[].type | string | Type of the track (e.g., “audio”, “video”). |
| — data.tracks[].status | string | Status of the track (e.g., “available”). |
| — data.tracks[].languageCode | string | Language code for audio/subtitle track (e.g., “und”). |
| — data.tracks[].languageName | string | Full language name for audio/subtitle track (e.g., “default”). |
| — data.tracks[].width | integer | Width of the video track (e.g., 1920). |
| — data.tracks[].height | integer | Height of the video track (e.g., 1080). |
| — data.tracks[].frameRate | string | Frame rate of the video track (e.g., “60.000”). |
| - data.sourceAccess | boolean | Indicates if source access is enabled (e.g., false). |
| - data.mp4Support | string | Indicates MP4 support (e.g., “none”). |
| - data.optimizeAudio | boolean | Indicates if audio optimization is enabled (e.g., false). |
| - data.duration | string | Duration of the media (e.g., “00:00:02”). |
| - data.aspectRatio | string | Aspect ratio of the media (e.g., “16:9”). |
| - data.createdAt | string (ISO 8601) | Timestamp when the media was created (e.g., “2026-07-01T10:10:33.564415Z”). |
| - data.updatedAt | string (ISO 8601) | Timestamp when the media was last updated (e.g., “2026-07-01T10:11:06.281212Z”). |
| - data.mediaQuality | string | Media quality tier for the media (e.g., “pro”). |
| createdAt | string (ISO 8601) | Timestamp when the event was created (e.g., “2026-07-01T10:11:07.720817767Z”). |
| attempts | array | List of attempts made to deliver the webhook. |
video.media.splicing.ready
Triggered when multiple video segments have been stitched together into a single media file. Use this event to confirm that splicing (joining) is complete and the combined video is ready for playback or further processing.
| Name | Type | Description |
|---|---|---|
| type | string | Type of event (e.g., “video.media.splicing.ready”). |
| object | object | Object information. |
| - object.type | string | Type of the object (e.g., “media”). |
| - object.id | string | Unique identifier for the object (e.g., “de983df2-0462-4c83-bbed-fab102aa1105”). |
| id | string | Unique identifier for the event. |
| workspace | object | Workspace information. |
| - workspace.name | string | Name of the workspace (e.g., “Development”). |
| - workspace.id | string | Unique identifier for the workspace (e.g., “338acdeb-29d4-438b-a40c-1d4105134462”). |
| status | string | Status of the media (e.g., “ready”). |
| data | object | |
| - data.thumbnail | string (URL) | URL for the thumbnail image. |
| - data.id | string | Unique identifier for the media (e.g., “de983df2-0462-4c83-bbed-fab102aa1105”). |
| - data.workspaceId | string | Unique identifier for the workspace (e.g., “338acdeb-29d4-438b-a40c-1d4105134462”). |
| - data.maxResolution | string | Maximum resolution for encoding, storing, and streaming media (e.g., “1080p”). |
| - data.sourceResolution | string | Source resolution of the media (e.g., “1080”). |
| - data.playbackIds | array | List of playback IDs. |
| — data.playbackIds[].id | string | Unique identifier for the playback ID (e.g., “ccb44144-eda1-48f6-a65e-e4b8db457cb4”). |
| — data.playbackIds[].accessPolicy | string | Access policy for playback IDs (e.g., “public”). |
| — data.playbackIds[].accessRestrictions | object | Access restrictions for domains and user agents. |
| --- data.playbackIds[].accessRestrictions.domains | object | Domain-based access restrictions. |
| ---- data.playbackIds[].accessRestrictions.domains.defaultPolicy | string | Default policy for domains (e.g., “allow”). |
| ---- data.playbackIds[].accessRestrictions.domains.allow | array | List of allowed domains. |
| ---- data.playbackIds[].accessRestrictions.domains.deny | array | List of denied domains. |
| --- data.playbackIds[].accessRestrictions.userAgents | object | User agent-based access restrictions. |
| ---- data.playbackIds[].accessRestrictions.userAgents.defaultPolicy | string | Default policy for user agents (e.g., “allow”). |
| ---- data.playbackIds[].accessRestrictions.userAgents.allow | array | List of allowed user agents. |
| ---- data.playbackIds[].accessRestrictions.userAgents.deny | array | List of denied user agents. |
| - data.tracks | array | List of tracks in the media. |
| — data.tracks[].id | string | Unique identifier for the track (e.g., “a3354699-4b60-4c51-bfcb-bbdbb2f05d41”). |
| — data.tracks[].type | string | Type of the track (e.g., “audio”, “video”). |
| — data.tracks[].status | string | Status of the track (e.g., “available”). |
| — data.tracks[].width | integer | Width of the video track (e.g., 1920). |
| — data.tracks[].height | integer | Height of the video track (e.g., 1080). |
| — data.tracks[].frameRate | string | Frame rate of the video track (e.g., “60.000”). |
| — data.tracks[].languageCode | string | Language code for audio/subtitle track (e.g., “und”). |
| — data.tracks[].languageName | string | Full language name for audio/subtitle track (e.g., “default”). |
| - data.sourceAccess | boolean | Indicates if source access is enabled (e.g., false). |
| - data.mp4Support | string | Indicates MP4 support (e.g., “none”). |
| - data.optimizeAudio | boolean | Indicates if audio optimization is enabled (e.g., false). |
| - data.duration | string | Duration of the media (e.g., “00:00:20”). |
| - data.aspectRatio | string | Aspect ratio of the media (e.g., “16:9”). |
| - data.createdAt | string (ISO 8601) | Timestamp when the media was created. |
| - data.updatedAt | string (ISO 8601) | Timestamp when the media was last updated. |
| - data.mediaQuality | string | Media quality tier for the media (e.g., “pro”). |
| createdAt | string (ISO 8601) | Timestamp when the event was created. |
| attempts | array | List of attempts made to deliver the webhook. |
| - attempts[].webhookId | string | Unique identifier for the webhook attempt. |
| - attempts[].responseStatusCode | integer | HTTP status code of the response. |
| - attempts[].responseHeaders | object | Response headers for the webhook attempt. |
| — attempts[].responseHeaders.contentType | string | Content type of the response. |
| — attempts[].responseHeaders.transfer | ||
| — attempts[].responseHeaders.server | string | Server used for the response. |
| — attempts[].responseHeaders.date | string | Date of the response. |
| — attempts[].responseHeaders.cacheControl | ||
| - attempts[].responseBody | string | Body of the response. |
| - attempts[].maxAttempts | integer | Maximum number of retry attempts. |
| - attempts[].id | string | Unique identifier for the attempt. |
| - attempts[].createdAt | string (ISO 8601) | Timestamp when the attempt was created. |
| - attempts[].address | string | URL address of the webhook. |
video.media.impose_tracks.ready
Triggered when a secondary audio track, such as background music, commentary, or narration, has been successfully imposed onto the original media. This event confirms that the overlay audio has been applied and the updated media is ready.
| Name | Type | Description |
|---|---|---|
| type | string | Type of event (e.g., “video.media.impose_tracks.ready”). |
| object | object | Object information. |
| - object.type | string | Type of the object (e.g., “media”). |
| - object.id | string | Unique identifier for the object (e.g., “5856ade0-2531-400a-a715-9c19e4ca4526”). |
| id | string | Unique identifier for the event. |
| workspace | object | Workspace information. |
| - workspace.name | string | Name of the workspace (e.g., “Development”). |
| - workspace.id | string | Unique identifier for the workspace (e.g., “338acdeb-29d4-438b-a40c-1d4105134462”). |
| status | string | Status of the media (e.g., “ready”). |
| data | object | |
| - data.thumbnail | string (URL) | URL for the thumbnail image. |
| - data.id | string | Unique identifier for the media (e.g., “5856ade0-2531-400a-a715-9c19e4ca4526”). |
| - data.workspaceId | string | Unique identifier for the workspace (e.g., “338acdeb-29d4-438b-a40c-1d4105134462”). |
| - data.metadata | object | Metadata associated with the media. |
| — data.metadata.key1 | string | Key-value pair for metadata (e.g., “key1”: “value1”). |
| - data.maxResolution | string | Maximum resolution for encoding, storing, and streaming media (e.g., “1080p”). |
| - data.sourceResolution | string | Source resolution of the media (e.g., “1080”). |
| - data.playbackIds | array | List of playback IDs. |
| — data.playbackIds[].id | string | Unique identifier for the playback ID (e.g., “7e247e74-10d6-48d1-9b08-2569aae1c2e9”). |
| — data.playbackIds[].accessPolicy | string | Access policy for playback IDs (e.g., “public”). |
| — data.playbackIds[].accessRestrictions | object | Access restrictions for domains and user agents. |
| --- data.playbackIds[].accessRestrictions.domains | object | Domain-based access restrictions. |
| ---- data.playbackIds[].accessRestrictions.domains.defaultPolicy | string | Default policy for domains (e.g., “allow”). |
| ---- data.playbackIds[].accessRestrictions.domains.allow | array | List of allowed domains. |
| ---- data.playbackIds[].accessRestrictions.domains.deny | array | List of denied domains. |
| --- data.playbackIds[].accessRestrictions.userAgents | object | User agent-based access restrictions. |
| ---- data.playbackIds[].accessRestrictions.userAgents.defaultPolicy | string | Default policy for user agents (e.g., “allow”). |
| ---- data.playbackIds[].accessRestrictions.userAgents.allow | array | List of allowed user agents. |
| ---- data.playbackIds[].accessRestrictions.userAgents.deny | array | List of denied user agents. |
| - data.tracks | array | List of tracks in the media. |
| — data.tracks[].id | string | Unique identifier for the track (e.g., “3315aaf7-cb10-4c6c-999b-fb009320ec72”). |
| — data.tracks[].type | string | Type of the track (e.g., “audio”, “video”). |
| — data.tracks[].status | string | Status of the track (e.g., “available”). |
| — data.tracks[].width | integer | Width of the video track (e.g., 1920). |
| — data.tracks[].height | integer | Height of the video track (e.g., 1080). |
| — data.tracks[].frameRate | string | Frame rate of the video track (e.g., “60.000”). |
| — data.tracks[].languageCode | string | Language code for audio/subtitle track (e.g., “und”). |
| — data.tracks[].languageName | string | Full language name for audio/subtitle track (e.g., “default”). |
| - data.sourceAccess | boolean | Indicates if source access is enabled (e.g., false). |
| - data.mp4Support | string | Indicates MP4 support (e.g., “none”). |
| - data.optimizeAudio | boolean | Indicates if audio optimization is enabled (e.g., false). |
| - data.duration | string | Duration of the media (e.g., “00:00:10”). |
| - data.aspectRatio | string | Aspect ratio of the media (e.g., “16:9”). |
| - data.createdAt | string (ISO 8601) | Timestamp when the media was created (e.g., “2026-07-01T10:14:54.107545Z”). |
| - data.updatedAt | string (ISO 8601) | Timestamp when the media was last updated (e.g., “2026-07-01T10:15:09.820658Z”). |
| - data.mediaQuality | string | Media quality tier for the media (e.g., “pro”). |
| createdAt | string (ISO 8601) | Timestamp when the event was created (e.g., “2025-04-07T11:12:02.500514594Z”). |
| attempts | array | List of attempts made to deliver the webhook. |
| - attempts[].webhookId | string | Unique identifier for the webhook attempt (e.g., “3b0ab5b1-6523-4c13-8012-1d096c150b8e”). |
| - attempts[].responseStatusCode | integer | HTTP status code of the response (e.g., 404). |
| - attempts[].responseHeaders | object | Response headers for the webhook attempt. |
| — attempts[].responseHeaders.contentType | string | Content type of the response (e.g., “application/json”). |
| — attempts[].responseHeaders.transfer | ||
| — attempts[].responseHeaders.server | string | Server used for the response (e.g., “nginx”). |
| — attempts[].responseHeaders.date | string | Date of the response (e.g., “Mon, 07 Apr 2025 11:12:02 GMT”). |
| — attempts[].responseHeaders.cacheControl | ||
| - attempts[].responseBody | string | Body of the response (e.g., "{\"success\":false,...}"). |
| - attempts[].maxAttempts | integer | Maximum number of retry attempts (e.g., 30). |
| - attempts[].id | string | Unique identifier for the attempt (e.g., “540685ef-39c0-4f4d-b258-ee04b353f2a9”). |
| - attempts[].createdAt | string (ISO 8601) | Timestamp when the attempt was created (e.g., “2025-04-07T11:12:02.500514594Z”). |
| - attempts[].address | string | URL address of the webhook (e.g., “https://webhook.site/24618f1c-c82c-4588-b9c6-1d86aac2a9b3”). |
video.media.audio_swap.ready
Triggered when the original audio track of a media asset has been successfully replaced with a new one. This event is useful for confirming audio replacement, such as switching to a different language track or updating the audio mix.
| Name | Type | Description |
|---|---|---|
| type | string | Type of event (e.g., “video.media.audio_swap.ready”). |
| object | object | Object information. |
| - object.type | string | Type of the object (e.g., “media”). |
| - object.id | string | Unique identifier for the object (e.g., “5856ade0-2531-400a-a715-9c19e4ca4526”). |
| id | string | Unique identifier for the event. |
| workspace | object | Workspace information. |
| - workspace.name | string | Name of the workspace (e.g., “Development”). |
| - workspace.id | string | Unique identifier for the workspace (e.g., “338acdeb-29d4-438b-a40c-1d4105134462”). |
| status | string | Status of the media (e.g., “ready”). |
| data | object | |
| - data.thumbnail | string (URL) | URL for the thumbnail image. |
| - data.id | string | Unique identifier for the media (e.g., “5856ade0-2531-400a-a715-9c19e4ca4526”). |
| - data.workspaceId | string | Unique identifier for the workspace (e.g., “338acdeb-29d4-438b-a40c-1d4105134462”). |
| - data.metadata | object | Metadata associated with the media. |
| — data.metadata.key1 | string | Key-value pair for metadata (e.g., “key1”: “value1”). |
| - data.maxResolution | string | Maximum resolution for encoding, storing, and streaming media (e.g., “1080p”). |
| - data.sourceResolution | string | Source resolution of the media (e.g., “1080”). |
| - data.playbackIds | array | List of playback IDs. |
| — data.playbackIds[].id | string | Unique identifier for the playback ID (e.g., “7e247e74-10d6-48d1-9b08-2569aae1c2e9”). |
| — data.playbackIds[].accessPolicy | string | Access policy for playback IDs (e.g., “public”). |
| — data.playbackIds[].accessRestrictions | object | Access restrictions for domains and user agents. |
| --- data.playbackIds[].accessRestrictions.domains | object | Domain-based access restrictions. |
| ---- data.playbackIds[].accessRestrictions.domains.defaultPolicy | string | Default policy for domains (e.g., “allow”). |
| ---- data.playbackIds[].accessRestrictions.domains.allow | array | List of allowed domains. |
| ---- data.playbackIds[].accessRestrictions.domains.deny | array | List of denied domains. |
| --- data.playbackIds[].accessRestrictions.userAgents | object | User agent-based access restrictions. |
| ---- data.playbackIds[].accessRestrictions.userAgents.defaultPolicy | string | Default policy for user agents (e.g., “allow”). |
| ---- data.playbackIds[].accessRestrictions.userAgents.allow | array | List of allowed user agents. |
| ---- data.playbackIds[].accessRestrictions.userAgents.deny | array | List of denied user agents. |
| - data.tracks | array | List of tracks in the media. |
| — data.tracks[].id | string | Unique identifier for the track (e.g., “3315aaf7-cb10-4c6c-999b-fb009320ec72”). |
| — data.tracks[].type | string | Type of the track (e.g., “audio”, “video”). |
| — data.tracks[].status | string | Status of the track (e.g., “available”). |
| — data.tracks[].width | integer | Width of the video track (e.g., 1920). |
| — data.tracks[].height | integer | Height of the video track (e.g., 1080). |
| — data.tracks[].frameRate | string | Frame rate of the video track (e.g., “60.000”). |
| — data.tracks[].languageCode | string | Language code for audio/subtitle track (e.g., “und”). |
| — data.tracks[].languageName | string | Full language name for audio/subtitle track (e.g., “default”). |
| - data.sourceAccess | boolean | Indicates if source access is enabled (e.g., false). |
| - data.mp4Support | string | Indicates MP4 support (e.g., “none”). |
| - data.optimizeAudio | boolean | Indicates if audio optimization is enabled (e.g., false). |
| - data.duration | string | Duration of the media (e.g., “00:00:10”). |
| - data.aspectRatio | string | Aspect ratio of the media (e.g., “16:9”). |
| - data.createdAt | string (ISO 8601) | Timestamp when the media was created (e.g., “2026-07-01T10:14:54.107545Z”). |
| - data.updatedAt | string (ISO 8601) | Timestamp when the media was last updated (e.g., “2026-07-01T10:15:09.820658Z”). |
| - data.mediaQuality | string | Media quality tier for the media (e.g., “pro”). |
| createdAt | string (ISO 8601) | Timestamp when the event was created. |
| attempts | array | List of attempts to deliver the webhook. |
| - attempts[].webhookId | string | Webhook attempt ID. |
| - attempts[].responseStatusCode | integer | HTTP status code (e.g., 404). |
| - attempts[].responseHeaders | object | Response headers. |
| — attempts[].responseHeaders.contentType | string | Content type (e.g., “application/json”). |
| — attempts[].responseHeaders.transfer | ||
| — attempts[].responseHeaders.server | string | Server used (e.g., “nginx”). |
| — attempts[].responseHeaders.date | string | Date of the response. |
| — attempts[].responseHeaders.cacheControl | ||
| - attempts[].responseBody | string | Body of the response (e.g., "{\"success\":false,...}"). |
| - attempts[].maxAttempts | integer | Maximum retry attempts (e.g., 30). |
| - attempts[].id | string | Unique identifier for the attempt. |
| - attempts[].createdAt | string (ISO 8601) | Timestamp when the attempt was created. |
| - attempts[].address | string | URL address of the webhook. |
video.media.watermark.ready
Triggered when watermarking has been successfully applied to the media. This can include logos, text overlays, or identifiers used for branding, content protection, or tracking.
| Name | Type | Description |
|---|---|---|
| type | string | Type of event (e.g., “video.media.watermark.ready”). |
| object | object | Object information. |
| - object.type | string | Type of the object (e.g., “media”). |
| - object.id | string | Unique identifier for the object (e.g., “242923d6-1669-467a-9626-8b41862fb2b6”). |
| id | string | Unique identifier for the event (e.g., “f16d9be0-79b1-4ee1-aaa8-516e8737f13d”). |
| workspace | object | Workspace information. |
| - workspace.name | string | Name of the workspace (e.g., “Development”). |
| - workspace.id | string | Unique identifier for the workspace (e.g., “6dc2b4e0-0615-42fd-a580-1f4aad932dfe”). |
| status | string | Status of the media (e.g., “ready”). |
| data | object | |
| - data.thumbnail | string (URL) | URL for the thumbnail image (e.g., “https://images.fastpix.com/fb1e2e4d-e7ef-4ff7-8784-15415dc955b9/thumbnail.png”). |
| - data.id | string | Unique identifier for the media (e.g., “1ecccf5f-970f-447e-b038-27b3a3c86642”). |
| - data.workspaceId | string | Unique identifier for the workspace (e.g., “6dc2b4e0-0615-42fd-a580-1f4aad932dfe”). |
| - data.metadata | object | Metadata associated with the media. |
| — data.metadata.key1 | string | Key-value pair for metadata (e.g., “key1”: “value1”). |
| - data.maxResolution | string | Maximum resolution for encoding, storing, and streaming media (e.g., “1080p”). |
| - data.sourceResolution | string | Source resolution of the media (e.g., “1080p”). |
| - data.playbackIds | array | List of playback IDs. |
| — data.playbackIds[].id | string | Unique identifier for the playback ID (e.g., “fb1e2e4d-e7ef-4ff7-8784-15415dc955b9”). |
| — data.playbackIds[].accessPolicy | string | Access policy for playback IDs (e.g., “public”). |
| — data.playbackIds[].accessRestrictions | object | Access restrictions for domains and user agents. |
| --- data.playbackIds[].accessRestrictions.domains | object | Domain-based access restrictions. |
| ---- data.playbackIds[].accessRestrictions.domains.defaultPolicy | string | Default policy for domains (e.g., “allow”). |
| ---- data.playbackIds[].accessRestrictions.domains.allow | array | List of allowed domains. |
| ---- data.playbackIds[].accessRestrictions.domains.deny | array | List of denied domains. |
| --- data.playbackIds[].accessRestrictions.userAgents | object | User agent-based access restrictions. |
| ---- data.playbackIds[].accessRestrictions.userAgents.defaultPolicy | string | Default policy for user agents (e.g., “allow”). |
| ---- data.playbackIds[].accessRestrictions.userAgents.allow | array | List of allowed user agents. |
| ---- data.playbackIds[].accessRestrictions.userAgents.deny | array | List of denied user agents. |
| - data.tracks | array | List of tracks in the media. |
| — data.tracks[].id | string | Unique identifier for the track (e.g., “0b6b28c7-9039-48ef-8599-8f31f77331d7”). |
| — data.tracks[].type | string | Type of the track (e.g., “video”). |
| — data.tracks[].width | integer | Width of the video track (e.g., 1920). |
| — data.tracks[].height | integer | Height of the video track (e.g., 1080). |
| — data.tracks[].frameRate | string | Frame rate of the video track (e.g., “30/1”). |
| — data.tracks[].status | string | Status of the track (e.g., “available”). |
| — data.tracks[].languageCode | string | Language code for audio/subtitle track (e.g., “und”). |
| — data.tracks[].languageName | string | Full language name for audio/subtitle track (e.g., “default”). |
| - data.watermark | object | Watermark details. |
| — data.watermark.type | string | Type of watermark (e.g., “watermark”). |
| — data.watermark.url | string (URL) | URL for the watermark image (e.g., “https://images.fastpix.com/491f3b46-4edb-48e4-8a48-9a7d8f305b57/thumbnail.jpg”). |
| — data.watermark.placement | object | Placement settings for the watermark. |
| --- data.watermark.placement.xAlign | string | Horizontal alignment of the watermark (e.g., “left”). |
| --- data.watermark.placement.xMargin | string | Margin for horizontal alignment (e.g., “10%”). |
| --- data.watermark.placement.yAlign | string | Vertical alignment of the watermark (e.g., “top”). |
| --- data.watermark.placement.yMargin | string | Margin for vertical alignment (e.g., “10%”). |
| — data.watermark.width | string | Width of the watermark (e.g., “25%”). |
| — data.watermark.height | string | Height of the watermark (e.g., “25%”). |
| — data.watermark.opacity | string | Opacity of the watermark (e.g., “80%”). |
| - data.sourceAccess | boolean | Indicates if source access is enabled (e.g., false). |
| - data.mp4Support | string | Indicates MP4 support (e.g., “none”). |
| - data.optimizeAudio | boolean | Indicates if audio optimization is enabled (e.g., false). |
| - data.duration | string | Duration of the media (e.g., “00:00:10”). |
| - data.aspectRatio | string | Aspect ratio of the media (e.g., “16:9”). |
| - data.createdAt | string (ISO 8601) | Timestamp when the media was created (e.g., “2025-04-07T11:56:54.784770Z”). |
| - data.updatedAt | string (ISO 8601) | Timestamp when the media was last updated (e.g., “2025-04-07T11:57:04.257665Z”). |
| - data.mediaQuality | string | Media quality tier for the media (e.g., “pro”). |
| createdAt | string (ISO 8601) | Timestamp when the event was created (e.g., “2025-04-07T11:57:04.558060392Z”). |
| attempts | array | List of attempts made to deliver the webhook. |
| - attempts[].webhookId | string | Unique identifier for the webhook attempt (e.g., “3b0ab5b1-6523-4c13-8012-1d096c150b8e”). |
| - attempts[].responseStatusCode | integer | HTTP status code of the response (e.g., 404). |
| - attempts[].responseHeaders | object | Response headers for the webhook attempt. |
| — attempts[].responseHeaders.contentType | string | Content type of the response (e.g., “application/json”). |
| — attempts[].responseHeaders.server | string | Server used for the response (e.g., “nginx”). |
| — attempts[].responseHeaders.date | string | Date of the response (e.g., “Mon, 07 Apr 2025 11:57:04 GMT”). |
| - attempts[].responseBody | string | Body of the response (e.g., "{\"success\":false,...}"). |
| - attempts[].maxAttempts | integer | Maximum number of retry attempts (e.g., 30). |
| - attempts[].id | string | Unique identifier for the attempt (e.g., “532d7b38-c538-4697-888e-58ac3a38ab8f”). |
| - attempts[].createdAt | string (ISO 8601) | Timestamp when the attempt was created (e.g., “2025-04-07T11:57:04.558060392Z”). |
| - attempts[].address | string | URL address of the webhook (e.g., “https://webhook.site/24618f1c-c82c-4588-b9c6-1d86aac2a9b3”). |
video.media.optimize_audio.ready
Triggered when audio loudness normalization have been successfully completed. Use this event to confirm that the audio quality has been enhanced and is ready for delivery.
| Name | Type | Description |
|---|---|---|
| type | string | Type of event (e.g., “video.media.optimize_audio.ready”). |
| object | object | Object information. |
| - object.type | string | Type of the object (e.g., “media”). |
| - object.id | string | Unique identifier for the object (e.g., “b9856f45-e166-4e11-b05c-c0e13dafd656”). |
| id | string | Unique identifier for the event. |
| workspace | object | Workspace information. |
| - workspace.name | string | Name of the workspace (e.g., “Development”). |
| - workspace.id | string | Unique identifier for the workspace (e.g., “338acdeb-29d4-438b-a40c-1d4105134462”). |
| status | string | Status of the media (e.g., “ready”). |
| data | object | |
| - data.thumbnail | string (URL) | URL for the thumbnail image. |
| - data.id | string | Unique identifier for the media (e.g., “b9856f45-e166-4e11-b05c-c0e13dafd656”). |
| - data.workspaceId | string | Unique identifier for the workspace (e.g., “338acdeb-29d4-438b-a40c-1d4105134462”). |
| - data.maxResolution | string | Maximum resolution for encoding, storing, and streaming media (e.g., “1080p”). |
| - data.sourceResolution | string | Source resolution of the media (e.g., “1080”). |
| - data.playbackIds | array | List of playback IDs. |
| — data.playbackIds[].id | string | Unique identifier for the playback ID (e.g., “208a6a37-7a80-4bbe-bd09-c63a2c7b7fc1”). |
| — data.playbackIds[].accessPolicy | string | Access policy for playback IDs (e.g., “public”). |
| — data.playbackIds[].accessRestrictions | object | Access restrictions for domains and user agents. |
| --- data.playbackIds[].accessRestrictions.domains | object | Domain-based access restrictions. |
| ---- data.playbackIds[].accessRestrictions.domains.defaultPolicy | string | Default policy for domains (e.g., “allow”). |
| ---- data.playbackIds[].accessRestrictions.domains.allow | array | List of allowed domains. |
| ---- data.playbackIds[].accessRestrictions.domains.deny | array | List of denied domains. |
| --- data.playbackIds[].accessRestrictions.userAgents | object | User agent-based access restrictions. |
| ---- data.playbackIds[].accessRestrictions.userAgents.defaultPolicy | string | Default policy for user agents (e.g., “allow”). |
| ---- data.playbackIds[].accessRestrictions.userAgents.allow | array | List of allowed user agents. |
| ---- data.playbackIds[].accessRestrictions.userAgents.deny | array | List of denied user agents. |
| - data.tracks | array | List of tracks in the media. |
| — data.tracks[].id | string | Unique identifier for the track (e.g., “907d16cb-9c8e-45be-8543-f72f70c4a6be”). |
| — data.tracks[].type | string | Type of the track (e.g., “audio”, “video”). |
| — data.tracks[].status | string | Status of the track (e.g., “available”). |
| — data.tracks[].width | integer | Width of the video track (e.g., 1920). |
| — data.tracks[].height | integer | Height of the video track (e.g., 1080). |
| — data.tracks[].frameRate | string | Frame rate of the video track (e.g., “60.000”). |
| — data.tracks[].languageCode | string | Language code for audio/subtitle track (e.g., “und”). |
| — data.tracks[].languageName | string | Full language name for audio/subtitle track (e.g., “default”). |
| - data.sourceAccess | boolean | Indicates if source access is enabled (e.g., false). |
| - data.mp4Support | string | Indicates MP4 support (e.g., “none”). |
| - data.optimizeAudio | boolean | Indicates if audio optimization is enabled (e.g., true). |
| - data.duration | string | Duration of the media (e.g., “00:00:10”). |
| - data.aspectRatio | string | Aspect ratio of the media (e.g., “16:9”). |
| - data.createdAt | string (ISO 8601) | Timestamp when the media was created. |
| - data.updatedAt | string (ISO 8601) | Timestamp when the media was last updated. |
| - data.mediaQuality | string | Media quality tier for the media (e.g., “pro”). |
| createdAt | string (ISO 8601) | Timestamp when the event was created (e.g., “2025-04-07T11:12:02.500514594Z”). |
| attempts | array | List of attempts made to deliver the webhook. |
| - attempts[].webhookId | string | Unique identifier for the webhook attempt (e.g., “3b0ab5b1-6523-4c13-8012-1d096c150b8e”). |
| - attempts[].responseStatusCode | integer | HTTP status code of the response (e.g., 404). |
| - attempts[].responseHeaders | object | Response headers for the webhook attempt. |
| — attempts[].responseHeaders.contentType | string | Content type of the response (e.g., “application/json”). |
| — attempts[].responseHeaders.transfer | ||
| — attempts[].responseHeaders.server | string | Server used for the response (e.g., “nginx”). |
| — attempts[].responseHeaders.date | string | Date of the response (e.g., “Mon, 07 Apr 2025 11:12:02 GMT”). |
| — attempts[].responseHeaders.cacheControl | ||
| - attempts[].responseBody | string | Body of the response (e.g., "{\"success\":false,...}"). |
| - attempts[].maxAttempts | integer | Maximum number of retry attempts (e.g., 30). |
| - attempts[].id | string | Unique identifier for the attempt (e.g., “540685ef-39c0-4f4d-b258-ee04b353f2a9”). |
| - attempts[].createdAt | string (ISO 8601) | Timestamp when the attempt was created (e.g., “2025-04-07T11:12:02.500514594Z”). |
| - attempts[].address | string | URL address of the webhook (e.g., “https://webhook.site/24618f1c-c82c-4588-b9c6-1d86aac2a9b3”). |
video.media.mp4Support.ready
Triggered when an MP4-compatible version of the media has been generated for download purposes. This event helps ensure that the media is available in the widely supported MP4 format for playback across different devices, browsers, or platforms.
| Type | Name | Description |
|---|---|---|
| string | type | Type of event (e.g., “video.media.mp4Support.ready”). |
| object | object | Information about the object associated with the event. |
| string | - object.type | Type of the object (e.g., “media”). |
| string | - object.id | Unique identifier for the object (e.g., “bf50bd74-7ffa-4d7a-b132-0fec511c2d2b”). |
| string | id | Unique identifier for the event (e.g., “96a25b6c-e578-45d9-baf2-dea6449df653”). |
| object | workspace | Workspace information. |
| string | - workspace.name | Name of the workspace (e.g., “Development”). |
| string | - workspace.id | Unique identifier for the workspace (e.g., “338acdeb-29d4-438b-a40c-1d4105134462”). |
| string | status | Status of the media (e.g., “ready”). |
| object | data | |
| string (URL) | - data.thumbnail | URL for the thumbnail image. |
| string | - data.id | Unique identifier for the media (e.g., “bf50bd74-7ffa-4d7a-b132-0fec511c2d2b”). |
| string | - data.workspaceId | Unique identifier for the workspace (e.g., “338acdeb-29d4-438b-a40c-1d4105134462”). |
| object | - data.metadata | Metadata associated with the media. |
| string | — data.metadata.key1 | Key-value pair for metadata (e.g., “key1”: “value1”). |
| string | - data.maxResolution | Maximum resolution for encoding, storing, and streaming media (e.g., “1080p”). |
| string | - data.sourceResolution | Source resolution of the media (e.g., “1440”). |
| array | - data.playbackIds | List of playback IDs. |
| string | — data.playbackIds[].id | Unique identifier for the playback ID (e.g., “adadf5d8-58ee-4689-8f57-99b5cd9bed84”). |
| string | — data.playbackIds[].accessPolicy | Access policy for playback IDs (e.g., “public”). |
| object | — data.playbackIds[].accessRestrictions | Access restrictions for domains and user agents. |
| object | --- data.playbackIds[].accessRestrictions.domains | Domain-based access restrictions. |
| string | ---- data.playbackIds[].accessRestrictions.domains.defaultPolicy | Default policy for domains (e.g., “allow”). |
| array | ---- data.playbackIds[].accessRestrictions.domains.allow | List of allowed domains. |
| array | ---- data.playbackIds[].accessRestrictions.domains.deny | List of denied domains. |
| object | --- data.playbackIds[].accessRestrictions.userAgents | User agent-based access restrictions. |
| string | ---- data.playbackIds[].accessRestrictions.userAgents.defaultPolicy | Default policy for user agents (e.g., “allow”). |
| array | ---- data.playbackIds[].accessRestrictions.userAgents.allow | List of allowed user agents. |
| array | ---- data.playbackIds[].accessRestrictions.userAgents.deny | List of denied user agents. |
| array | - data.tracks | List of tracks in the media. |
| string | — data.tracks[].id | Unique identifier for the track (e.g., “22ac5233-27a8-47a3-9e47-34426c4eeee2”). |
| string | — data.tracks[].type | Type of the track (e.g., “video”). |
| string | — data.tracks[].status | Status of the track (e.g., “available”). |
| integer | — data.tracks[].width | Width of the video track (e.g., 2560). |
| integer | — data.tracks[].height | Height of the video track (e.g., 1440). |
| string | — data.tracks[].frameRate | Frame rate of the video track (e.g., “23.976”). |
| boolean | - data.sourceAccess | Indicates if source access is enabled (e.g., false). |
| string | - data.mp4Support | Indicates MP4 support (e.g., “capped_4k”). |
| string | - data.duration | Duration of the media (e.g., “00:00:20”). |
| string | - data.frameRate | Frame rate of the media (e.g., “23.976”). |
| string | - data.aspectRatio | Aspect ratio of the media (e.g., “16:9”). |
| string (ISO 8601) | - data.createdAt | Timestamp when the media was created (e.g., “2026-07-01T09:44:26.631207Z”). |
| string (ISO 8601) | - data.updatedAt | Timestamp when the media was last updated (e.g., “2026-07-01T09:44:32.906796Z”). |
| string | - data.mediaQuality | Media quality tier for the media (e.g., “pro”). |
| boolean | - data.isAudioOnly | Whether the media contains only audio (e.g., false). |
| string | - data.title | Title of the media (e.g., “15485931_2560_1440_24fps”). |
| boolean | - data.subtitleAvailable | Whether subtitles are available (e.g., false). |
| array | - data.generatedSubtitles | List of generated subtitles for the media. |
| string | - data.status | Processing status of the media (e.g., “Ready”). |
| string (ISO 8601) | createdAt | Timestamp when the event was created (e.g., “2025-04-07T11:12:02.500514594Z”). |
| array | attempts | List of attempts made to deliver the webhook. |
| string | - attempts[].webhookId | Unique identifier for the webhook attempt (e.g., “3b0ab5b1-6523-4c13-8012-1d096c150b8e”). |
| integer | - attempts[].responseStatusCode | HTTP status code of the response (e.g., 404). |
| object | - attempts[].responseHeaders | Response headers for the webhook attempt. |
| string | — attempts[].responseHeaders.contentType | Content type of the response (e.g., “application/json”). |
| — attempts[].responseHeaders.transfer | ||
| string | — attempts[].responseHeaders.server | Server used for the response (e.g., “nginx”). |
| string | — attempts[].responseHeaders.date | Date of the response (e.g., “Mon, 07 Apr 2025 11:12:02 GMT”). |
| — attempts[].responseHeaders.cacheControl | ||
| string | - attempts[].responseBody | Body of the response (e.g., "{\"success\":false,...}"). |
| integer | - attempts[].maxAttempts | Maximum number of retry attempts (e.g., 30). |
| string | - attempts[].id | Unique identifier for the attempt (e.g., “540685ef-39c0-4f4d-b258-ee04b353f2a9”). |
| string (ISO 8601) | - attempts[].createdAt | Timestamp when the attempt was created (e.g., “2025-04-07T11:12:02.500514594Z”). |
| string | - attempts[].address | URL address of the webhook (e.g., “https://webhook.site/24618f1c-c82c-4588-b9c6-1d86aac2a9b3”). |
video.media.mp4Support.updated
Triggered when the MP4 support setting for a media asset is updated — for example, when MP4 renditions are enabled, changed (e.g., to capped_4k), or disabled. Use this event to keep your system in sync with the latest MP4 download availability for the media.
| Type | Name | Description |
|---|---|---|
| string | type | Type of event (e.g., “video.media.mp4Support.updated”). |
| object | object | Information about the object associated with the event. |
| string | - object.type | Type of the object (e.g., “media”). |
| string | - object.id | Unique identifier for the object (e.g., “7fd85747-8691-47f7-bed8-c7edd42bac5c”). |
| string | id | Unique identifier for the event (e.g., “15af9e4b-318a-430e-accc-8385cfdcbe0c”). |
| object | workspace | Workspace information. |
| string | - workspace.name | Name of the workspace (e.g., “Development”). |
| string | - workspace.id | Unique identifier for the workspace (e.g., “338acdeb-29d4-438b-a40c-1d4105134462”). |
| string | status | Status of the media (e.g., “media_created”). |
| object | data | |
| string | - data.streamId | Unique identifier for the stream (e.g., “801e53fffd820ad3b0b0ccdc4669cdf3”). |
| string | - data.status | Processing status of the media (e.g., “Ready”). |
| string | - data.maxResolution | Maximum resolution for encoding, storing, and streaming media (e.g., “1080p”). |
| string (ISO 8601) | - data.createdAt | Timestamp when the media was created (e.g., “2026-07-01T09:29:59.790769Z”). |
| array | - data.playbackIds | List of playback IDs. |
| string | — data.playbackIds[].id | Unique identifier for the playback ID (e.g., “b1a9a4ae-aba9-40b3-953e-7b23fdeb99a5”). |
| string | — data.playbackIds[].accessPolicy | Access policy for playback IDs (e.g., “public”). |
| object | — data.playbackIds[].accessRestrictions | Access restrictions for domains and user agents. |
| object | --- data.playbackIds[].accessRestrictions.userAgents | User agent-based access restrictions. |
| string | ---- data.playbackIds[].accessRestrictions.userAgents.defaultPolicy | Default policy for user agents (e.g., “allow”). |
| array | ---- data.playbackIds[].accessRestrictions.userAgents.allow | List of allowed user agents. |
| array | ---- data.playbackIds[].accessRestrictions.userAgents.deny | List of denied user agents. |
| object | --- data.playbackIds[].accessRestrictions.domains | Domain-based access restrictions. |
| string | ---- data.playbackIds[].accessRestrictions.domains.defaultPolicy | Default policy for domains (e.g., “allow”). |
| array | ---- data.playbackIds[].accessRestrictions.domains.allow | List of allowed domains. |
| array | ---- data.playbackIds[].accessRestrictions.domains.deny | List of denied domains. |
| string | - data.mediaQuality | Media quality tier for the media (e.g., “pro”). |
| string (URL) | - data.thumbnail | URL for the thumbnail image. |
| string | - data.mp4Support | Indicates MP4 support (e.g., “capped_4k”). |
| string | - data.sourceResolution | Source resolution of the media (e.g., “1080”). |
| boolean | - data.sourceAccess | Indicates if source access is enabled (e.g., false). |
| boolean | - data.isAudioOnly | Whether the media contains only audio (e.g., false). |
| string | - data.aspectRatio | Aspect ratio of the media (e.g., “16:9”). |
| boolean | - data.subtitleAvailable | Whether subtitles are available (e.g., false). |
| array | - data.tracks | List of tracks in the media. |
| string | — data.tracks[].id | Unique identifier for the track (e.g., “1688a6a1-c8da-4097-8dd7-1a1a5cee2d05”). |
| string | — data.tracks[].type | Type of the track (e.g., “audio”, “video”). |
| string | — data.tracks[].status | Status of the track (e.g., “available”). |
| string | — data.tracks[].languageCode | Language code for audio/subtitle track (e.g., “und”). |
| string | — data.tracks[].languageName | Full language name for audio/subtitle track (e.g., “default”). |
| integer | — data.tracks[].width | Width of the video track (e.g., 1920). |
| integer | — data.tracks[].height | Height of the video track (e.g., 1080). |
| string | — data.tracks[].frameRate | Frame rate of the video track (e.g., “30.000”). |
| string | - data.duration | Duration of the media (e.g., “00:02:14”). |
| array | - data.generatedSubtitles | List of generated subtitles for the media. |
| string | - data.id | Unique identifier for the media (e.g., “7fd85747-8691-47f7-bed8-c7edd42bac5c”). |
| string | - data.workspaceId | Unique identifier for the workspace (e.g., “338acdeb-29d4-438b-a40c-1d4105134462”). |
| string (ISO 8601) | - data.updatedAt | Timestamp when the media was last updated (e.g., “2026-07-01T09:30:07.354131Z”). |
| string (ISO 8601) | createdAt | Timestamp when the event was created (e.g., “2026-07-01T09:46:39.131028066Z”). |
| array | attempts | List of attempts made to deliver the webhook. |
video.media.subtitle.generated
Triggered when subtitles or captions have been automatically generated for the media asset. This event indicates that the text-based subtitles are ready and can be synced with the video for accessibility or multi-language support.
| Name | Type | Description |
|---|---|---|
| type | string | Type of event (e.g., “video.media.subtitle.generated”). |
| object | object | Object information. |
| - object.type | string | Type of the object (e.g., "media"). |
| - object.id | string | Unique identifier for the object (e.g., "ed1a05da-af31-429f-8447-3153e206d1f8"). |
| id | string | Unique identifier for the event (e.g., “ef15ae30-a8ab-41f6-a786-152b7728028a”). |
| workspace | object | Workspace information. |
| - workspace.name | string | Name of the workspace (e.g., “Production”). |
| - workspace.id | string | Unique identifier for the workspace (e.g., “49deae57-a732-42d4-87b2-6179cc682d07”). |
| status | string | Status of the media (e.g., “media_created”). |
| data | object | |
| - data.id | string | Unique identifier for the subtitle track (e.g., "44964a73-8f54-42d0-989a-09e380ce4f53"). |
| - data.type | string | Type of the track (e.g., "subtitle"). |
| - data.languageCode | string | Language code of the subtitle (e.g., "en"). |
| - data.languageName | string | Language name of the subtitle (e.g., "english"). |
| - data.status | string | Status of the subtitle track (e.g., "available"). |
| createdAt | string (ISO 8601) | Timestamp when the event was created (e.g., “2025-03-18T11:47:07.805413906Z”). |
| attempts | array | List of attempts made to deliver the webhook. |
| - attempts[].webhookId | string | Unique identifier for the webhook attempt (e.g., “3b0ab5b1-6523-4c13-8012-1d096c150b8e”). |
| - attempts[].responseStatusCode | integer | HTTP status code of the response (e.g., 404). |
| - attempts[].responseHeaders | object | Response headers for the webhook attempt. |
| — attempts[].responseHeaders.contentType | string | Content type of the response (e.g., “application/json”). |
| — attempts[].responseHeaders.server | string | Server used for the response (e.g., “nginx”). |
| — attempts[].responseHeaders.date | string | Date of the response (e.g., “Mon, 07 Apr 2025 11:57:04 GMT”). |
| - attempts[].responseBody | string | Body of the response (e.g., "{\"success\":false,...}"). |
| - attempts[].maxAttempts | integer | Maximum number of retry attempts (e.g., 30). |
| - attempts[].id | string | Unique identifier for the attempt (e.g., “532d7b38-c538-4697-888e-58ac3a38ab8f”). |
| - attempts[].createdAt | string (ISO 8601) | Timestamp when the attempt was created (e.g., “2025-03-18T11:47:07.805413906Z”). |
| - attempts[].address | string | URL address of the webhook (e.g., “https://webhook.site/24618f1c-c82c-4588-b9c6-1d86aac2a9b3”). |
video.media.track.created
Triggered when a new media track, such as an additional audio or subtitle track, has been successfully added to the asset. This can include alternate audio languages, commentary tracks, or caption files.
| Name | Type | Description |
|---|---|---|
| type | string | Type of the webhook event (e.g., video.media.track.created). |
| id | string | Unique identifier for the event (e.g., de874ab4-330a-422c-b3fe-c6a5347df4bf). |
| status | string | Status of the event (e.g., media_created). |
| createdAt | string (ISO 8601 datetime) | Timestamp when the event was created (e.g., 2025-01-27T11:55:55.854355536Z). |
| object.type | string | Type of the object (typically media). |
| object.id | string | Unique identifier for the media object (e.g., 3de1fb2c-d55a-4819-88c2-50c1ff54fcf4). |
| workspace.name | string | Name of the workspace (e.g., Add Tracks). |
| workspace.id | string | Unique identifier for the workspace (e.g., 36387a6e-b99c-4908-b3af-ad11015fbe84). |
| data.id | string | Unique identifier for the track (e.g., 3dc44ccb-ffb1-489b-ba3f-b240b88a05f5). |
| data.type | string | Type of track (e.g., subtitle). |
| data.url | string (URL) | URL where the track is located. |
| data.languageCode | string | Language code of the track (e.g., ta-IN). |
| data.languageName | string | Name of the language (e.g., Tamil Lang1). |
| attempts | array | Array of attempts (empty array [] indicates no attempts recorded). |
video.media.track.ready
Triggered when an added track (audio or subtitle) has been fully processed and is ready for playback. Use this event to confirm that the track is available for use with the media asset.
| Name | Type | Description |
|---|---|---|
| type | string | Type of the webhook event (e.g., video.media.track.ready). |
| id | string | Unique identifier for the event (e.g., 8f7c1639-2660-445f-a485-114f309344ec). |
| status | string | Status of the track processing (e.g., ready). |
| createdAt | string (ISO 8601 datetime) | Timestamp when the event was created (e.g., 2025-01-27T10:16:31.857938358Z). |
| object.type | string | Type of the associated object, usually media. |
| object.id | string | Unique identifier for the media (e.g., 3de1fb2c-d55a-4819-88c2-50c1ff54fcf4). |
| workspace.name | string | Name of the workspace (e.g., Add Tracks). |
| workspace.id | string | Unique identifier for the workspace (e.g., 36387a6e-b99c-4908-b3af-ad11015fbe84). |
| data.id | string | Unique identifier for the track (e.g., a9e838f5-08b3-44d4-afb9-1202e5c679c4). |
| data.type | string | Type of the track, e.g., subtitle. |
| data.languageCode | string | Language code of the track (e.g., tr-TR). |
| data.languageName | string | Name of the language (e.g., spanish). |
| data.status | string | Status of the track (e.g., available). |
| attempts | array | Array of retry attempts, empty if none. |
video.media.track.failed
Triggered when a track (audio or subtitle) fails during processing. This event helps identify issues with track generation, allowing you to log errors, trigger alerts, or notify users to take corrective action.
| Name | Type | Description |
|---|---|---|
| type | string | Type of the webhook event (e.g., video.media.track.failed). |
| id | string | Unique identifier for the event (e.g., 9fc5c227-b603-42d0-97df-ea8a5e3c35f2). |
| status | string | Status of the event (e.g., failed). |
| createdAt | string (ISO 8601 datetime) | Timestamp when the event was created (e.g., 2025-01-27T11:55:56.289772761Z). |
| object.type | string | Type of the object (typically media). |
| object.id | string | Unique identifier for the media object (e.g., 3de1fb2c-d55a-4819-88c2-50c1ff54fcf4). |
| workspace.name | string | Name of the workspace (e.g., Add Tracks). |
| workspace.id | string | Unique identifier for the workspace (e.g., 36387a6e-b99c-4908-b3af-ad11015fbe84). |
| data.trackResponse | object | Details of the track that failed. |
| - data.trackResponse.id | string | Unique identifier for the track (e.g., 892c9a2a-5504-416b-9622-20d0e41aea09). |
| - data.trackResponse.type | string | Type of track (e.g., subtitle). |
| - data.trackResponse.languageCode | string | Language code of the track (e.g., en). |
| - data.trackResponse.languageName | string | Language name of the track (e.g., english). |
| - data.trackResponse.status | string | Status of the track (e.g., Failed). |
| data.reason | string | Reason describing why the track failed (e.g., Failed while adding subtitle track! Please check the provided subtitle file.). |
| attempts | array | Array of attempts (empty array [] indicates no attempts recorded). |
video.media.track.updated
Triggered when an existing track - such as an audio or subtitle file has been modified on the media asset. This could include updates to metadata (like languageCode or languageName), replacement of the track file URL, or syncing changes. Use this event to ensure your system reflects the latest track state, especially for applications that support multiple languages, accessibility features, or commentary options.
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event (e.g., video.media.track.updated). |
| object | object | Information about the object associated with the event. |
| -object.type | string | Type of the object (e.g., media). |
| -object.id | string | Unique identifier of the object. |
| id | string | Unique identifier for the webhook event. |
| workspace | object | Workspace information. |
| -workspace.name | string | Name of the workspace. |
| - workspace.id | string | Unique identifier for the workspace. |
| status | string | Status of the media (e.g., media_created). |
| data | object | Additional information about the media track. |
| -data.id | string | Unique identifier for the track. |
| -data.type | string | Type of media track (e.g., audio). |
| -data.url | string | URL of the media track (e.g., the audio file). |
| -data.languageCode | string | Language code in ISO 639-1 format (e.g., fr). |
| -data.languageName | string | Full name of the language (e.g., french). |
| createdAt | string | Timestamp when the event was created (ISO 8601 format). |
| attempts | array | List of delivery attempts (currently empty in this payload). |
video.media.track.deleted
Triggered when a track (audio or subtitle) has been removed from a media asset. Use this event to update your system or UI to reflect that the track is no longer available for the media.
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event (e.g., video.media.track.deleted). |
| object | object | Information about the object associated with the event. |
| - object.type | string | Type of the object (e.g., media). |
| - object.id | string | Unique identifier of the object. |
| id | string | Unique identifier for the webhook event. |
| workspace | object | Workspace information. |
| - workspace.name | string | Name of the workspace (e.g., Development). |
| - workspace.id | string | Unique identifier for the workspace. |
| status | string | Status of the media (e.g., media_created). |
| data | object | Event-specific data. |
| - data.success | boolean | Indicates if the track deletion was successful (e.g., true). |
| createdAt | string | Timestamp when the event was created (ISO 8601 format). |
| attempts | array | List of delivery attempts. |
video.media.source.ready
Triggered when the original source file for a media asset becomes accessible via the sourceAccess API setting. This means the raw, unprocessed version of the uploaded media is now available for download or reference. Use this event to notify users or backend systems that the source file can be retrieved - for compliance archiving, re-editing workflows, or audit purposes.
| Name | Type | Description |
|---|---|---|
| type | string | Type of the webhook event (e.g., video.media.source.ready). |
| object | object | Information about the object associated with the event. |
| └─ object.type | string | Type of the object (e.g., media). |
| └─ object.id | string | Unique identifier of the object. |
| id | string | Unique identifier for the webhook event. |
| workspace | object | Workspace information. |
| └─ workspace.name | string | Name of the workspace. |
| └─ workspace.id | string | Unique identifier for the workspace. |
| status | string | Status of the media (e.g., ready). |
| data | object | Detailed information about the media source. |
| └─ data.thumbnail | string | URL of the media thumbnail. |
| └─ data.id | string | Media identifier (same as object.id). |
| └─ data.workspaceId | string | ID of the workspace that owns the media. |
| └─ data.metadata | object | Key-value metadata associated with the media. |
| └─ data.maxResolution | string | Maximum resolution of the media (e.g., 480p). |
| └─ data.sourceResolution | string | Original resolution of the uploaded media (e.g., 480p). |
| └─ data.playbackIds | array | List of playback identifiers. |
| ── playbackIds[].id | string | Unique ID for the playback. |
| ── playbackIds[].accessPolicy | string | Access policy for the playback (e.g., public). |
| ── playbackIds[].accessRestrictions | object | Access restrictions for domains and user agents. |
| ─── accessRestrictions.domains.defaultPolicy | string | Default domain access policy (e.g., allow). |
| ─── accessRestrictions.domains.allow | array | List of allowed domains. |
| ─── accessRestrictions.domains.deny | array | List of denied domains. |
| ─── accessRestrictions.userAgents.defaultPolicy | string | Default user-agent access policy (e.g., allow). |
| ─── accessRestrictions.userAgents.allow | array | List of allowed user agents. |
| ─── accessRestrictions.userAgents.deny | array | List of denied user agents. |
| └─ data.tracks | array | Tracks associated with the media (e.g., video, audio, subtitle). |
| ── tracks[].id | string | Track identifier. |
| ── tracks[].type | string | Type of track (video, audio, subtitle). |
| ── tracks[].width | integer | Width of the video track (only for type video). |
| ── tracks[].height | integer | Height of the video track (only for type video). |
| ── tracks[].frameRate | string | Frame rate of the video track. |
| ── tracks[].status | string | Status of the track (e.g., available). |
| ── tracks[].languageCode | string | Language code for audio/subtitle track (e.g., und). |
| ── tracks[].languageName | string | Full language name for audio/subtitle track (e.g., default). |
| └─ data.sourceAccess | boolean | Whether direct source access is enabled (e.g., true). |
| └─ data.source | object | Source file information. |
| ── source.status | string | Status of the source file (e.g., ready). |
| ── source.signedUrl | string | Signed URL for downloading the source file. |
| └─ data.mp4Support | string | MP4 support status (e.g., none). |
| └─ data.optimizeAudio | boolean | Whether audio was optimized (e.g., false). |
| └─ data.duration | string | Duration of the media in HH:MM:SS format (e.g., 00:02:34). |
| └─ data.aspectRatio | string | Aspect ratio of the media (e.g., 16:9). |
| └─ data.createdAt | string | Timestamp when the media was created (ISO 8601). |
| └─ data.updatedAt | string | Timestamp when the media was last updated (ISO 8601). |
| └─ data.mediaQuality | string | Media quality tier for the media (e.g., pro). |
| createdAt | string | Timestamp when the event was created (ISO 8601). |
| attempts | array | List of delivery attempts. |
video.media.source.updated
Triggered when the source details of a media asset are updated — for example, when metadata, title, or source access settings change. Use this event to keep your system in sync with the latest state of the media and its source file.
| Name | Type | Description |
|---|---|---|
| type | string | Type of the webhook event (e.g., video.media.source.updated). |
| object | object | Information about the object associated with the event. |
| └─ object.type | string | Type of the object (e.g., media). |
| └─ object.id | string | Unique identifier of the object. |
| id | string | Unique identifier for the webhook event. |
| workspace | object | Workspace information. |
| └─ workspace.name | string | Name of the workspace. |
| └─ workspace.id | string | Unique identifier for the workspace. |
| status | string | Status of the media (e.g., media_created). |
| data | object | Detailed information about the media. |
| └─ data.thumbnail | string | URL of the media thumbnail. |
| └─ data.id | string | Media identifier (same as object.id). |
| └─ data.workspaceId | string | ID of the workspace that owns the media. |
| └─ data.metadata | object | Key-value metadata associated with the media. |
| └─ data.maxResolution | string | Maximum resolution of the media (e.g., 1080p). |
| └─ data.sourceResolution | string | Original resolution of the uploaded media (e.g., 1080). |
| └─ data.playbackIds | array | List of playback identifiers. |
| ── playbackIds[].id | string | Unique ID for the playback. |
| ── playbackIds[].accessPolicy | string | Access policy for the playback (e.g., public). |
| ── playbackIds[].accessRestrictions | object | Access restrictions for domains and user agents. |
| ─── accessRestrictions.domains.defaultPolicy | string | Default domain access policy (e.g., allow). |
| ─── accessRestrictions.domains.allow | array | List of allowed domains. |
| ─── accessRestrictions.domains.deny | array | List of denied domains. |
| ─── accessRestrictions.userAgents.defaultPolicy | string | Default user-agent access policy (e.g., allow). |
| ─── accessRestrictions.userAgents.allow | array | List of allowed user agents. |
| ─── accessRestrictions.userAgents.deny | array | List of denied user agents. |
| └─ data.tracks | array | Tracks associated with the media (e.g., video, audio, subtitle). |
| ── tracks[].id | string | Track identifier. |
| ── tracks[].type | string | Type of track (video, audio, subtitle). |
| ── tracks[].status | string | Status of the track (e.g., available). |
| ── tracks[].width | integer | Width of the video track (only for type video). |
| ── tracks[].height | integer | Height of the video track (only for type video). |
| ── tracks[].frameRate | string | Frame rate of the video track. |
| ── tracks[].languageCode | string | Language code for audio/subtitle track (e.g., und). |
| ── tracks[].languageName | string | Full language name for audio/subtitle track (e.g., default). |
| └─ data.sourceAccess | boolean | Whether direct source access is enabled (e.g., true). |
| └─ data.duration | string | Duration of the media in HH:MM:SS format (e.g., 00:00:10). |
| └─ data.aspectRatio | string | Aspect ratio of the media (e.g., 16:9). |
| └─ data.createdAt | string | Timestamp when the media was created (ISO 8601). |
| └─ data.updatedAt | string | Timestamp when the media was last updated (ISO 8601). |
| └─ data.mediaQuality | string | Media quality tier for the media (e.g., pro). |
| └─ data.isAudioOnly | boolean | Whether the media contains only audio (e.g., false). |
| └─ data.title | string | Title of the media (e.g., capped-4k (23)). |
| └─ data.subtitleAvailable | boolean | Whether subtitles are available (e.g., false). |
| └─ data.generatedSubtitles | array | List of generated subtitles for the media. |
| └─ data.status | string | Processing status of the media (e.g., Ready). |
| createdAt | string | Timestamp when the event was created (ISO 8601). |
| attempts | array | List of delivery attempts. |
video.media.source.deleted
Triggered when access to the original source file has been disabled or the file has been permanently removed, typically due to a change in the sourceAccess setting. This event helps ensure that dependent systems or users are aware that the unprocessed original media is no longer available for retrieval, and any access attempts should be halted or redirected.
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event (e.g., video.media.source.deleted). |
| object | object | Information about the object associated with the event. |
| └─ object.type | string | Type of the object (e.g., media). |
| └─ object.id | string | Unique identifier of the object. |
| id | string | Unique identifier for the webhook event. |
| workspace | object | Workspace information. |
| └─ workspace.name | string | Name of the workspace (e.g., Development). |
| └─ workspace.id | string | Unique identifier for the workspace. |
| status | string | Status of the media (e.g., media_created). |
| data | object | Detailed information about the media source. |
| └─ data.thumbnail | string | URL of the media thumbnail. |
| └─ data.id | string | Media identifier (same as object.id). |
| └─ data.workspaceId | string | ID of the workspace that owns the media. |
| └─ data.maxResolution | string | Maximum resolution of the media (e.g., 480p). |
| └─ data.sourceResolution | string | Original resolution of the uploaded media (e.g., 480p). |
| └─ data.playbackIds | array | List of playback identifiers. |
| ── playbackIds[].id | string | Unique ID for the playback. |
| ── playbackIds[].accessPolicy | string | Access policy for the playback (e.g., public). |
| ── playbackIds[].accessRestrictions | object | Access restrictions for domains and user agents. |
| ─── accessRestrictions.domains.defaultPolicy | string | Default domain access policy (e.g., allow). |
| ─── accessRestrictions.domains.allow | array | List of allowed domains. |
| ─── accessRestrictions.domains.deny | array | List of denied domains. |
| ─── accessRestrictions.userAgents.defaultPolicy | string | Default user-agent access policy (e.g., allow). |
| ─── accessRestrictions.userAgents.allow | array | List of allowed user agents. |
| ─── accessRestrictions.userAgents.deny | array | List of denied user agents. |
| └─ data.tracks | array | Tracks associated with the media (e.g., video, audio, subtitle). |
| ── tracks[].id | string | Track identifier. |
| ── tracks[].type | string | Type of track (video, audio, subtitle). |
| ── tracks[].width | integer | Width of the video track (only for type video). |
| ── tracks[].height | integer | Height of the video track (only for type video). |
| ── tracks[].frameRate | string | Frame rate of the video track (e.g., 24000/1001). |
| ── tracks[].status | string | Status of the track (e.g., available). |
| ── tracks[].languageCode | string | Language code for audio/subtitle track (e.g., fr, en). |
| ── tracks[].languageName | string | Full language name for audio/subtitle track (e.g., french, English). |
| └─ data.sourceAccess | boolean | Whether direct source access is enabled (e.g., false). |
| └─ data.mp4Support | string | MP4 support status (e.g., none). |
| └─ data.optimizeAudio | boolean | Whether audio was optimized (e.g., false). |
| └─ data.duration | string | Duration of the media in HH:MM:SS format (e.g., 00:02:34). |
| └─ data.aspectRatio | string | Aspect ratio of the media (e.g., 16:9). |
| └─ data.createdAt | string | Timestamp when the media was created (e.g., 2025-04-28T11:16:34.121845Z). |
| └─ data.updatedAt | string | Timestamp when the media was last updated. |
| └─ data.mediaQuality | string | Media quality tier for the media (e.g., pro). |
| createdAt | string | Timestamp when the event was created. |
| attempts | array | List of delivery attempts. |
video.mediaAI.chapters.ready
Triggered when AI-generated chapters for a media asset are ready. Chapters break the media into titled, timestamped segments with short summaries, useful for navigation and content discovery.
| Name | Type | Description |
|---|---|---|
| type | string | Type of event (e.g., “video.mediaAI.chapters.ready”). |
| object | object | Object information. |
| - object.type | string | Type of the object (e.g., “media”). |
| - object.id | string | Unique identifier for the object (e.g., “b9856f45-e166-4e11-b05c-c0e13dafd656”). |
| id | string | Unique identifier for the event (e.g., “7d9d2b3d-1a4a-454f-91a7-2bd232dfa4a8”). |
| workspace | object | Workspace information. |
| - workspace.name | string | Name of the workspace (e.g., “Development”). |
| - workspace.id | string | Unique identifier for the workspace (e.g., “338acdeb-29d4-438b-a40c-1d4105134462”). |
| status | string | Status of the media (e.g., “ready”). |
| data | object | |
| - data.isChaptersGenerated | boolean | Indicates if chapters were generated (e.g., true). |
| - data.chapters | array | List of generated chapters. |
| — data.chapters[].chapter | string | Chapter number (e.g., “1”). |
| — data.chapters[].startTime | string | Start time of the chapter (e.g., “00:00:00”). |
| — data.chapters[].endTime | string | End time of the chapter (e.g., “00:00:10”). |
| — data.chapters[].title | string | Title of the chapter (e.g., “Introduction to FastPix”). |
| — data.chapters[].summary | string | Short summary of the chapter. |
| createdAt | string (ISO 8601) | Timestamp when the event was created. |
| attempts | array | List of attempts made to deliver the webhook. |
video.mediaAI.named-entities.ready
Triggered when AI-generated named entities for a media asset are ready. Named entities identify people, organizations, concepts, and other entities mentioned in the media, along with their categories.
| Name | Type | Description |
|---|---|---|
| type | string | Type of event (e.g., “video.mediaAI.named-entities.ready”). |
| object | object | Object information. |
| - object.type | string | Type of the object (e.g., “media”). |
| - object.id | string | Unique identifier for the object (e.g., “b9856f45-e166-4e11-b05c-c0e13dafd656”). |
| id | string | Unique identifier for the event (e.g., “e0f8f644-ae23-4d79-8706-4d669d1fba65”). |
| workspace | object | Workspace information. |
| - workspace.name | string | Name of the workspace (e.g., “Development”). |
| - workspace.id | string | Unique identifier for the workspace (e.g., “338acdeb-29d4-438b-a40c-1d4105134462”). |
| status | string | Status of the media (e.g., “ready”). |
| data | object | |
| - data.isNamedEntitiesGenerated | boolean | Indicates if named entities were generated (e.g., true). |
| - data.namedEntities | object | Named entities result. |
| — data.namedEntities.entityCount | integer | Total number of named entities detected (e.g., 3). |
| — data.namedEntities.namedEntities | array | List of detected named entities. |
| --- data.namedEntities.namedEntities[].entity | string | The named entity (e.g., “FastPix”). |
| --- data.namedEntities.namedEntities[].category | string | Category of the entity (e.g., “Organization”, “Concept”). |
| createdAt | string (ISO 8601) | Timestamp when the event was created. |
| attempts | array | List of attempts made to deliver the webhook. |
video.mediaAI.summary.ready
Triggered when an AI-generated summary of a media asset is ready. The summary provides a concise, human-readable overview of the media content.
| Name | Type | Description |
|---|---|---|
| type | string | Type of event (e.g., “video.mediaAI.summary.ready”). |
| object | object | Object information. |
| - object.type | string | Type of the object (e.g., “media”). |
| - object.id | string | Unique identifier for the object (e.g., “b9856f45-e166-4e11-b05c-c0e13dafd656”). |
| id | string | Unique identifier for the event (e.g., “4a39267d-8504-4187-a44c-ae47d95c7f6e”). |
| workspace | object | Workspace information. |
| - workspace.name | string | Name of the workspace (e.g., “Development”). |
| - workspace.id | string | Unique identifier for the workspace (e.g., “338acdeb-29d4-438b-a40c-1d4105134462”). |
| status | string | Status of the media (e.g., “ready”). |
| data | object | |
| - data.isSummaryGenerated | boolean | Indicates if the summary was generated (e.g., true). |
| - data.summary | string | AI-generated summary text of the media content. |
| createdAt | string (ISO 8601) | Timestamp when the event was created. |
| attempts | array | List of attempts made to deliver the webhook. |
video.mediaAI.moderation.ready
Triggered when AI-generated content moderation results for a media asset are ready. The result contains category scores indicating detected sensitive or objectionable content.
| Name | Type | Description |
|---|---|---|
| type | string | Type of event (e.g., “video.mediaAI.moderation.ready”). |
| object | object | Object information. |
| - object.type | string | Type of the object (e.g., “media”). |
| - object.id | string | Unique identifier for the object (e.g., “b9856f45-e166-4e11-b05c-c0e13dafd656”). |
| id | string | Unique identifier for the event (e.g., “eabcdcdc-7dfb-407b-bf20-88da044a1ce8”). |
| workspace | object | Workspace information. |
| - workspace.name | string | Name of the workspace (e.g., “Development”). |
| - workspace.id | string | Unique identifier for the workspace (e.g., “338acdeb-29d4-438b-a40c-1d4105134462”). |
| status | string | Status of the media (e.g., “ready”). |
| data | object | |
| - data.isModerationGenerated | boolean | Indicates if moderation was generated (e.g., true). |
| - data.moderationResult | object | Moderation result. |
| — data.moderationResult.categoryScores | array | List of moderation category scores (empty if none detected). |
| createdAt | string (ISO 8601) | Timestamp when the event was created. |
| attempts | array | List of attempts made to deliver the webhook. |