Events
List events
Event details
Create event
Update event
Patch event
Delete event
ModelsExpand Collapse
Event = object { id, created_on, custom_page_html, 15 more }
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.
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.
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.
A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
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.
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.
If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.
If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.
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.
Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.
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.
turnstile_action: optional "log" or "infinite_queue"If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it.
If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it.
EventsDetails
Preview active event details
ModelsExpand Collapse
EventQuery = object { event_end_time, event_start_time, name, 12 more }
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.
A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
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.
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.
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.
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.
If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.
If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.
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.
Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.
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.
turnstile_action: optional "log" or "infinite_queue"If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it.
If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it.
DetailGetResponse = object { id, created_on, custom_page_html, 13 more }
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.
A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
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.
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.