Stream.Rtmp.InProgress

The Stream.Rtmp.InProgress event is sent whenever an RTMP stream is started.

{
  "conference": {
    "confId": "conferenceId_UUID",
    "confAlias": "example_conference_alias"
  },
  "thirdPartyId": "example_thirdpartyId",
  "region": "String",
  "eventType": "Stream.Rtmp.InProgress",
  "layoutUrl": "example_layoutUrl", 
  "mixId": "String[customer provided mixID]",
  "height": 1080,
  "width": 1920,
  "uri": "example_rtmp_uri",
}

The following table explains all fields of the webhook object:

Field name	Object	Type	Meaning	Example
conference. confId	Root	String	The identifier of the streamed conference.	a88484c6-2a47-4691-86e2-933eec80b316
conference.confAlias	Root	String	The alias of the streamed conference.	virtual event 1
thirdPartyId	Root	String	The app key. If you implemented a common webhook listener for multiple applications, this can help you to distinguish which application is this webhook event for.	XSTXp4EsAmMrg==
region	Root	String	The conference creation region. The possible values are: `ca`: Canada, `us`: United States, `eu`: Europe, `in`: India, `au`: Australia	eu
eventType	Root	String	The type of the webhook event.	Stream.Rtmp.InProgress
layoutUrl	Root	String	The URL of the layout used for streaming.	-
mixId	Root	String	The optional identifier provided by you when you started streaming. This ID helps to identify which layout and configuration was used to generate the stream.	landscape-stage
height	Root	Number	The frame height. The default value is `1080`.	720
width	Root	Number	The frame width. The default value is `1920`.	1280
uri	Root	String	The destination URI provided by the RTMP service, such as Youtube or Facebook.	-