details

Creates, updates, deletes, gets or lists a details resource.

Overview

Name	details
Type	Resource
Id	cloudflare.waiting_rooms.details

Fields

The following fields are returned by SELECT queries:

list

Preview active event details response

Name	Datatype	Description
id	string	(example: 25756b2dfe6e378a06b033b670413757)
name	string	A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. (example: production_webinar_event)
created_on	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
custom_page_html	string	(example: {{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}})
description	string	A note that you can use to add more details about the event. (default: , example: Production event - DO NOT MODIFY)
disable_session_renewal	boolean
event_end_time	string	An ISO 8601 timestamp that marks the end of the event. (example: 2021-09-28T17:00:00.000Z)
event_start_time	string	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)
modified_on	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
new_users_per_minute	integer
prequeue_start_time	string	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)
queueing_method	string	(example: random)
session_duration	integer
shuffle_at_event_start	boolean	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.
suspended	boolean	Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.
total_active_users	integer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	event_id, waiting_room_id, zone_id		Previews an event's configuration as if it was active. Inherited fields from the waiting room will be displayed with their current values.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
event_id	string	The event ID.
waiting_room_id	string	The Waiting Room ID.
zone_id	string	The Cloudflare zone ID.

SELECT examples

list

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

SELECT
id,
name,
created_on,
custom_page_html,
description,
disable_session_renewal,
event_end_time,
event_start_time,
modified_on,
new_users_per_minute,
prequeue_start_time,
queueing_method,
session_duration,
shuffle_at_event_start,
suspended,
total_active_users
FROM cloudflare.waiting_rooms.details
WHERE event_id = '{{ event_id }}' -- required
AND waiting_room_id = '{{ waiting_room_id }}' -- required
AND zone_id = '{{ zone_id }}' -- required
;