API Reference

Waiting Rooms

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Events

List events

client.WaitingRooms.Events.List(ctx, waitingRoomID, params) (*V4PagePaginationArray[Event], error)

GET/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events

Event details

client.WaitingRooms.Events.Get(ctx, waitingRoomID, eventID, query) (*Event, error)

GET/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}

Create event

client.WaitingRooms.Events.New(ctx, waitingRoomID, params) (*Event, error)

POST/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events

Update event

client.WaitingRooms.Events.Update(ctx, waitingRoomID, eventID, params) (*Event, error)

PUT/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}

Patch event

client.WaitingRooms.Events.Edit(ctx, waitingRoomID, eventID, params) (*Event, error)

PATCH/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}

Delete event

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

CreatedOn Timeoptional

formatdate-time

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.

Description stringoptional

A note that you can use to add more details about the event.

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.

EventEndTime stringoptional

An ISO 8601 timestamp that marks the end of the event.

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.

ModifiedOn Timeoptional

formatdate-time

Name stringoptional

A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.

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

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.

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.

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

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.

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.

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

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"

const EventTurnstileActionInfiniteQueue EventTurnstileAction = "infinite_queue"

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"

const EventTurnstileModeInvisible EventTurnstileMode = "invisible"

const EventTurnstileModeVisibleNonInteractive EventTurnstileMode = "visible_non_interactive"

const EventTurnstileModeVisibleManaged EventTurnstileMode = "visible_managed"

EventsDetails

Preview active event details

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.

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.

Name string

A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.

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.

Description stringoptional

A note that you can use to add more details about the event.

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.

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

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.

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.

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

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.

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.

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

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"

const EventQueryTurnstileActionInfiniteQueue EventQueryTurnstileAction = "infinite_queue"

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"

const EventQueryTurnstileModeInvisible EventQueryTurnstileMode = "invisible"

const EventQueryTurnstileModeVisibleNonInteractive EventQueryTurnstileMode = "visible_non_interactive"

const EventQueryTurnstileModeVisibleManaged EventQueryTurnstileMode = "visible_managed"