--- title: Events --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Waiting Rooms](https://developers.cloudflare.com/api/resources/waiting_rooms) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Events ##### [List events](https://developers.cloudflare.com/api/resources/waiting_rooms/subresources/events/methods/list) GET/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events ##### [Event details](https://developers.cloudflare.com/api/resources/waiting_rooms/subresources/events/methods/get) GET/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events/{event\_id} ##### [Create event](https://developers.cloudflare.com/api/resources/waiting_rooms/subresources/events/methods/create) POST/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events ##### [Update event](https://developers.cloudflare.com/api/resources/waiting_rooms/subresources/events/methods/update) PUT/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events/{event\_id} ##### [Patch event](https://developers.cloudflare.com/api/resources/waiting_rooms/subresources/events/methods/edit) PATCH/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events/{event\_id} ##### [Delete event](https://developers.cloudflare.com/api/resources/waiting_rooms/subresources/events/methods/delete) DELETE/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events/{event\_id} ##### ModelsExpand Collapse

Event object {id, created\_on, custom\_page\_html, 15 more }

id: optional string Link to this property created\_on: optional string formatdate-time Link to this property custom\_page\_html: optional string 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. Link to this property description: optional string A note that you can use to add more details about the event. Link to this property disable\_session\_renewal: optional boolean 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. Link to this property event\_end\_time: optional string An ISO 8601 timestamp that marks the end of the event. Link to this property event\_start\_time: optional 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. Link to this property modified\_on: optional string formatdate-time Link to this property name: optional string A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. Link to this property new\_users\_per\_minute: optional number 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. maximum2147483647 minimum200 Link to this property prequeue\_start\_time: optional 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. Link to this property queueing\_method: optional string If set, the event will override the waiting room’s queueing_method property while it is active. If null, the event will inherit it. Link to this property session\_duration: optional number If set, the event will override the waiting room’s session_duration property while it is active. If null, the event will inherit it. maximum30 minimum1 Link to this property shuffle\_at\_event\_start: optional 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. Link to this property suspended: optional 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. Link to this property total\_active\_users: optional number 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. maximum2147483647 minimum200 Link to this property

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.

One of the following: "log" Link to this property "infinite\_queue" Link to this property

Link to this property

turnstile\_mode: optional "off"or "invisible"or "visible\_non\_interactive"or "visible\_managed" If set, the event will override the waiting room’s turnstile_mode property while it is active. If null, the event will inherit it.

One of the following: "off" Link to this property "invisible" Link to this property "visible\_non\_interactive" Link to this property "visible\_managed" Link to this property

Link to this property

[Link to this property](<#(resource)%20waiting_rooms.events%20%3E%20(model)%20event%20%3E%20(schema)>)

EventDeleteResponse object {id }

id: optional string Link to this property

[Link to this property](<#(resource)%20waiting_rooms.events%20%3E%20(model)%20event_delete_response%20%3E%20(schema)>) #### EventsDetails ##### [Preview active event details](https://developers.cloudflare.com/api/resources/waiting_rooms/subresources/events/subresources/details/methods/get) GET/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events/{event\_id}/details ##### ModelsExpand Collapse

EventQuery object {event\_end\_time, event\_start\_time, name, 12 more }

event\_end\_time: string An ISO 8601 timestamp that marks the end of the event. Link to this property 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. Link to this property name: string A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. Link to this property custom\_page\_html: optional string 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. Link to this property description: optional string A note that you can use to add more details about the event. Link to this property disable\_session\_renewal: optional boolean 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. Link to this property new\_users\_per\_minute: optional number 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. maximum2147483647 minimum200 Link to this property prequeue\_start\_time: optional 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. Link to this property queueing\_method: optional string If set, the event will override the waiting room’s queueing_method property while it is active. If null, the event will inherit it. Link to this property session\_duration: optional number If set, the event will override the waiting room’s session_duration property while it is active. If null, the event will inherit it. maximum30 minimum1 Link to this property shuffle\_at\_event\_start: optional 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. Link to this property suspended: optional 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. Link to this property total\_active\_users: optional number 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. maximum2147483647 minimum200 Link to this property

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.

One of the following: "log" Link to this property "infinite\_queue" Link to this property

Link to this property

One of the following: "off" Link to this property "invisible" Link to this property "visible\_non\_interactive" Link to this property "visible\_managed" Link to this property

Link to this property

[Link to this property](<#(resource)%20waiting_rooms.events.details%20%3E%20(model)%20event_query%20%3E%20(schema)>)

DetailGetResponse object {id, created\_on, custom\_page\_html, 13 more }

id: optional string Link to this property created\_on: optional string formatdate-time Link to this property custom\_page\_html: optional string Link to this property description: optional string A note that you can use to add more details about the event. Link to this property disable\_session\_renewal: optional boolean Link to this property event\_end\_time: optional string An ISO 8601 timestamp that marks the end of the event. Link to this property event\_start\_time: optional 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. Link to this property modified\_on: optional string formatdate-time Link to this property name: optional string A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. Link to this property new\_users\_per\_minute: optional number Link to this property prequeue\_start\_time: optional 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. Link to this property queueing\_method: optional string Link to this property session\_duration: optional number Link to this property shuffle\_at\_event\_start: optional 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. Link to this property suspended: optional 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. Link to this property total\_active\_users: optional number Link to this property

[Link to this property](<#(resource)%20waiting_rooms.events.details%20%3E%20(model)%20detail_get_response%20%3E%20(schema)>)