Live events
Live stream created
Live stream connected
Stream recording started
Live stream is active
Live stream disconnected
Live stream is idle
Live stream is preparing
Live stream updated
Live stream deleted
Simulcast target created
Simulcast target starting
Simulcast target broadcasting
Simulcast target deleted
Simulcast target updated
Live stream SRT detected
Live stream RTMPS detected
video.live_stream.created
Triggered when a new live stream is provisioned on the platform. This means your application has successfully created a stream resource, and a streamKey is now available for broadcasters to start pushing live video using an encoder.
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event |
| webhookId | string | Unique identifier for the webhook |
| object | object | |
| - object.name | string | Type of webhook (e.g., live) |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6) |
| Workspace | object | |
| - Workspace.name | string | Name for the environment (e.g., production) |
| - Workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6) |
| data | object | |
| - data.test | boolean | Indicates if the stream is a test stream. Test streams last five minutes and are removed after a day. |
| - data.streamId | string | Unique identifier for the stream. Max 255 characters (e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.status | string | Current live stream status: "idle" (no broadcast), disabled (no RTMP streams), active (broadcast in progress). |
| - data.audioOnly | boolean | If set to false, the stream processes only the audio track. |
| - data.streamKey | string | Unique key used for streaming to a Fastpix RTMP endpoint; treat it as sensitive as credentials. |
| - data.srtSecert | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - dataTrail | boolean | Checking the trails for streaming enabled or not (eg: true/ false) |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.enableRecording | boolean | Checking the recording is enabled or not (Eg: true/ false). |
| - data.mediapolicy | string | Access policy for the data (eg: public, private ..). |
| - data.metadata | object | User-supplied metadata included in the stream details (e.g., {key1:value1}). |
| - data.createdAt | string | Timestamp for when the stream was created (e.g., 2023-12-06T09:12:28.808Z). |
| - data.reconnectWindow | integer | Time (in seconds) Fastpix will wait before declaring the stream over after disconnection. Default is 60 seconds for Standard Latency. |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 500). |
| - data.lowLatency | boolean | Data with lowLatency is enabled for stream (eg: true/false). |
| - data.playback_ids | object | |
| -- data.playback_ids.id | string | Unique identifier for the PlaybackID (e.g., public). |
| -- data.playback_ids[].accessPolicy | string | Access policy for playback IDs; can be public or private. |
| - data.srtPlaybackResponse | object | |
| - data.srtPlaybackResponse.srtPlaybackStreamId | string | Unique identifier id for the stream with initial play and max of 255 characters (eg: playf21f7c0b45108a04f051692e83af2943) |
| - data.srtPlaybackResponse.srtPlaybackSecert | string | Unique identifier key for the stream, max of 255 characters. |
| created_at | string | Timestamp for when the webhook was created (e.g., 2023-12-06T09:12:28.808Z). |
| attempts | array | List of attempts created. |
video.live_stream.connected
Fired when an encoder successfully connects to the live stream. The system confirms that it is now receiving an input feed, although the stream isn’t yet publicly live. This is useful for monitoring when the encoder handshake is complete.
| Name | Type | Description |
|---|---|---|
| type | string | Type of event (e.g., video.media.intro.ready) |
| 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/streaming |
| - 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.defaultPolicy | string | Default policy for domains (e.g., allow) |
| --- domains.allow | array | List of allowed domains |
| --- domains.deny | array | List of denied domains |
| --- userAgents.defaultPolicy | string | Default policy for user agents (e.g., allow) |
| --- userAgents.allow | array | List of allowed user agents |
| --- 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 |
| -- data.tracks[].type | string | Type of the track (e.g., video or audio) |
| -- data.tracks[].status | string | Status of the track (e.g., available) |
| -- data.tracks[].languageCode | string | Language code (if applicable) |
| -- data.tracks[].languageName | string | Language name (if applicable) |
| -- 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.sourceAccess | boolean | Indicates if source access is enabled |
| - data.mp4Support | string | Indicates MP4 support (e.g., none) |
| - data.optimizeAudio | boolean | Whether audio optimization is enabled |
| - data.duration | string | Duration of the media (e.g., 00:00:20) |
| - data.frameRate | string | Frame rate of the media (e.g., 30/1) |
| - data.aspectRatio | string | Aspect ratio of the media (e.g., 16:9) |
| - data.createdAt | string (ISO 8601) | When the media was created |
| - data.updatedAt | string (ISO 8601) | When the media was last updated |
| createdAt | string (ISO 8601) | When the event was created |
| attempts | array | Delivery attempts |
| - attempts[].webhookId | string | Webhook attempt ID |
| - attempts[].responseStatusCode | integer | HTTP status code of the response |
| - attempts[].responseHeaders | object | Response headers |
| -- contentType | string | e.g., application/json |
| -- transfer | (optional) | |
| -- server | string | Server used (e.g., nginx) |
| -- date | string | Date of the response |
| -- cacheControl | (optional) | |
| - 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 of the attempt |
| - attempts[].address | string | Webhook target URL |
video.live_stream.recording
Triggered when the platform starts recording the live stream. This allows the live session to be preserved for playback later as on-demand content. Use this event to update your system UI to show that recording is in progress.
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event |
| webhookId | string | Unique identifier for the webhook |
| object | object | |
| - object.name | string | Type of webhook (e.g., live) |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6) |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., production) |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6) |
| data | object | |
| - data.test | boolean | Indicates if the stream is a test stream; lasts five minutes and is removed after a day. |
| - data.streamId | string | Unique identifier for the stream (e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218) |
| - data.status | string | Current live stream status: idle, disabled, or active. |
| - data.audioOnly | boolean | If set to false, the stream processes only the audio track. |
| - data.streamKey | string | Unique key for streaming to a Fastpix RTMP endpoint; treat as sensitive. |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.createdAt | string | Timestamp for when the stream was created (e.g., 2023-12-06T09:12:28.808Z). |
| - data.reconnectWindow | integer | Time (in seconds) to wait before considering stream ended after disconnection. |
| - data.maxDuration | integer | Max duration (in seconds) a live stream can last (e.g., 500). |
| - data.srtSecert | string | Key used for streaming to a FastPix endpoint; treat as sensitive. |
| - dataTrail | boolean | Whether streaming trails are enabled (e.g., true/false). |
| - data.enableRecording | boolean | Whether recording is enabled (e.g., true/false). |
| - data.mediapolicy | string | Access policy for the data (e.g., public, private). |
| - data.metadata | object | User-supplied metadata (e.g., {key1:value1}). |
| - data.lowLatency | boolean | Whether low latency mode is enabled (e.g., true/false). |
| - data.playback_ids | object | |
| -- data.playback_ids.id | string | Unique ID for the Playback ID (e.g., public). |
| -- data.playback_ids[].accessPolicy | string | Access policy: public or private. |
| - data.srtPlaybackResponse | object | |
| -- data.srtPlaybackResponse.srtPlaybackStreamId | string | Unique stream ID for playback (max 255 chars). |
| -- data.srtPlaybackResponse.srtPlaybackSecert | string | Unique key for playback stream (max 255 chars). |
| created_at | string | Timestamp for when the webhook was created (e.g., 2023-12-06T09:12:28.808Z). |
| attempts | array | List of delivery attempts. |
video.live_stream.active
Indicates that the live stream is officially live and being broadcast to viewers. This is the moment when your audience can start watching the stream in real-time. You can use this webhook to trigger "Go Live" notifications or UI changes.
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event |
| webhookId | string | Unique identifier for the webhook |
| object | object | |
| - object.name | string | Type of webhook (e.g., live) |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6) |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., production) |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6) |
| data | object | |
| - data.test | boolean | Indicates if the stream is a test stream (duration of five minutes; recorded asset removed after a day). |
| - data.id | string | Unique identifier for the stream (max 255 characters). |
| - data.status | string | Current live stream status: idle, disabled, or active. |
| - data.audioOnly | boolean | If set to false, the stream processes only the audio track. |
| - data.streamKey | string | Unique key for streaming to a Fastpix RTMP endpoint; treat as sensitive as credentials. |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.createdAt | string | Timestamp for when the stream was created (e.g., 2023-12-06T09:12:28.808Z). |
| - data.reconnectWindow | integer | Time (in seconds) Fastpix will wait before declaring the stream over after disconnection; defaults to 60 seconds for Standard Latency streams. |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 500). |
| - data.srtSecert | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - dataTrail | boolean | Indicates if trails for streaming are enabled (e.g., true/false). |
| - data.enableRecording | boolean | Indicates if recording is enabled (e.g., true/false). |
| - data.mediapolicy | string | Access policy for the data (e.g., public, private). |
| - data.metadata | object | User-supplied metadata included in the stream details (e.g., {key1:value1}). |
| - data.lowLatency | boolean | Indicates if low latency is enabled for the stream (e.g., true/false). |
| - data.playback_ids | object | |
| -- data.playback_ids.id | string | Unique identifier for the PlaybackID (e.g., public). |
| -- data.playback_ids[].accessPolicy | string | Access policy for playback IDs; possible values: public, private. |
| - data.srtPlaybackresponse | object | |
| -- data.srtPlaybackResponse.srtPlaybackStreamId | string | Unique stream ID with initial play (max 255 characters; e.g., playf21f7c0b45108a04f051692e83af2943). |
| -- data.srtPlaybackResponse.srtPlaybackSecert | string | Unique stream key (max 255 characters). |
| created_at | string | Timestamp for when the webhook was created (e.g., 2023-12-06T09:12:28.808Z). |
| attempts | array | List of attempts created. |
video.live_stream.disconnected
Fired when the connection between the encoder and the platform is interrupted — for example, if the broadcaster stops their stream or there’s a network issue. This event signals a dropped stream and can be used to prompt reconnection flows.
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event |
| webhookId | string | Unique identifier for the webhook |
| object | object | |
| - object.name | string | Type of webhook (e.g., live) |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6) |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., "production") |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6) |
| data | object | |
| - data.test | boolean | Indicates if the stream is a test stream (duration of five minutes; recorded asset removed after a day). |
| - data.id | string | Unique identifier for the stream (max 255 characters). |
| - data.status | string | Current live stream status: idle (no broadcast), disabled (no more RTMP streams), active (broadcast in progress). |
| - data.audioOnly | boolean | If set to false, the stream processes only the audio track. |
| - data.streamKey | string | Unique key for streaming to a Fastpix RTMP endpoint; treat as sensitive as credentials. |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.createdAt | string | Timestamp for when the stream was created (e.g., 2023-12-06T09:12:28.808Z). |
| - data.reconnectWindow | integer | Time (in seconds) Fastpix will wait before declaring the stream over after disconnection; defaults to 60 seconds for Standard Latency streams. |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 500). |
| - data.srtSecert | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - dataTrail | boolean | Indicates if trails for streaming are enabled (e.g.,true/false). |
| - data.enableRecording | boolean | Indicates if recording is enabled (e.g., true/false). |
| - data.mediapolicy | string | Access policy for the data (e.g., public, private). |
| - data.metadata | object | User-supplied metadata included in the stream details (e.g., {key1:value1}). |
| - data.lowLatency | boolean | Indicates if lowLatency is enabled for stream (e.g., true/false). |
| - data.playback_ids | object | |
| -- data.playback_ids.id | string | Unique identifier for the PlaybackID (e.g., public). |
| -- data.playback_ids[].accessPolicy | string | Access policy for playback IDs; possible values: public, private. |
| - data.srtPlaybackresponse | object | |
| -- data.srtPlaybackResponse.srtPlaybackStreamId | string | Unique stream ID with initial play (max 255 characters; e.g., playf21f7c0b45108a04f051692e83af2943). |
| -- data.srtPlaybackResponse.srtPlaybackSecert | string | Unique stream key (max 255 characters). |
| created_at | string | Timestamp for when the webhook was created (e.g., 2023-12-06T09:12:28.808Z). |
| attempts | array | List of attempts created. |
video.live_stream.idle
This event occurs when the stream is no longer active, and there’s no encoder connected. It represents an idle or dormant state where the live stream is technically available but not in use. Use this to reset your UI or monitoring tools.
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event. |
| webhookId | string | Unique identifier for the webhook. |
| object | object | |
| - object.name | string | Type of webhook (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., "production"). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.test | boolean | Indicates if the stream is a test stream (duration of five minutes; recorded asset removed after a day). |
| - data.streamId | string | Unique identifier for the stream (max 255 characters, e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.status | string | Current live stream status: idle (no broadcast), disabled (no more RTMP streams), active (broadcast in progress). |
| - data.audioOnly | boolean | If set to false, the stream processes only the audio track. |
| - data.streamKey | string | Unique key for streaming to a Fastpix RTMP endpoint; treat as sensitive as credentials. |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.createdAt | string | Timestamp for when the stream was created (e.g., 2023-12-06T09:12:28.808Z). |
| - data.reconnectWindow | integer | Time (in seconds) Fastpix will wait before concluding the recorded asset after disconnection; defaults to 60 seconds for Standard Latency streams. |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 500). |
| - data.srtSecert | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - dataTrail | boolean | Checking the trails for streaming enabled or not (e.g., true/false). |
| - data.enableRecording | boolean | Checking the recording is enabled or not (e.g., true/false). |
| - data.mediapolicy | string | Access policy for the data (e.g., public, private). |
| - data.metadata | object | User-supplied metadata included in the stream details (e.g., {key1:value1}). |
| - data.lowLatency | boolean | Data with lowLatency is enabled for stream (e.g., true/false). |
| - data.playback_ids | object | |
| -- data.playback_ids.id | string | Unique identifier for the PlaybackID (e.g., public). |
| -- data.playback_ids[].accessPolicy | string | Access policy for playback IDs; possible values: public, private. |
| - data.srtPlaybackresponse | object | |
| -- data.srtPlaybackResponse.srtPlaybackStreamId | string | Unique identifier id for the stream with initial play and max of 255 characters (e.g., playf21f7c0b45108a04f051692e83af2943). |
| -- data.srtPlaybackResponse.srtPlaybackSecert | string | Unique identifier key for the stream, max of 255 characters. |
| created_at | string | Timestamp for when the webhook was created (e.g., "2023-12-06T09:12:28.808Z"). |
| attempts | array | List of attempts created. |
video.live_stream.preparing
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event. |
| webhookId | string | Unique identifier for the webhook. |
| object | object | |
| - object.name | string | Type of webhook (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., production). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.test | boolean | Indicates if the stream is a test stream (duration of five minutes; recorded asset removed after a day). |
| - data.streamId | string | Unique identifier for the stream (max 255 characters, e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.status | string | Current live stream status: idle (no broadcast), disabled (no more RTMP streams), active (broadcast in progress), preparing (start broadcast). |
| - data.audioOnly | boolean | If set to false, the stream processes only the audio track. |
| - data.streamKey | string | Unique key for streaming to a Fastpix RTMP endpoint; treat as sensitive as credentials. |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.createdAt | string | Timestamp for when the stream was created (e.g., 2023-12-06T09:12:28.808Z). |
| - data.reconnectWindow | integer | Time (in seconds) Fastpix will wait before concluding the recorded asset after disconnection; defaults to 60 seconds for Standard Latency streams. |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 500). |
| - data.srtSecert | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - dataTrail | boolean | Checking the trails for streaming enabled or not (e.g., true/false). |
| - data.enableRecording | boolean | Checking the recording is enabled or not (e.g., true/false). |
| - data.mediapolicy | string | Access policy for the data (e.g., public, private). |
| - data.metadata | object | User-supplied metadata included in the stream details (e.g., {key1:value1}). |
| - data.lowLatency | boolean | Data with lowLatency is enabled for stream (e.g., true/false). |
| - data.playback_ids | object | |
| -- data.playback_ids.id | string | Unique identifier for the PlaybackID (e.g., public). |
| -- data.playback_ids[].accessPolicy | string | Access policy for playback IDs; possible values: public, private. |
| - data.srtPlaybackresponse | object | |
| -- data.srtPlaybackResponse.srtPlaybackStreamId | string | Unique identifier id for the stream with initial play and max of 255 characters (e.g., playf21f7c0b45108a04f051692e83af2943). |
| -- data.srtPlaybackResponse.srtPlaybackSecert | string | Unique identifier key for the stream, max of 255 characters. |
| created_at | string | Timestamp for when the webhook was created (e.g., 2023-12-06T09:12:28.808Z). |
| attempts | array | List of attempts created. |
video.live_stream.updated
Triggered when there are changes to the live stream configuration, such as updates to metadata or when the streamKey is regenerated. Your system should use this event to sync live stream data with the latest version from the platform.
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event. |
| webhookId | string | Unique identifier for the webhook. |
| object | object | |
| - object.name | string | Type of webhook (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., production). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.test | boolean | Indicates if the stream is a test stream (duration of five minutes; recorded asset removed after a day). |
| - data.streamId | string | Unique identifier for the stream (max 255 characters, e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.status | string | Current live stream status: idle (no broadcast), disabled (no more RTMP streams), active (broadcast in progress). |
| - data.audioOnly | boolean | If set to false, the stream processes only the audio track. |
| - data.streamKey | string | Unique key for streaming to a Fastpix RTMP endpoint; treat as sensitive as credentials. |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 720p). |
| - data.createdAt | string | Timestamp for when the stream was created (e.g., 2023-12-06T09:12:28.808Z). |
| - data.reconnectWindow | integer | Time (in seconds) Fastpix will wait before concluding the recorded asset after disconnection; defaults to 60 seconds for Standard Latency streams. |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 700). |
| - data.srtSecert | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - dataTrail | boolean | Checking the trails for streaming enabled or not (e.g., true/false). |
| - data.enableRecording | boolean | Checking the recording is enabled or not (e.g., true/false). |
| - data.mediapolicy | string | Access policy for the data (e.g., public, private). |
| - data.metadata | object | User-supplied metadata included in the stream details (e.g., {"key1":"value1"}). |
| - data.lowLatency | boolean | Data with lowLatency is enabled for stream (e.g., true/false). |
| -- data.playback_ids.id | string | Unique identifier for the PlaybackID (e.g., public). |
| -- data.playback_ids[].accessPolicy | string | Access policy for playback IDs; possible values: public, private. |
| - data.srtPlaybackresponse | object | |
| -- data.srtPlaybackResponse.srtPlaybackStreamId | string | Unique identifier id for the stream with initial play and max of 255 characters (e.g., playf21f7c0b45108a04f051692e83af2943). |
| -- data.srtPlaybackResponse.srtPlaybackSecert | string | Unique identifier key for the stream, max of 255 characters. |
| created_at | string | Timestamp for when the webhook was created (e.g., 2023-12-06T09:12:28.808Z). |
| attempts | array | List of attempts created. |
video.live_stream.deleted
Fired when a live stream has been permanently deleted. You should remove any references to this stream in your application, as it will no longer be available for connection or playback.
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event. |
| webhookId | string | Unique identifier for the webhook. |
| object | object | |
| - object.name | string | Type of webhook (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., production). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.test | boolean | When true, the stream is identified as a test stream. Lasts five minutes; recorded asset is removed after a day. |
| - data.streamId | string | Unique identifier for the stream (max 255 characters, e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.status | string | Current live stream status: idle (no broadcast), disabled (no more RTMP streams), active (broadcast in progress). |
| - data.audioOnly | boolean | If false, the stream will only process the audio track. |
| - data.streamKey | string | Unique key for streaming to a Fastpix RTMP endpoint; treat as sensitive as credentials. |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.createdAt | string | Timestamp for when the stream was created (e.g., 2023-12-06T09:12:28.808Z). |
| - data.reconnectWindow | integer | Time (in seconds) Fastpix will wait before concluding the recorded asset after disconnection; defaults to 60 seconds for Standard Latency streams. |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 500). |
| - data.srtSecert | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - dataTrail | boolean | Checking the trails for streaming enabled or not (e.g., true/false) |
| - data.enableRecording | boolean | Checking the recording is enabled or not (e.g., true/false). |
| - data.mediapolicy | string | Access policy for the data (e.g., public, private). |
| - data.metadata | object | User-supplied metadata included in the stream details (e.g., {"key1":"value1"}). |
| - data.lowLatency | boolean | Data with lowLatency is enabled for stream (e.g., true/false). |
| - data.playback_ids | object | |
| -- data.playback_ids.id | string | Unique identifier for the PlaybackID (e.g., public). |
| -- data.playback_ids[].accessPolicy | string | Access policy for playback IDs; possible values: public, private. |
| - data.srtPlaybackresponse | object | |
| -- data.srtPlaybackResponse.srtPlaybackStreamId | string | Unique identifier id for the stream with initial play and max of 255 characters (e.g., playf21f7c0b45108a04f051692e83af2943) |
| -- data.srtPlaybackResponse.srtPlaybackSecert | string | Unique identifier key for the stream, max of 255 characters. |
| created_at | string | Timestamp for when the webhook was created (e.g., 2023-12-06T09:12:28.808Z). |
| attempts | array | List of attempts created. |
video.live_stream.simulcast_target.created
Indicates that a new simulcast target has been added to the live stream. This is useful for updating the UI or logs to reflect that the stream will be relayed to another platform.
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event. |
| webhookId | string | Unique identifier for the webhook. |
| object | object | |
| - object.name | string | Type of webhook (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., production). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.simulcastId | string | Unique identifier for the simulcast (max 255 characters, e.g., 314a486a-3dc7-4cf5-9fcc-1708a4683f21). |
| - data.livestreamId | string | Unique identifier for the stream (max 255 characters, e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.rtmpUrl | string | RTMP URL for linking to a third-party live streaming service (e.g., rtmp://hyd01.contribute.live-video.net/app/live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk). |
| - data.streamKey | string | Unique identifier used to transmit the main live stream to a third-party service (e.g., 81ta-sr0p-hrpr-t5tt-6bed). |
| - data.metadata | object | User-supplied metadata included in the stream details (e.g., {"key1":"value1"}). |
| created_at | string | Timestamp for when the webhook was created (e.g., 2023-12-06T09:12:28.808Z). |
| attempts | array | List of attempts created. |
video.live_stream.simulcast_target.starting
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event. |
| webhookId | string | Unique identifier for the webhook. |
| object | object | |
| - object.name | string | Type of webhook (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., production). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.simulcastId | string | Unique identifier for the simulcast (max 255 characters, e.g., 314a486a-3dc7-4cf5-9fcc-1708a4683f21). |
| - data.livestreamId | string | Unique identifier for the stream (max 255 characters, e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.rtmpUrl | string | RTMP URL for linking to a third-party live streaming service (e.g., rtmp://hyd01.contribute.live-video.net/app/live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk). |
| - data.streamKey | string | Unique identifier used to transmit the main live stream to a third-party service (e.g., 81ta-sr0p-hrpr-t5tt-6bed). |
| - data.metadata | object | User-supplied metadata included in the stream details (e.g., {"key1":"value1"}). |
| created_at | string | Timestamp for when the webhook was created (e.g., 2023-12-06T09:12:28.808Z). |
| attempts | array | List of attempts created. |
video.live_stream.simulcast_target.broadcasting
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event. |
| webhookId | string | Unique identifier for the webhook. |
| object | object | |
| - object.name | string | Type of webhook (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., production). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.simulcastId | string | Unique identifier for the simulcast (max 255 characters, e.g., 314a486a-3dc7-4cf5-9fcc-1708a4683f21). |
| - data.livestreamId | string | Unique identifier for the stream (max 255 characters, e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.rtmpUrl | string | RTMP URL for linking to a third-party live streaming service (e.g., rtmp://hyd01.contribute.live-video.net/app/live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk). |
| - data.streamKey | string | Unique identifier used to transmit the main live stream to a third-party service (e.g., 81ta-sr0p-hrpr-t5tt-6bed). |
| - data.metadata | object | User-supplied metadata included in the stream details (e.g., {"key1":"value1"}). |
| created_at | string | Timestamp for when the webhook was created (e.g., 2023-12-06T09:12:28.808Z). |
| attempts | array | List of attempts created. |
video.live_stream.simulcast_target.deleted
Triggered when a simulcast target is removed from the live stream. You should update your app UI or backend systems to reflect that the stream is no longer being broadcast to that destination.
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event. |
| webhookId | string | Unique identifier for the webhook. |
| object | object | |
| - object.name | string | Type of webhook (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., production). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| status | String | Message of status displayed. |
| data | object | |
| - data.success | boolean | Status will be displayed if the data success (e.g., true, false) |
| created_at | string | Timestamp for when the webhook was created (e.g., 2023-12-06T09:12:28.808Z). |
| attempts | array | List of attempts created. |
video.live_stream.simulcast_target.updated
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event. |
| webhookId | string | Unique identifier for the webhook. |
| object | object | |
| - object.name | string | Type of webhook (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., production). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| status | String | Message of status displayed. |
| data | object | |
| - data.success | boolean | Status will be displayed if the data success (e.g., true, false) |
| - data.simulcastId | string | Unique identifier for the simulcast (max 255 characters, e.g., 314a486a-3dc7-4cf5-9fcc-1708a4683f21). |
| - data.livestreamId | string | Unique identifier for the stream (max 255 characters, e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.rtmpUrl | string | RTMP URL for linking to a third-party live streaming service (e.g., rtmp://hyd01.contribute.live-video.net/app/live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk). |
| - data.streamKey | string | A unique identifier used to transmit the main live stream to a third-party service (e.g., 81ta-sr0p-hrpr-t5tt-6bed). |
| - data.isEnabled | boolean | Message of the data will be updated (e.g., true, false) |
| - data.metadata | object | User-supplied metadata included in the stream details (e.g., {key1:value1}). |
| created_at | string | Timestamp for when the webhook was created (e.g., 2023-12-06T09:12:28.808Z). |
| attempts | array | List of attempts created. |
video.live_stream.srt_detected
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event |
| webhookId | string | Unique identifier for the webhook |
| object | object | |
| - object.name | string | Type of webhook (e.g., live) |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6) |
| Workspace | object | |
| - Workspace.name | string | Name for the environment (e.g., production) |
| - Workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6) |
| data | object | |
| - data.test | boolean | Indicates if the stream is a test stream. Test streams last five minutes and are removed after a day. |
| - data.streamId | string | Unique identifier for the stream. Max 255 characters (e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.status | string | Current live stream status: idle (no broadcast), disabled (no RTMP streams), active (broadcast in progress), preparing (checking broadcast). |
| - data.audioOnly | boolean | If set to false, the stream processes only the audio track. |
| - data.streamKey | string | Unique key used for streaming to a Fastpix RTMP endpoint; treat it as sensitive as credentials. |
| - data.srtSecert | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - dataTrail | boolean | Checking the trails for streaming enabled or not (e.g., true, false) |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.enableRecording | boolean | Checking the recording is enabled or not (e.g., true, false). |
| - data.mediapolicy | String | Access policy for the data (e.g., public, private ..). |
| - data.metadata | object | User-supplied metadata included in the stream details (e.g., {key1:value1}). |
| - data.createdAt | string | Timestamp for when the stream was created (e.g., 2023-12-06T09:12:28.808Z). |
| - data.reconnectWindow | integer | Time (in seconds) Fastpix will wait before declaring the stream over after disconnection. Default is 60 seconds for Standard Latency. |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 500). |
| - data.lowLatency | boolean | Data with lowLatency is enabled for stream (e.g., true, false). |
| - data.playback_ids | object | |
| -- data.playback_ids.id | string | Unique identifier for the PlaybackID (e.g., public). |
| -- data.playback_ids[].accessPolicy | string | Access policy for playback IDs; can be public or private. |
| - data.srtPlaybackResponse | object | |
| - data.srtPlaybackResponse.srtPlaybackStreamId | String | Unique identifier id for the stream with initial play and max of 255 characters (e.g., playf21f7c0b45108a04f051692e83af2943) |
| - data.srtPlaybackResponse.srtPlaybackSecert | String | Unique identifier key for the stream, max of 255 characters. |
| created_at | string | Timestamp for when the webhook was created (e.g., 2023-12-06T09:12:28.808Z). |
| attempts | array | List of attempts created. |
video.live_stream.rtmps_detected
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event |
| webhookId | string | Unique identifier for the webhook |
| object | object | |
| - object.name | string | Type of webhook (e.g., live) |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6) |
| Workspace | object | |
| - Workspace.name | string | Name for the environment (e.g., production) |
| - Workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6) |
| data | object | |
| - data.test | boolean | Indicates if the stream is a test stream. Test streams last five minutes and are removed after a day. |
| - data.streamId | string | Unique identifier for the stream. Max 255 characters (e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.status | string | Current live stream status: idle (no broadcast), disabled (no RTMP streams), active (broadcast in progress), preparing (checking broadcast). |
| - data.audioOnly | boolean | If set to false, the stream processes only the audio track. |
| - data.streamKey | string | Unique key used for streaming to a Fastpix RTMP endpoint; treat it as sensitive as credentials. |
| - data.srtSecert | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - dataTrail | boolean | Checking the trails for streaming enabled or not (e.g., true/false) |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.enableRecording | boolean | Checking the recording is enabled or not (e.g., true/false). |
| - data.mediapolicy | String | Access policy for the data (e.g., public, private ..). |
| - data.metadata | object | User-supplied metadata included in the stream details (e.g., {key1:value1}). |
| - data.createdAt | string | Timestamp for when the stream was created (e.g., 2023-12-06T09:12:28.808Z). |
| - data.reconnectWindow | integer | Time (in seconds) Fastpix will wait before declaring the stream over after disconnection. Default is 60 seconds for Standard Latency. |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 500). |
| - data.lowLatency | boolean | Data with lowLatency is enabled for stream (e.g., true/false). |
| - data.playback_ids | object | |
| -- data.playback_ids.id | string | Unique identifier for the PlaybackID (e.g., public). |
| -- data.playback_ids[].accessPolicy | string | Access policy for playback IDs; can be public or private. |
| - data.srtPlaybackResponse | object | |
| - data.srtPlaybackResponse.srtPlaybackStreamId | String | Unique identifier id for the stream with initial play and max of 255 characters (e.g., playf21f7c0b45108a04f051692e83af2943) |
| - data.srtPlaybackResponse.srtPlaybackSecert | String | Unique identifier key for the stream, max of 255 characters. |
| created_at | string | Timestamp for when the webhook was created (e.g., 2023-12-06T09:12:28.808Z). |
| attempts | array | List of attempts created. |
Updated 18 days ago