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") |
| environment | object | |
| - environment.name | string | Name for the environment (e.g., "production") |
| - environment.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.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.maxDuration | integer | Duration (in seconds) that a live stream can last before disconnecting (e.g., 500). |
| - 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. |
| created_at | string | Timestamp for when the webhook was created (e.g., "2023-12-06T09:12:28.808Z"). |
| attempts | array | |
| accessor_source | string | |
| accessor | string | |
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 |
| 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") |
| environment | object | |
| - environment.name | string | Name for the environment (e.g., "production") |
| - environment.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 (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 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. 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.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". |
| created_at | string | Timestamp for when the webhook was created (e.g., "2023-12-06T09:12:28.808Z"). |
| attempts | array | |
| accessor_source | string | |
| accessor | string | |
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") |
| environment | object | |
| - environment.name | string | Name for the environment (e.g., "production") |
| - environment.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 (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 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.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". |
| created_at | string | Timestamp for when the webhook was created (e.g., "2023-12-06T09:12:28.808Z"). |
| attempts | array | |
| accessor_source | string | |
| accessor | string | |
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") |
| environment | object | |
| - environment.name | string | Name for the environment (e.g., "production") |
| - environment.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 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.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". |
| created_at | string | Timestamp for when the webhook was created (e.g., "2023-12-06T09:12:28.808Z"). |
| attempts | array | |
| accessor_source | string | |
| accessor | string | |
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") |
| environment | object | |
| - environment.name | string | Name for the environment (e.g., "production") |
| - environment.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.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". |
| created_at | string | Timestamp for when the webhook was created (e.g., "2023-12-06T09:12:28.808Z"). |
| attempts | array | |
| accessor_source | string | |
| accessor | string | |
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"). |
| environment | object | |
| - environment.name | string | Name for the environment (e.g., "production"). |
| - environment.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.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". |
| created_at | string | Timestamp for when the webhook was created (e.g., "2023-12-06T09:12:28.808Z"). |
| attempts | array | |
| accessor_source | string | |
| accessor | string | |
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"). |
| environment | object | |
| - environment.name | string | Name for the environment (e.g., "production"). |
| - environment.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.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". |
| created_at | string | Timestamp for when the webhook was created (e.g., "2023-12-06T09:12:28.808Z"). |
| attempts | array | |
| accessor_source | string | |
| accessor | string | |
| 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"). |
| environment | object | |
| - environment.name | string | Name for the environment (e.g., "production"). |
| - environment.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; the 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 set to false, the stream will process only the audio track. |
| - data.streamKey | string | Unique key for streaming to a Fastpix RTMP endpoint; treat it 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.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". |
| created_at | string | Timestamp for when the webhook was created (e.g., "2023-12-06T09:12:28.808Z"). |
| attempts | array | |
| accessor_source | string | |
| accessor | string | |
| 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"). |
| environment | object | |
| - environment.name | string | Name for the environment (e.g., "production"). |
| - environment.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; the 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 set to false, the stream will process only the audio track. |
| - data.streamKey | string | Unique key for streaming to a Fastpix RTMP endpoint; treat it 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.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". |
| created_at | string | Timestamp for when the webhook was created (e.g., "2023-12-06T09:12:28.808Z"). |
| attempts | array | |
| accessor_source | string | |
| accessor | string | |
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"). |
| environment | object | |
| - environment.name | string | Name for the environment (e.g., "production"). |
| - environment.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.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". |
| created_at | string | Timestamp for when the webhook was created (e.g., "2023-12-06T09:12:28.808Z"). |
| attempts | array | |
| accessor_source | string | |
| accessor | string | |
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"). |
| environment | object | |
| - environment.name | string | Name for the environment (e.g., "production"). |
| - environment.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 | |
| accessor_source | string | |
| accessor | string | |
| 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"). |
| environment | object | |
| - environment.name | string | Name for the environment (e.g., "production"). |
| - environment.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 | |
| accessor_source | string | |
| accessor | string | |
| 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"). |
| environment | object | |
| - environment.name | string | Name for the environment (e.g., "production"). |
| - environment.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 | |
| accessor_source | string | |
| accessor | string | |
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"). |
| environment | object | |
| - environment.name | string | Name for the environment (e.g., "production"). |
| - environment.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 | |
| accessor_source | string | |
| accessor | string | |
