Preview active event details

Previews an event's configuration as if it was active. Inherited fields from the waiting room will be displayed with their current values.

Responses

🟢200Preview active event details response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object (event_details_result)

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "created_on": "2014-01-01T05:20:00.12345Z",
        "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
        "description": "Production event - DO NOT MODIFY",
        "disable_session_renewal": false,
        "event_end_time": "2021-09-28T17:00:00.000Z",
        "event_start_time": "2021-09-28T15:30:00.000Z",
        "id": "25756b2dfe6e378a06b033b670413757",
        "modified_on": "2014-01-01T05:20:00.12345Z",
        "name": "production_webinar_event",
        "new_users_per_minute": 0,
        "prequeue_start_time": "2021-09-28T15:00:00.000Z",
        "queueing_method": "random",
        "session_duration": 0,
        "shuffle_at_event_start": false,
        "suspended": false,
        "total_active_users": 0
    },
    "success": true
}

🟢200Preview active event details response failure

Preview active event details

Request

Request samples

Responses