Live stream events
Learn about the events used to create, connect, and manage live streams effectively.
FastPix emits a series of events throughout the lifecycle of a live stream, providing real-time insights into the status and activity of your streams. These events allow you to track when a stream is created, when an encoder connects, when recording starts, and when the stream goes live or ends. By subscribing to these events, you can build responsive applications that react to changes in your live streaming environment effectively.
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 (e.g., video.live_stream.created). |
| object | object | |
| - object.type | string | Type of the object (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| id | string | Unique identifier for the webhook event. |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., Development). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.streamId | string | Unique identifier for the stream. Max 255 characters (e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.streamKey | string | Unique key used for streaming to a Fastpix RTMP endpoint; treat it as sensitive as credentials. |
| - data.srtSecret | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - data.trial | boolean | Indicates if the stream is a trial stream (e.g., true/false). |
| - data.status | string | Current live stream status: idle (no broadcast), disabled (no RTMP streams), active (broadcast in progress). |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 28800). |
| - 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.enableRecording | boolean | Indicates if recording is enabled (e.g., true/false). |
| - data.enableDvrMode | boolean | Indicates if DVR mode is enabled for the stream (e.g., true/false). |
| - data.mediaPolicy | string | Access policy for the media (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.closedCaptions | boolean | Indicates if closed captions are enabled for the stream (e.g., true/false). |
| - data.playbackIds | array | |
| — data.playbackIds[].id | string | Unique identifier for the PlaybackID (e.g., 937d2668-6898-4b64-b044-aae4f7dedd5d). |
| — data.playbackIds[].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.srtPlaybackSecret | string | Unique identifier key for the stream, max of 255 characters. |
| createdAt | 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 (e.g., video.live_stream.preparing). |
| object | object | |
| - object.type | string | Type of the object (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| id | string | Unique identifier for the webhook event. |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., Development). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.streamId | string | Unique identifier for the stream. Max 255 characters (e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.streamKey | string | Unique key used for streaming to a Fastpix RTMP endpoint; treat it as sensitive as credentials. |
| - data.srtSecret | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - data.trial | boolean | Indicates if the stream is a trial stream (e.g., true/false). |
| - data.status | string | Current live stream status: idle (no broadcast), disabled (no RTMP streams), active (broadcast in progress), preparing (checking broadcast). |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 28800). |
| - 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.enableRecording | boolean | Indicates if recording is enabled (e.g., true/false). |
| - data.enableDvrMode | boolean | Indicates if DVR mode is enabled for the stream (e.g., true/false). |
| - data.mediaPolicy | string | Access policy for the media (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.closedCaptions | boolean | Indicates if closed captions are enabled for the stream (e.g., true/false). |
| - data.playbackIds | array | |
| — data.playbackIds[].id | string | Unique identifier for the PlaybackID (e.g., 937d2668-6898-4b64-b044-aae4f7dedd5d). |
| — data.playbackIds[].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.srtPlaybackSecret | string | Unique identifier key for the stream, max of 255 characters. |
| createdAt | 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 for the webhook event (e.g., video.live_stream.connected). |
| object | object | |
| - object.type | string | Type of the object (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| id | string | Unique identifier for the webhook event. |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., Development). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.streamId | string | Unique identifier for the stream. Max 255 characters (e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.streamKey | string | Unique key used for streaming to a Fastpix RTMP endpoint; treat it as sensitive as credentials. |
| - data.srtSecret | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - data.trial | boolean | Indicates if the stream is a trial stream (e.g., true/false). |
| - data.status | string | Current live stream status: idle (no broadcast), disabled (no RTMP streams), active (broadcast in progress), preparing (checking broadcast). |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 28800). |
| - 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.enableRecording | boolean | Indicates if recording is enabled (e.g., true/false). |
| - data.enableDvrMode | boolean | Indicates if DVR mode is enabled for the stream (e.g., true/false). |
| - data.mediaPolicy | string | Access policy for the media (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.closedCaptions | boolean | Indicates if closed captions are enabled for the stream (e.g., true/false). |
| - data.playbackIds | array | |
| — data.playbackIds[].id | string | Unique identifier for the PlaybackID (e.g., 937d2668-6898-4b64-b044-aae4f7dedd5d). |
| — data.playbackIds[].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.srtPlaybackSecret | string | Unique identifier key for the stream, max of 255 characters. |
| createdAt | 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.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 (e.g., video.live_stream.active). |
| object | object | |
| - object.type | string | Type of the object (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| id | string | Unique identifier for the webhook event. |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., Development). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.streamId | string | Unique identifier for the stream. Max 255 characters (e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.streamKey | string | Unique key used for streaming to a Fastpix RTMP endpoint; treat it as sensitive as credentials. |
| - data.srtSecret | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - data.trial | boolean | Indicates if the stream is a trial stream (e.g., true/false). |
| - data.status | string | Current live stream status: idle (no broadcast), disabled (no RTMP streams), active (broadcast in progress), preparing (checking broadcast). |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 28800). |
| - 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.enableRecording | boolean | Indicates if recording is enabled (e.g., true/false). |
| - data.enableDvrMode | boolean | Indicates if DVR mode is enabled for the stream (e.g., true/false). |
| - data.mediaPolicy | string | Access policy for the media (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.closedCaptions | boolean | Indicates if closed captions are enabled for the stream (e.g., true/false). |
| - data.playbackIds | array | |
| — data.playbackIds[].id | string | Unique identifier for the PlaybackID (e.g., 937d2668-6898-4b64-b044-aae4f7dedd5d). |
| — data.playbackIds[].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.srtPlaybackSecret | string | Unique identifier key for the stream, max of 255 characters. |
| createdAt | 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.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 (e.g., video.live_stream.recording). |
| object | object | |
| - object.type | string | Type of the object (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| id | string | Unique identifier for the webhook event. |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., Development). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.streamId | string | Unique identifier for the stream. Max 255 characters (e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.streamKey | string | Unique key used for streaming to a Fastpix RTMP endpoint; treat it as sensitive as credentials. |
| - data.srtSecret | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - data.trial | boolean | Indicates if the stream is a trial stream (e.g., true/false). |
| - data.status | string | Current live stream status: idle (no broadcast), disabled (no RTMP streams), active (broadcast in progress), preparing (checking broadcast). |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 28800). |
| - 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.enableRecording | boolean | Indicates if recording is enabled (e.g., true/false). |
| - data.enableDvrMode | boolean | Indicates if DVR mode is enabled for the stream (e.g., true/false). |
| - data.mediaPolicy | string | Access policy for the media (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.closedCaptions | boolean | Indicates if closed captions are enabled for the stream (e.g., true/false). |
| - data.playbackIds | array | |
| — data.playbackIds[].id | string | Unique identifier for the PlaybackID (e.g., 937d2668-6898-4b64-b044-aae4f7dedd5d). |
| — data.playbackIds[].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.srtPlaybackSecret | string | Unique identifier key for the stream, max of 255 characters. |
| createdAt | 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 (e.g., video.live_stream.disconnected). |
| object | object | |
| - object.type | string | Type of the object (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| id | string | Unique identifier for the webhook event. |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., Development). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.streamId | string | Unique identifier for the stream. Max 255 characters (e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.streamKey | string | Unique key used for streaming to a Fastpix RTMP endpoint; treat it as sensitive as credentials. |
| - data.srtSecret | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - data.trial | boolean | Indicates if the stream is a trial stream (e.g., true/false). |
| - data.status | string | Current live stream status: idle (no broadcast), disabled (no RTMP streams), active (broadcast in progress), preparing (checking broadcast). |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 28800). |
| - 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.enableRecording | boolean | Indicates if recording is enabled (e.g., true/false). |
| - data.enableDvrMode | boolean | Indicates if DVR mode is enabled for the stream (e.g., true/false). |
| - data.mediaPolicy | string | Access policy for the media (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.closedCaptions | boolean | Indicates if closed captions are enabled for the stream (e.g., true/false). |
| - data.playbackIds | array | |
| — data.playbackIds[].id | string | Unique identifier for the PlaybackID (e.g., 937d2668-6898-4b64-b044-aae4f7dedd5d). |
| — data.playbackIds[].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.srtPlaybackSecret | string | Unique identifier key for the stream, max of 255 characters. |
| createdAt | 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 (e.g., video.live_stream.idle). |
| object | object | |
| - object.type | string | Type of the object (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| id | string | Unique identifier for the webhook event. |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., Development). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.streamId | string | Unique identifier for the stream. Max 255 characters (e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.streamKey | string | Unique key used for streaming to a Fastpix RTMP endpoint; treat it as sensitive as credentials. |
| - data.srtSecret | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - data.trial | boolean | Indicates if the stream is a trial stream (e.g., true/false). |
| - data.status | string | Current live stream status: idle (no broadcast), disabled (no RTMP streams), active (broadcast in progress), preparing (checking broadcast). |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 28800). |
| - 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.enableRecording | boolean | Indicates if recording is enabled (e.g., true/false). |
| - data.enableDvrMode | boolean | Indicates if DVR mode is enabled for the stream (e.g., true/false). |
| - data.mediaPolicy | string | Access policy for the media (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.closedCaptions | boolean | Indicates if closed captions are enabled for the stream (e.g., true/false). |
| - data.playbackIds | array | |
| — data.playbackIds[].id | string | Unique identifier for the PlaybackID (e.g., 937d2668-6898-4b64-b044-aae4f7dedd5d). |
| — data.playbackIds[].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.srtPlaybackSecret | string | Unique identifier key for the stream, max of 255 characters. |
| createdAt | 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.disabled
Triggered when a live stream is disabled and can no longer accept RTMP streams. This typically happens when a trial stream ends or the stream is deactivated. Use this event to update your UI or halt any dependent workflows for the stream.
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event (e.g., video.live_stream.disabled). |
| object | object | |
| - object.type | string | Type of the object (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| id | string | Unique identifier for the webhook event. |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., Development). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.streamId | string | Unique identifier for the stream. Max 255 characters (e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.streamKey | string | Unique key used for streaming to a Fastpix RTMP endpoint; treat it as sensitive as credentials. |
| - data.srtSecret | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - data.trial | boolean | Indicates if the stream is a trial stream (e.g., true/false). |
| - data.status | string | Current live stream status: idle (no broadcast), disabled (no RTMP streams), active (broadcast in progress), preparing (checking broadcast). |
| - 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. Default is 60 seconds for Standard Latency. |
| - data.enableRecording | boolean | Indicates if recording is enabled (e.g., true/false). |
| - data.enableDvrMode | boolean | Indicates if DVR mode is enabled for the stream (e.g., true/false). |
| - data.mediaPolicy | string | Access policy for the media (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.closedCaptions | boolean | Indicates if closed captions are enabled for the stream (e.g., true/false). |
| - data.playbackIds | array | |
| — data.playbackIds[].id | string | Unique identifier for the PlaybackID (e.g., 937d2668-6898-4b64-b044-aae4f7dedd5d). |
| — data.playbackIds[].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.srtPlaybackSecret | string | Unique identifier key for the stream, max of 255 characters. |
| createdAt | 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 (e.g., video.live_stream.updated). |
| object | object | |
| - object.type | string | Type of the object (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| id | string | Unique identifier for the webhook event. |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., Development). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.streamId | string | Unique identifier for the stream. Max 255 characters (e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.streamKey | string | Unique key used for streaming to a Fastpix RTMP endpoint; treat it as sensitive as credentials. |
| - data.srtSecret | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - data.trial | boolean | Indicates if the stream is a trial stream (e.g., true/false). |
| - data.status | string | Current live stream status: idle (no broadcast), disabled (no RTMP streams), active (broadcast in progress), preparing (checking broadcast). |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 28800). |
| - 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.enableRecording | boolean | Indicates if recording is enabled (e.g., true/false). |
| - data.enableDvrMode | boolean | Indicates if DVR mode is enabled for the stream (e.g., true/false). |
| - data.mediaPolicy | string | Access policy for the media (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.closedCaptions | boolean | Indicates if closed captions are enabled for the stream (e.g., true/false). |
| - data.playbackIds | array | |
| — data.playbackIds[].id | string | Unique identifier for the PlaybackID (e.g., 937d2668-6898-4b64-b044-aae4f7dedd5d). |
| — data.playbackIds[].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.srtPlaybackSecret | string | Unique identifier key for the stream, max of 255 characters. |
| - data.mediaIds | array | List of media (VOD) asset IDs generated from the live stream (e.g., 0ebee635-ae85-4183-80c5-19b7cbb3a5bd). |
| createdAt | 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 (e.g., video.live_stream.deleted). |
| object | object | |
| - object.type | string | Type of the object (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| id | string | Unique identifier for the webhook event. |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., Development). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.streamId | string | Unique identifier for the stream. Max 255 characters (e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.streamKey | string | Unique key used for streaming to a Fastpix RTMP endpoint; treat it as sensitive as credentials. |
| - data.srtSecret | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - data.trial | boolean | Indicates if the stream is a trial stream (e.g., true/false). |
| - data.status | string | Current live stream status: idle (no broadcast), disabled (no RTMP streams), active (broadcast in progress), preparing (checking broadcast). |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 28800). |
| - 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.enableRecording | boolean | Indicates if recording is enabled (e.g., true/false). |
| - data.enableDvrMode | boolean | Indicates if DVR mode is enabled for the stream (e.g., true/false). |
| - data.mediaPolicy | string | Access policy for the media (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.closedCaptions | boolean | Indicates if closed captions are enabled for the stream (e.g., true/false). |
| - data.playbackIds | array | |
| — data.playbackIds[].id | string | Unique identifier for the PlaybackID (e.g., 937d2668-6898-4b64-b044-aae4f7dedd5d). |
| — data.playbackIds[].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.srtPlaybackSecret | string | Unique identifier key for the stream, max of 255 characters. |
| - data.mediaIds | array | List of media (VOD) asset IDs generated from the live stream (e.g., 0ebee635-ae85-4183-80c5-19b7cbb3a5bd). |
| createdAt | 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.playback_id.created
Triggered when a new playback ID is created for a live stream. The event includes the playback ID and its access policy.
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event (e.g., video.live_stream.playback_id.created). |
| object | object | |
| - object.type | string | Type of the object (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 543c515cc2d226548f195c758343254d). |
| id | string | Unique identifier for the webhook event. |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., Development). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.id | string | Unique identifier for the playback ID (e.g., 3608323e-60a9-407c-9293-582f221ed054). |
| - data.accessPolicy | string | Access policy for the playback ID; can be public or private. |
| createdAt | 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.playback_id.deleted
Triggered when a playback ID is deleted from a live stream. The event includes the playback ID and its access policy.
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event (e.g., video.live_stream.playback_id.deleted). |
| object | object | |
| - object.type | string | Type of the object (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 543c515cc2d226548f195c758343254d). |
| id | string | Unique identifier for the webhook event. |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., Development). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.id | string | Unique identifier for the playback ID (e.g., 3608323e-60a9-407c-9293-582f221ed054). |
| - data.accessPolicy | string | Access policy for the playback ID; can be public or private. |
| createdAt | 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 (e.g., video.live_stream.simulcast_target.created). |
| object | object | |
| - object.type | string | Type of the object (e.g., simulcast_target). |
| - object.id | string | Unique identifier for the simulcast target (e.g., da39590b0a3e9564e79a1beb0b4144f4). |
| id | string | Unique identifier for the webhook event. |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., Development). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| status | string | Current status of the simulcast target (e.g., idle). |
| data | object | |
| - data.livestreamId | string | Unique identifier for the live stream (max 255 characters, e.g., 211d27fb21191765d52b8e63701dfe0f). |
| - data.simulcastId | string | Unique identifier for the simulcast (max 255 characters, e.g., da39590b0a3e9564e79a1beb0b4144f4). |
| - data.url | string | RTMP(S) URL for linking to a third-party live streaming service (e.g., rtmps://static.fastpix.io/fp-sample-video.mp4). |
| - data.streamKey | string | Unique identifier used to transmit the main live stream to a third-party service (e.g., 87wj-ye9u-6dp9-7rmk-6x9a). |
| - data.isEnabled | boolean | Indicates if the simulcast target is enabled (e.g., true/false). |
| - data.metadata | object | User-supplied metadata included in the stream details (e.g., {name:fastpix}). |
| createdAt | 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 (e.g., video.live_stream.simulcast_target.updated). |
| object | object | |
| - object.type | string | Type of the object (e.g., simulcast_target). |
| - object.id | string | Unique identifier for the simulcast target (e.g., da39590b0a3e9564e79a1beb0b4144f4). |
| id | string | Unique identifier for the webhook event. |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., Development). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| status | string | Current status of the simulcast target (e.g., updated). |
| data | object | |
| - data.livestreamId | string | Unique identifier for the live stream (max 255 characters, e.g., 211d27fb21191765d52b8e63701dfe0f). |
| - data.simulcastId | string | Unique identifier for the simulcast (max 255 characters, e.g., da39590b0a3e9564e79a1beb0b4144f4). |
| - data.url | string | RTMP(S) URL for linking to a third-party live streaming service (e.g., rtmps://static.fastpix.io/fp-sample-video.mp4). |
| - data.streamKey | string | Unique identifier used to transmit the main live stream to a third-party service (e.g., 87wj-ye9u-6dp9-7rmk-6x9a). |
| - data.isEnabled | boolean | Indicates if the simulcast target is enabled (e.g., true/false). |
| - data.metadata | object | User-supplied metadata included in the stream details (e.g., {name:fastpix}). |
| createdAt | 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 (e.g., video.live_stream.simulcast_target.deleted). |
| object | object | |
| - object.type | string | Type of the object (e.g., simulcast_target). |
| - object.id | string | Unique identifier for the simulcast target (e.g., da39590b0a3e9564e79a1beb0b4144f4). |
| id | string | Unique identifier for the webhook event. |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., Development). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| status | string | Current status of the simulcast target (e.g., deleted). |
| data | object | |
| - data.livestreamId | string | Unique identifier for the live stream (max 255 characters, e.g., 211d27fb21191765d52b8e63701dfe0f). |
| - data.simulcastId | string | Unique identifier for the simulcast (max 255 characters, e.g., da39590b0a3e9564e79a1beb0b4144f4). |
| - data.url | string | RTMP(S) URL for linking to a third-party live streaming service (e.g., rtmps://static.fastpix.io/fp-sample-video.mp4). |
| - data.streamKey | string | Unique identifier used to transmit the main live stream to a third-party service (e.g., 87wj-ye9u-6dp9-7rmk-6x9a). |
| - data.isEnabled | boolean | Indicates if the simulcast target is enabled (e.g., true/false). |
| - data.metadata | object | User-supplied metadata included in the stream details (e.g., {name:fastpix}). |
| createdAt | 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.rtmp_detected
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event (e.g., video.live_stream.rtmp_detected). |
| object | object | |
| - object.type | string | Type of the object (e.g., live). |
| - object.id | string | Unique identifier for the livestream (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| id | string | Unique identifier for the webhook event. |
| workspace | object | |
| - workspace.name | string | Name for the environment (e.g., Development). |
| - workspace.id | string | Unique identifier for the environment (e.g., 9oa85f64-5717-4562-b3fc-2c963f66afa6). |
| data | object | |
| - data.streamId | string | Unique identifier for the stream. Max 255 characters (e.g., a0ba2bf6-fe6b-441c-a9be-bf910d223218). |
| - data.streamKey | string | Unique key used for streaming to a Fastpix RTMP endpoint; treat it as sensitive as credentials. |
| - data.srtSecret | string | Unique key used for streaming to a FastPix endpoint; treat it as sensitive as credentials. |
| - data.trial | boolean | Indicates if the stream is a trial stream (e.g., true/false). |
| - data.status | string | Current live stream status: idle (no broadcast), disabled (no RTMP streams), active (broadcast in progress), preparing (checking broadcast). |
| - data.maxResolution | string | Maximum resolution for the live broadcast (e.g., 1080p). |
| - data.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 28800). |
| - 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.enableRecording | boolean | Indicates if recording is enabled (e.g., true/false). |
| - data.enableDvrMode | boolean | Indicates if DVR mode is enabled for the stream (e.g., true/false). |
| - data.mediaPolicy | string | Access policy for the media (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.closedCaptions | boolean | Indicates if closed captions are enabled for the stream (e.g., true/false). |
| - data.playbackIds | array | |
| — data.playbackIds[].id | string | Unique identifier for the PlaybackID (e.g., 937d2668-6898-4b64-b044-aae4f7dedd5d). |
| — data.playbackIds[].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.srtPlaybackSecret | string | Unique identifier key for the stream, max of 255 characters. |
| createdAt | string | Timestamp for when the webhook was created (e.g., 2023-12-06T09:12:28.808Z). |
| attempts | array | List of attempts created. |