Fetches a single configured event for a waiting room.
/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}
get
Waiting Room
waiting-room-event-details
{
"business": false,
"enterprise": true,
"free": false,
"pro": false
}null[
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"example": "25756b2dfe6e378a06b033b670413757"
}
},
{
"in": "path",
"name": "waiting_room_id",
"required": true,
"schema": {
"example": "699d98642c564d2e855e9661899b7252"
}
},
{
"in": "path",
"name": "zone_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"oneOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"created_on": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"custom_page_html": {
"description": "If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it.",
"example": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
"nullable": true,
"type": "string"
},
"description": {
"default": "",
"description": "A note that you can use to add more details about the event.",
"example": "Production event - DO NOT MODIFY",
"type": "string"
},
"disable_session_renewal": {
"description": "If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it.",
"nullable": true,
"type": "boolean"
},
"event_end_time": {
"description": "An ISO 8601 timestamp that marks the end of the event.",
"example": "2021-09-28T17:00:00.000Z",
"type": "string"
},
"event_start_time": {
"description": "An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time`.",
"example": "2021-09-28T15:30:00.000Z",
"type": "string"
},
"id": {
"example": "25756b2dfe6e378a06b033b670413757"
},
"modified_on": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"name": {
"description": "A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.",
"example": "production_webinar_event",
"type": "string"
},
"new_users_per_minute": {
"description": "If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` property is also set.",
"maximum": 2147483647,
"minimum": 200,
"nullable": true,
"type": "integer"
},
"prequeue_start_time": {
"description": "An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`.",
"example": "2021-09-28T15:00:00.000Z",
"nullable": true,
"type": "string"
},
"queueing_method": {
"description": "If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it.",
"example": "random",
"nullable": true,
"type": "string"
},
"session_duration": {
"description": "If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it.",
"maximum": 30,
"minimum": 1,
"nullable": true,
"type": "integer"
},
"shuffle_at_event_start": {
"default": false,
"description": "If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueing_method` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary.",
"type": "boolean"
},
"suspended": {
"default": false,
"description": "Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration.",
"type": "boolean"
},
"total_active_users": {
"description": "If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` property is also set.",
"maximum": 2147483647,
"minimum": 200,
"nullable": true,
"type": "integer"
}
},
"type": "object"
}
}
}
]
}
}
},
"description": "Event details response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"oneOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"created_on": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"custom_page_html": {
"description": "If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it.",
"example": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
"nullable": true,
"type": "string"
},
"description": {
"default": "",
"description": "A note that you can use to add more details about the event.",
"example": "Production event - DO NOT MODIFY",
"type": "string"
},
"disable_session_renewal": {
"description": "If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it.",
"nullable": true,
"type": "boolean"
},
"event_end_time": {
"description": "An ISO 8601 timestamp that marks the end of the event.",
"example": "2021-09-28T17:00:00.000Z",
"type": "string"
},
"event_start_time": {
"description": "An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time`.",
"example": "2021-09-28T15:30:00.000Z",
"type": "string"
},
"id": {
"example": "25756b2dfe6e378a06b033b670413757"
},
"modified_on": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"name": {
"description": "A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.",
"example": "production_webinar_event",
"type": "string"
},
"new_users_per_minute": {
"description": "If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` property is also set.",
"maximum": 2147483647,
"minimum": 200,
"nullable": true,
"type": "integer"
},
"prequeue_start_time": {
"description": "An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`.",
"example": "2021-09-28T15:00:00.000Z",
"nullable": true,
"type": "string"
},
"queueing_method": {
"description": "If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it.",
"example": "random",
"nullable": true,
"type": "string"
},
"session_duration": {
"description": "If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it.",
"maximum": 30,
"minimum": 1,
"nullable": true,
"type": "integer"
},
"shuffle_at_event_start": {
"default": false,
"description": "If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueing_method` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary.",
"type": "boolean"
},
"suspended": {
"default": false,
"description": "Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration.",
"type": "boolean"
},
"total_active_users": {
"description": "If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` property is also set.",
"maximum": 2147483647,
"minimum": 200,
"nullable": true,
"type": "integer"
}
},
"type": "object"
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Event details response failure"
}
}[
{
"api_token": []
},
{
"api_email": [],
"api_key": []
}
]