Guest Star - EventSub Reference

Channel Guest Star Guest Update

BetaThe channel.guest_star_guest.update subscription type sends a notification when a guest or a slot is updated in an active Guest Star session.

Subscription

Type: channel.guest_star_guest.update
Version: beta

Authorization

Requires one of the following:

A user access token that includes the channel:read:guest_star, channel:manage:guest_star, moderator:read:guest_star, or moderator:manage:guest_star scope.
An app access token.The application, through prior authorization, must have been granted:
- The channel:read:guest_star, channel:manage:guest_star, moderator:read:guest_star, or moderator:manage:guest_star scope for the user represented by the moderator_user_id event condition.

Subscription Request Body

typeStringRequired
The subscription type name: channel.guest_star_guest.update.
versionStringRequired
The subscription type version: beta.
conditionObjectRequired
An object that contains subscription-specific parameters.
Hide child attributesShow child attributes
- condition.broadcaster_user_idStringRequired
  The broadcaster user ID for the channel you want to receive Guest Star guest update notifications for.
- condition.moderator_user_idStringRequired
  The user ID of the moderator or broadcaster of the specified channel.
transportObjectRequired
Transport-specific parameters.
Hide child attributesShow child attributes
- transport.methodStringRequired
  The transport method for EventSub.
  Possible values
  - webhook
  - websocket
  - conduit
- transport.callbackString
  The callback URL where notifications are sent. The URL must use the HTTPS protocol and port 443. See Processing an Event.
  
  Specify this field only if method is set to webhook.
  
  NOTE: Redirects are not followed.
- transport.secretString
  The secret used to verify the signature. The secret must be an ASCII string that's a minimum of 10 characters long and a maximum of 100 characters long. For information about how the secret is used, see Verifying the event message.
  
  Specify this field only if the method is set to webhook.
- transport.session_idString
  An ID that identifies the WebSocket to send notifications to. When you connect to EventSub using WebSockets, the server returns the ID in the Welcome message.
  
  Specify this field only if the method is set to websocket.
- transport.conduit_idString
  An ID that identifies the conduit to send this notification to. When you create a conduit, the server returns the ID in the API response.
  
  Specify this field only if the method is set to conduit.

Event Payload

subscriptionObject
Metadata about the subscription.
Hide child attributesShow child attributes
- subscription.idString
  The Subscription ID of the subscription.
- subscription.typeString
  The notification's subscription type.
- subscription.versionString
  The version of the subscription.
- subscription.statusString
  The status of the subscription.
- subscription.costInteger
  How much the subscription counts against your limit. See Subscription Limits for more information.
- subscription.conditionObject
  Subscription-specific parameters.
  Hide child attributesShow child attributes
  - subscription.condition.broadcaster_user_idString
    The broadcaster user ID for the channel you want to receive Guest Star guest update notifications for.
  - subscription.condition.moderator_user_idString
    The user ID of the moderator or broadcaster of the specified channel.
- subscription.created_atString
  The time the notification was created.
- subscription.transportObject
  Transport-specific parameters.
  Hide child attributesShow child attributes
  - subscription.transport.methodString
    The transport method for EventSub.
    Possible values
    webhook
    websocket
    conduit
  - subscription.transport.callbackString
    The callback URL where notifications are sent. The URL must use the HTTPS protocol and port 443. See Processing an Event.
    
    Specify this field only if method is set to webhook.
    
    NOTE: Redirects are not followed.
  - subscription.transport.secretString
    The secret used to verify the signature. The secret must be an ASCII string that's a minimum of 10 characters long and a maximum of 100 characters long. For information about how the secret is used, see Verifying the event message.
    
    Specify this field only if the method is set to webhook.
  - subscription.transport.session_idString
    An ID that identifies the WebSocket to send notifications to. When you connect to EventSub using WebSockets, the server returns the ID in the Welcome message.
    
    Specify this field only if the method is set to websocket.
  - subscription.transport.conduit_idString
    An ID that identifies the conduit to send this notification to. When you create a conduit, the server returns the ID in the API response.
    
    Specify this field only if the method is set to conduit.
eventObject
The event information.
Hide child attributesShow child attributes
- event.broadcaster_user_idString
  The non-host broadcaster user ID.
- event.broadcaster_user_nameString
  The non-host broadcaster display name.
- event.broadcaster_user_loginString
  The non-host broadcaster login.
- event.session_idString
  ID representing the unique session that was started.
- event.moderator_user_idStringNullable
  The user ID of the moderator who updated the guest's state (could be the host). null if the update was performed by the guest.
- event.moderator_user_nameStringNullable
  The moderator display name.null if the update was performed by the guest.
- event.moderator_user_loginStringNullable
  The moderator login. null if the update was performed by the guest.
- event.guest_user_idStringNullable
  The user ID of the guest who transitioned states in the session. null if the slot is now empty.
- event.guest_user_nameStringNullable
  The guest display name. null if the slot is now empty.
- event.guest_user_loginStringNullable
  The guest login. null if the slot is now empty.
- event.slot_idStringNullable
  The ID of the slot assignment the guest is assigned to. null if the guest is in the INVITED, REMOVED, READY, or ACCEPTED state.
- event.stateStringNullable
  The current state of the user after the update has taken place. null if the slot is now empty.
  Possible values
  - invited
    The guest has transitioned to the invite queue. This can take place when the guest was previously assigned a slot, but have been removed from the call and are sent back to the invite queue.
  - accepted
    The guest has accepted the invite and is currently in the process of setting up to join the session.
  - ready
    The guest has signaled they are ready and can be assigned a slot.
  - backstage
    The guest has been assigned a slot in the session, but is not currently seen live in the broadcasting software.
  - live
    The guest is now live in the host's broadcasting software.
- event.host_user_idString
  User ID of the host channel.
- event.host_user_nameString
  The host display name.
- event.host_user_loginString
  The host login.
- event.host_video_enabledBooleanNullable
  Flag that signals whether the host is allowing the slot's video to be seen by participants within the session. null if the guest is not slotted.
- event.host_audio_enabledBooleanNullable
  Flag that signals whether the host is allowing the slot's audio to be heard by participants within the session. null if the guest is not slotted.
- event.host_volumeIntegerNullable
  Value between 0-100 that represents the slot's audio level as heard by participants within the session. null if the guest is not slotted.

Subscription Request Body Example

{
  "type": "channel.guest_star_guest.update",
  "version": "beta",
  "condition": {
    "broadcaster_user_id": "1337",
    "moderator_user_id": "1312"
  },
  "transport": {
    "method": "webhook",
    "callback": "https://example.com/webhooks/callback",
    "secret": "s3cRe7"
  }
}

{
  "type": "channel.guest_star_guest.update",
  "version": "beta",
  "condition": {
    "broadcaster_user_id": "1337",
    "moderator_user_id": "1312"
  },
  "transport": {
    "method": "websocket",
    "session_id": "AQoQexAWVYKSTIu4ec_2VAxyuhAB"
  }
}

{
  "type": "channel.guest_star_guest.update",
  "version": "beta",
  "condition": {
    "broadcaster_user_id": "1337",
    "moderator_user_id": "1312"
  },
  "transport": {
    "method": "conduit",
    "conduit_id": "bfcfc993-26b1-b876-44d9-afe75a379dac"
  }
}

Event Payload Example

{
    "subscription": {
        "id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
        "type": "channel.guest_star_guest.update",
        "version": "beta",
        "status": "enabled",
        "cost": 0,
        "condition": {
            "broadcaster_user_id": "1337",
            "moderator_user_id": "1312"
        },
         "transport": {
            "method": "webhook",
            "callback": "https://example.com/webhooks/callback"
        },
        "created_at": "2023-04-11T10:11:32.123Z"
    },
    "event": {
        "broadcaster_user_id": "1337",
        "broadcaster_user_name": "Cool_User",
        "broadcaster_user_login": "cool_user",
        "session_id": "2KFRQbFtpmfyD3IevNRnCzOPRJI",
        "moderator_user_id": "1312",
        "moderator_user_name": "Cool_Mod",
        "moderator_user_login": "cool_mod",
        "guest_user_id": "1234",
        "guest_user_name": "Cool_Guest",
        "guest_user_login": "cool_guest",
        "slot_id": "1",
        "state": "live",
        "host_video_enabled": true,
        "host_audio_enabled": true,
        "host_volume": 100
    }
}

Channel Guest Star Session Begin

BetaThe channel.guest_star_session.begin subscription type sends a notification when the host begins a new Guest Star session.

Subscription

Type: channel.guest_star_session.begin
Version: beta

Authorization

Requires one of the following:

A user access token that includes the channel:read:guest_star, channel:manage:guest_star, moderator:read:guest_star, or moderator:manage:guest_star scope.
An app access token.The application, through prior authorization, must have been granted:
- The channel:read:guest_star, channel:manage:guest_star, moderator:read:guest_star, or moderator:manage:guest_star scope for the user represented by the moderator_user_id event condition.

Subscription Request Body

typeStringRequired
The subscription type name: channel.guest_star_session.begin.
versionStringRequired
The subscription type version: beta.
conditionObjectRequired
An object that contains subscription-specific parameters.
Hide child attributesShow child attributes
- condition.broadcaster_user_idStringRequired
  The broadcaster user ID for the channel you want to receive Guest Star session begin notifications for.
- condition.moderator_user_idStringRequired
  The user ID of the moderator or broadcaster of the specified channel.
transportObjectRequired
Transport-specific parameters.
Hide child attributesShow child attributes
- transport.methodStringRequired
  The transport method for EventSub.
  Possible values
  - webhook
  - websocket
  - conduit
- transport.callbackString
  The callback URL where notifications are sent. The URL must use the HTTPS protocol and port 443. See Processing an Event.
  
  Specify this field only if method is set to webhook.
  
  NOTE: Redirects are not followed.
- transport.secretString
  The secret used to verify the signature. The secret must be an ASCII string that's a minimum of 10 characters long and a maximum of 100 characters long. For information about how the secret is used, see Verifying the event message.
  
  Specify this field only if the method is set to webhook.
- transport.session_idString
  An ID that identifies the WebSocket to send notifications to. When you connect to EventSub using WebSockets, the server returns the ID in the Welcome message.
  
  Specify this field only if the method is set to websocket.
- transport.conduit_idString
  An ID that identifies the conduit to send this notification to. When you create a conduit, the server returns the ID in the API response.
  
  Specify this field only if the method is set to conduit.

Event Payload

subscriptionObject
Metadata about the subscription.
Hide child attributesShow child attributes
- subscription.idString
  The Subscription ID of the subscription.
- subscription.typeString
  The notification's subscription type.
- subscription.versionString
  The version of the subscription.
- subscription.statusString
  The status of the subscription.
- subscription.costInteger
  How much the subscription counts against your limit. See Subscription Limits for more information.
- subscription.conditionObject
  Subscription-specific parameters.
  Hide child attributesShow child attributes
  - subscription.condition.broadcaster_user_idString
    The broadcaster user ID for the channel you want to receive Guest Star session begin notifications for.
  - subscription.condition.moderator_user_idString
    The user ID of the moderator or broadcaster of the specified channel.
- subscription.created_atString
  The time the notification was created.
- subscription.transportObject
  Transport-specific parameters.
  Hide child attributesShow child attributes
  - subscription.transport.methodString
    The transport method for EventSub.
    Possible values
    webhook
    websocket
    conduit
  - subscription.transport.callbackString
    The callback URL where notifications are sent. The URL must use the HTTPS protocol and port 443. See Processing an Event.
    
    Specify this field only if method is set to webhook.
    
    NOTE: Redirects are not followed.
  - subscription.transport.secretString
    The secret used to verify the signature. The secret must be an ASCII string that's a minimum of 10 characters long and a maximum of 100 characters long. For information about how the secret is used, see Verifying the event message.
    
    Specify this field only if the method is set to webhook.
  - subscription.transport.session_idString
    An ID that identifies the WebSocket to send notifications to. When you connect to EventSub using WebSockets, the server returns the ID in the Welcome message.
    
    Specify this field only if the method is set to websocket.
  - subscription.transport.conduit_idString
    An ID that identifies the conduit to send this notification to. When you create a conduit, the server returns the ID in the API response.
    
    Specify this field only if the method is set to conduit.
eventObject
The event information.
Hide child attributesShow child attributes
- event.broadcaster_user_idString
  The broadcaster user ID.
- event.broadcaster_user_nameString
  The broadcaster display name.
- event.broadcaster_user_loginString
  The broadcaster login.
- event.session_idString
  ID representing the unique session that was started.
- event.started_atString
  RFC3339 timestamp indicating the time the session began.

Subscription Request Body Example

{
  "type": "channel.guest_star_session.begin",
  "version": "beta",
  "condition": {
    "broadcaster_user_id": "1337",
    "moderator_user_id": "1338"
  },
  "transport": {
    "method": "webhook",
    "callback": "https://example.com/webhooks/callback",
    "secret": "s3cRe7"
  }
}

{
  "type": "channel.guest_star_session.begin",
  "version": "beta",
  "condition": {
    "broadcaster_user_id": "1337",
    "moderator_user_id": "1338"
  },
  "transport": {
    "method": "websocket",
    "session_id": "AQoQexAWVYKSTIu4ec_2VAxyuhAB"
  }
}

{
  "type": "channel.guest_star_session.begin",
  "version": "beta",
  "condition": {
    "broadcaster_user_id": "1337",
    "moderator_user_id": "1338"
  },
  "transport": {
    "method": "conduit",
    "conduit_id": "bfcfc993-26b1-b876-44d9-afe75a379dac"
  }
}

Event Payload Example

{
    "subscription": {
        "id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
        "type": "channel.guest_star_session.begin",
        "version": "beta",
        "status": "enabled",
        "cost": 0,
        "condition": {
            "broadcaster_user_id": "1337",
            "moderator_user_id": "1338"
        },
         "transport": {
            "method": "webhook",
            "callback": "https://example.com/webhooks/callback"
        },
        "created_at": "2023-04-11T10:11:12.123Z"
    },
    "event": {
        "broadcaster_user_id": "1337",
        "broadcaster_user_name": "Cool_User",
        "broadcaster_user_login": "cool_user",
        "session_id": "2KFRQbFtpmfyD3IevNRnCzOPRJI",
        "started_at": "2023-04-11T16:20:03.17106713Z"
    }
}

Channel Guest Star Session End

BetaThe channel.guest_star_session.end subscription type sends a notification when a running Guest Star session is ended by the host, or automatically by the system.

Subscription

Type: channel.guest_star_session.end
Version: beta

Authorization

Requires one of the following:

A user access token that includes the channel:read:guest_star, channel:manage:guest_star, moderator:read:guest_star, or moderator:manage:guest_star scope.
An app access token.The application, through prior authorization, must have been granted:
- The channel:read:guest_star, channel:manage:guest_star, moderator:read:guest_star, or moderator:manage:guest_star scope for the user represented by the moderator_user_id event condition.

Subscription Request Body

typeStringRequired
The subscription type name: channel.guest_star_session.end.
versionStringRequired
The subscription type version: beta.
conditionObjectRequired
An object that contains subscription-specific parameters.
Hide child attributesShow child attributes
- condition.broadcaster_user_idStringRequired
  The broadcaster user ID for the channel you want to receive Guest Star session end notifications for.
- condition.moderator_user_idStringRequired
  The user ID of the moderator or broadcaster of the specified channel.
transportObjectRequired
Transport-specific parameters.
Hide child attributesShow child attributes
- transport.methodStringRequired
  The transport method for EventSub.
  Possible values
  - webhook
  - websocket
  - conduit
- transport.callbackString
  The callback URL where notifications are sent. The URL must use the HTTPS protocol and port 443. See Processing an Event.
  
  Specify this field only if method is set to webhook.
  
  NOTE: Redirects are not followed.
- transport.secretString
  The secret used to verify the signature. The secret must be an ASCII string that's a minimum of 10 characters long and a maximum of 100 characters long. For information about how the secret is used, see Verifying the event message.
  
  Specify this field only if the method is set to webhook.
- transport.session_idString
  An ID that identifies the WebSocket to send notifications to. When you connect to EventSub using WebSockets, the server returns the ID in the Welcome message.
  
  Specify this field only if the method is set to websocket.
- transport.conduit_idString
  An ID that identifies the conduit to send this notification to. When you create a conduit, the server returns the ID in the API response.
  
  Specify this field only if the method is set to conduit.

Event Payload

subscriptionObject
Metadata about the subscription.
Hide child attributesShow child attributes
- subscription.idString
  The Subscription ID of the subscription.
- subscription.typeString
  The notification's subscription type.
- subscription.versionString
  The version of the subscription.
- subscription.statusString
  The status of the subscription.
- subscription.costInteger
  How much the subscription counts against your limit. See Subscription Limits for more information.
- subscription.conditionObject
  Subscription-specific parameters.
  Hide child attributesShow child attributes
  - subscription.condition.broadcaster_user_idString
    The broadcaster user ID for the channel you want to receive Guest Star session end notifications for.
  - subscription.condition.moderator_user_idString
    The user ID of the moderator or broadcaster of the specified channel.
- subscription.created_atString
  The time the notification was created.
- subscription.transportObject
  Transport-specific parameters.
  Hide child attributesShow child attributes
  - subscription.transport.methodString
    The transport method for EventSub.
    Possible values
    webhook
    websocket
    conduit
  - subscription.transport.callbackString
    The callback URL where notifications are sent. The URL must use the HTTPS protocol and port 443. See Processing an Event.
    
    Specify this field only if method is set to webhook.
    
    NOTE: Redirects are not followed.
  - subscription.transport.secretString
    The secret used to verify the signature. The secret must be an ASCII string that's a minimum of 10 characters long and a maximum of 100 characters long. For information about how the secret is used, see Verifying the event message.
    
    Specify this field only if the method is set to webhook.
  - subscription.transport.session_idString
    An ID that identifies the WebSocket to send notifications to. When you connect to EventSub using WebSockets, the server returns the ID in the Welcome message.
    
    Specify this field only if the method is set to websocket.
  - subscription.transport.conduit_idString
    An ID that identifies the conduit to send this notification to. When you create a conduit, the server returns the ID in the API response.
    
    Specify this field only if the method is set to conduit.
eventObject
The event information.
Hide child attributesShow child attributes
- event.broadcaster_user_idString
  The non-host broadcaster user ID.
- event.broadcaster_user_nameString
  The non-host broadcaster display name.
- event.broadcaster_user_loginString
  The non-host broadcaster login.
- event.session_idString
  ID representing the unique session that was started.
- event.started_atString
  RFC3339 timestamp indicating the time the session began.
- event.ended_atString
  RFC3339 timestamp indicating the time the session ended.
- event.host_user_idString
  User ID of the host channel.
- event.host_user_nameString
  The host display name.
- event.host_user_loginString
  The host login.

Subscription Request Body Example

{
  "type": "channel.guest_star_session.end",
  "version": "beta",
  "condition": {
    "broadcaster_user_id": "1337",
    "moderator_user_id": "1338"
  },
  "transport": {
    "method": "webhook",
    "callback": "https://example.com/webhooks/callback",
    "secret": "s3cRe7"
  }
}

{
  "type": "channel.guest_star_session.end",
  "version": "beta",
  "condition": {
    "broadcaster_user_id": "1337",
    "moderator_user_id": "1338"
  },
  "transport": {
    "method": "websocket",
    "session_id": "AQoQexAWVYKSTIu4ec_2VAxyuhAB"
  }
}

{
  "type": "channel.guest_star_session.end",
  "version": "beta",
  "condition": {
    "broadcaster_user_id": "1337",
    "moderator_user_id": "1338"
  },
  "transport": {
    "method": "conduit",
    "conduit_id": "bfcfc993-26b1-b876-44d9-afe75a379dac"
  }
}

Event Payload Example

{
    "subscription": {
        "id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
        "type": "channel.guest_star_session.end",
        "version": "beta",
        "status": "enabled",
        "cost": 0,
        "condition": {
            "broadcaster_user_id": "1337",
            "moderator_user_id": "1338"
        },
         "transport": {
            "method": "webhook",
            "callback": "https://example.com/webhooks/callback"
        },
        "created_at": "2023-04-11T10:11:22.123Z"
    },
    "event": {
        "broadcaster_user_id": "1337",
        "broadcaster_user_name": "Cool_User",
        "broadcaster_user_login": "cool_user",
        "session_id": "2KFRQbFtpmfyD3IevNRnCzOPRJI",
        "started_at": "2023-04-11T16:20:03.17106713Z",
        "ended_at": "2023-04-11T17:51:29.153485Z",
        "host_user_id": "141981764",
        "host_user_login": "twitchdev",
        "host_user_name": "TwitchDev"
    }
}

Channel Guest Star Settings Update

BetaThe channel.guest_star_settings.update subscription type sends a notification when the host preferences for Guest Star have been updated.

Subscription

Type: channel.guest_star_settings.update
Version: beta

Authorization

Requires one of the following:

A user access token that includes the channel:read:guest_star, channel:manage:guest_star, moderator:read:guest_star, or moderator:manage:guest_star scope.
An app access token.The application, through prior authorization, must have been granted:
- The channel:read:guest_star, channel:manage:guest_star, moderator:read:guest_star, or moderator:manage:guest_star scope for the user represented by the moderator_user_id event condition.

Subscription Request Body

typeStringRequired
The subscription type name: channel.guest_star_settings.update.
versionStringRequired
The subscription type version: beta.
conditionObjectRequired
An object that contains subscription-specific parameters.
Hide child attributesShow child attributes
- condition.broadcaster_user_idStringRequired
  The broadcaster user ID for the channel you want to receive Guest Star settings update notifications for.
- condition.moderator_user_idStringRequired
  The user ID of the moderator or broadcaster of the specified channel.
transportObjectRequired
Transport-specific parameters.
Hide child attributesShow child attributes
- transport.methodStringRequired
  The transport method for EventSub.
  Possible values
  - webhook
  - websocket
  - conduit
- transport.callbackString
  The callback URL where notifications are sent. The URL must use the HTTPS protocol and port 443. See Processing an Event.
  
  Specify this field only if method is set to webhook.
  
  NOTE: Redirects are not followed.
- transport.secretString
  The secret used to verify the signature. The secret must be an ASCII string that's a minimum of 10 characters long and a maximum of 100 characters long. For information about how the secret is used, see Verifying the event message.
  
  Specify this field only if the method is set to webhook.
- transport.session_idString
  An ID that identifies the WebSocket to send notifications to. When you connect to EventSub using WebSockets, the server returns the ID in the Welcome message.
  
  Specify this field only if the method is set to websocket.
- transport.conduit_idString
  An ID that identifies the conduit to send this notification to. When you create a conduit, the server returns the ID in the API response.
  
  Specify this field only if the method is set to conduit.

Event Payload

subscriptionObject
Metadata about the subscription.
Hide child attributesShow child attributes
- subscription.idString
  The Subscription ID of the subscription.
- subscription.typeString
  The notification's subscription type.
- subscription.versionString
  The version of the subscription.
- subscription.statusString
  The status of the subscription.
- subscription.costInteger
  How much the subscription counts against your limit. See Subscription Limits for more information.
- subscription.conditionObject
  Subscription-specific parameters.
  Hide child attributesShow child attributes
  - subscription.condition.broadcaster_user_idString
    The broadcaster user ID for the channel you want to receive Guest Star settings update notifications for.
  - subscription.condition.moderator_user_idString
    The user ID of the moderator or broadcaster of the specified channel.
- subscription.created_atString
  The time the notification was created.
- subscription.transportObject
  Transport-specific parameters.
  Hide child attributesShow child attributes
  - subscription.transport.methodString
    The transport method for EventSub.
    Possible values
    webhook
    websocket
    conduit
  - subscription.transport.callbackString
    The callback URL where notifications are sent. The URL must use the HTTPS protocol and port 443. See Processing an Event.
    
    Specify this field only if method is set to webhook.
    
    NOTE: Redirects are not followed.
  - subscription.transport.secretString
    The secret used to verify the signature. The secret must be an ASCII string that's a minimum of 10 characters long and a maximum of 100 characters long. For information about how the secret is used, see Verifying the event message.
    
    Specify this field only if the method is set to webhook.
  - subscription.transport.session_idString
    An ID that identifies the WebSocket to send notifications to. When you connect to EventSub using WebSockets, the server returns the ID in the Welcome message.
    
    Specify this field only if the method is set to websocket.
  - subscription.transport.conduit_idString
    An ID that identifies the conduit to send this notification to. When you create a conduit, the server returns the ID in the API response.
    
    Specify this field only if the method is set to conduit.
eventObject
The event information.
Hide child attributesShow child attributes
- event.broadcaster_user_idString
  User ID of the host channel.
- event.broadcaster_user_nameString
  The broadcaster display name
- event.broadcaster_user_loginString
  he broadcaster login.
- event.is_moderator_send_live_enabledBoolean
  Flag determining if Guest Star moderators have access to control whether a guest is live once assigned to a slot.
- event.slot_countInteger
  Number of slots the Guest Star call interface will allow the host to add to a call.
- event.is_browser_source_audio_enabledBoolean
  Flag determining if browser sources subscribed to sessions on this channel should output audio.
- event.group_layoutString
  This setting determines how the guests within a session should be laid out within a group browser source.
  Possible values
  - tiled
    All live guests are tiled within the browser source with the same size.
  - screenshare
    All live guests are tiled within the browser source with the same size. If there is an active screen share, it is sized larger than the other guests.
  - horizontal_top
    Indicates the group layout will contain all participants in a top-aligned horizontal stack.
  - horizontal_bottom
    Indicates the group layout will contain all participants in a bottom-aligned horizontal stack.
  - vertical_left
    Indicates the group layout will contain all participants in a left-aligned vertical stack.
  - vertical_right
    Indicates the group layout will contain all participants in a right-aligned vertical stack.

Subscription Request Body Example

{
  "type": "channel.guest_star_settings.update",
  "version": "beta",
  "condition": {
    "broadcaster_user_id": "1337",
    "moderator_user_id": "1312"
  },
  "transport": {
    "method": "webhook",
    "callback": "https://example.com/webhooks/callback",
    "secret": "s3cRe7"
  }
}

{
  "type": "channel.guest_star_settings.update",
  "version": "beta",
  "condition": {
    "broadcaster_user_id": "1337",
    "moderator_user_id": "1312"
  },
  "transport": {
    "method": "websocket",
    "session_id": "AQoQexAWVYKSTIu4ec_2VAxyuhAB"
  }
}

{
  "type": "channel.guest_star_settings.update",
  "version": "beta",
  "condition": {
    "broadcaster_user_id": "1337",
    "moderator_user_id": "1312"
  },
  "transport": {
    "method": "conduit",
    "conduit_id": "bfcfc993-26b1-b876-44d9-afe75a379dac"
  }
}

Event Payload Example

{
    "subscription": {
        "id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
        "type": "channel.guest_star_settings.update",
        "version": "beta",
        "status": "enabled",
        "cost": 0,
        "condition": {
            "broadcaster_user_id": "1337",
            "moderator_user_id": "1312"
        },
         "transport": {
            "method": "webhook",
            "callback": "https://example.com/webhooks/callback"
        },
        "created_at": "2023-04-11T10:11:52.123Z"
    },
    "event": {
        "broadcaster_user_id": "1337",
        "broadcaster_user_name": "Cool_User",
        "broadcaster_user_login": "cool_user",
        "is_moderator_send_live_enabled": true,
        "slot_count": 5,
        "is_browser_source_audio_enabled": true,
        "group_layout": "tiled"
    }
}