--- title: Events --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Waiting Rooms](https://developers.cloudflare.com/api/go/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/go/resources/waiting_rooms/subresources/events/methods/list) client.WaitingRooms.Events.List(ctx, waitingRoomID, params) (\*V4PagePaginationArray\[[Event]()], error) GET/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events ##### [Event details](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/events/methods/get) client.WaitingRooms.Events.Get(ctx, waitingRoomID, eventID, query) (\*[Event](), error) GET/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events/{event\_id} ##### [Create event](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/events/methods/create) client.WaitingRooms.Events.New(ctx, waitingRoomID, params) (\*[Event](), error) POST/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events ##### [Update event](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/events/methods/update) client.WaitingRooms.Events.Update(ctx, waitingRoomID, eventID, params) (\*[Event](), error) PUT/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events/{event\_id} ##### [Patch event](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/events/methods/edit) client.WaitingRooms.Events.Edit(ctx, waitingRoomID, eventID, params) (\*[Event](), error) PATCH/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events/{event\_id} ##### [Delete event](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/events/methods/delete) client.WaitingRooms.Events.Delete(ctx, waitingRoomID, eventID, body) (\*[EventDeleteResponse](), error) DELETE/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events/{event\_id} ##### ModelsExpand Collapse
type Event struct{…} ID stringOptional Link to this property CreatedOn TimeOptional formatdate-time Link to this property CustomPageHTML stringOptional 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 stringOptional A note that you can use to add more details about the event. Link to this property DisableSessionRenewal boolOptional 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 EventEndTime stringOptional An ISO 8601 timestamp that marks the end of the event. Link to this property EventStartTime stringOptional 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 ModifiedOn TimeOptional formatdate-time Link to this property Name stringOptional A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. Link to this property NewUsersPerMinute int64Optional 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 PrequeueStartTime stringOptional 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 QueueingMethod stringOptional 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 SessionDuration int64Optional 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 ShuffleAtEventStart boolOptional 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 boolOptional 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 TotalActiveUsers int64Optional 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
TurnstileAction EventTurnstileActionOptional 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: const EventTurnstileActionLog EventTurnstileAction = "log" Link to this property const EventTurnstileActionInfiniteQueue EventTurnstileAction = "infinite\_queue" Link to this property
Link to this property
TurnstileMode EventTurnstileModeOptional 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: const EventTurnstileModeOff EventTurnstileMode = "off" Link to this property const EventTurnstileModeInvisible EventTurnstileMode = "invisible" Link to this property const EventTurnstileModeVisibleNonInteractive EventTurnstileMode = "visible\_non\_interactive" Link to this property const EventTurnstileModeVisibleManaged EventTurnstileMode = "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)>) #### EventsDetails ##### [Preview active event details](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/events/subresources/details/methods/get) client.WaitingRooms.Events.Details.Get(ctx, waitingRoomID, eventID, query) (\*[EventDetailGetResponse](), error) GET/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events/{event\_id}/details ##### ModelsExpand Collapse
type EventQuery struct{…} EventEndTime string An ISO 8601 timestamp that marks the end of the event. Link to this property EventStartTime 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 CustomPageHTML stringOptional 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 stringOptional A note that you can use to add more details about the event. Link to this property DisableSessionRenewal boolOptional 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 NewUsersPerMinute int64Optional 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 PrequeueStartTime stringOptional 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 QueueingMethod stringOptional 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 SessionDuration int64Optional 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 ShuffleAtEventStart boolOptional 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 boolOptional 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 TotalActiveUsers int64Optional 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
TurnstileAction EventQueryTurnstileActionOptional 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: const EventQueryTurnstileActionLog EventQueryTurnstileAction = "log" Link to this property const EventQueryTurnstileActionInfiniteQueue EventQueryTurnstileAction = "infinite\_queue" Link to this property
Link to this property
TurnstileMode EventQueryTurnstileModeOptional 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: const EventQueryTurnstileModeOff EventQueryTurnstileMode = "off" Link to this property const EventQueryTurnstileModeInvisible EventQueryTurnstileMode = "invisible" Link to this property const EventQueryTurnstileModeVisibleNonInteractive EventQueryTurnstileMode = "visible\_non\_interactive" Link to this property const EventQueryTurnstileModeVisibleManaged EventQueryTurnstileMode = "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)>)