# Events

## List events

`waiting_rooms.events.list(strwaiting_room_id, EventListParams**kwargs)  -> SyncV4PagePaginationArray[Event]`

**get** `/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events`

Lists events for a waiting room.

### Parameters

- `zone_id: str`

  Identifier.

- `waiting_room_id: str`

- `page: Optional[float]`

  Page number of paginated results.

- `per_page: Optional[float]`

  Maximum number of results per page. Must be a multiple of 5.

### Returns

- `class Event: …`

  - `id: Optional[str]`

  - `created_on: Optional[datetime]`

  - `custom_page_html: Optional[str]`

    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: Optional[str]`

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

  - `disable_session_renewal: Optional[bool]`

    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.

  - `event_end_time: Optional[str]`

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

  - `event_start_time: Optional[str]`

    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`.

  - `modified_on: Optional[datetime]`

  - `name: Optional[str]`

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

  - `new_users_per_minute: Optional[int]`

    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.

  - `prequeue_start_time: Optional[str]`

    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`.

  - `queueing_method: Optional[str]`

    If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it.

  - `session_duration: Optional[int]`

    If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it.

  - `shuffle_at_event_start: Optional[bool]`

    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: Optional[bool]`

    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: Optional[int]`

    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[Literal["log", "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.

    - `"log"`

    - `"infinite_queue"`

  - `turnstile_mode: Optional[Literal["off", "invisible", "visible_non_interactive", "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.

    - `"off"`

    - `"invisible"`

    - `"visible_non_interactive"`

    - `"visible_managed"`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.waiting_rooms.events.list(
    waiting_room_id="699d98642c564d2e855e9661899b7252",
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "25756b2dfe6e378a06b033b670413757",
      "created_on": "2014-01-01T05:20:00.12345Z",
      "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
      "description": "Production event - DO NOT MODIFY",
      "disable_session_renewal": true,
      "event_end_time": "2021-09-28T17:00:00.000Z",
      "event_start_time": "2021-09-28T15:30:00.000Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "name": "production_webinar_event",
      "new_users_per_minute": 200,
      "prequeue_start_time": "2021-09-28T15:00:00.000Z",
      "queueing_method": "random",
      "session_duration": 1,
      "shuffle_at_event_start": true,
      "suspended": true,
      "total_active_users": 200,
      "turnstile_action": "log",
      "turnstile_mode": "off"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}
```

## Event details

`waiting_rooms.events.get(strevent_id, EventGetParams**kwargs)  -> Event`

**get** `/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}`

Fetches a single configured event for a waiting room.

### Parameters

- `zone_id: str`

  Identifier.

- `waiting_room_id: str`

- `event_id: str`

### Returns

- `class Event: …`

  - `id: Optional[str]`

  - `created_on: Optional[datetime]`

  - `custom_page_html: Optional[str]`

    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: Optional[str]`

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

  - `disable_session_renewal: Optional[bool]`

    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.

  - `event_end_time: Optional[str]`

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

  - `event_start_time: Optional[str]`

    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`.

  - `modified_on: Optional[datetime]`

  - `name: Optional[str]`

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

  - `new_users_per_minute: Optional[int]`

    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.

  - `prequeue_start_time: Optional[str]`

    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`.

  - `queueing_method: Optional[str]`

    If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it.

  - `session_duration: Optional[int]`

    If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it.

  - `shuffle_at_event_start: Optional[bool]`

    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: Optional[bool]`

    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: Optional[int]`

    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[Literal["log", "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.

    - `"log"`

    - `"infinite_queue"`

  - `turnstile_mode: Optional[Literal["off", "invisible", "visible_non_interactive", "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.

    - `"off"`

    - `"invisible"`

    - `"visible_non_interactive"`

    - `"visible_managed"`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
event = client.waiting_rooms.events.get(
    event_id="25756b2dfe6e378a06b033b670413757",
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    waiting_room_id="699d98642c564d2e855e9661899b7252",
)
print(event.id)
```

#### Response

```json
{
  "result": {
    "id": "25756b2dfe6e378a06b033b670413757",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
    "description": "Production event - DO NOT MODIFY",
    "disable_session_renewal": true,
    "event_end_time": "2021-09-28T17:00:00.000Z",
    "event_start_time": "2021-09-28T15:30:00.000Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "production_webinar_event",
    "new_users_per_minute": 200,
    "prequeue_start_time": "2021-09-28T15:00:00.000Z",
    "queueing_method": "random",
    "session_duration": 1,
    "shuffle_at_event_start": true,
    "suspended": true,
    "total_active_users": 200,
    "turnstile_action": "log",
    "turnstile_mode": "off"
  }
}
```

## Create event

`waiting_rooms.events.create(strwaiting_room_id, EventCreateParams**kwargs)  -> Event`

**post** `/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events`

Only available for the Waiting Room Advanced subscription. Creates an event for a waiting room. An event takes place during a specified period of time, temporarily changing the behavior of a waiting room. While the event is active, some of the properties in the event's configuration may either override or inherit from the waiting room's configuration. Note that events cannot overlap with each other, so only one event can be active at a time.

### Parameters

- `zone_id: str`

  Identifier.

- `waiting_room_id: str`

- `event_end_time: str`

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

- `event_start_time: str`

  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: str`

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

- `custom_page_html: Optional[str]`

  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: Optional[str]`

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

- `disable_session_renewal: Optional[bool]`

  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.

- `new_users_per_minute: Optional[int]`

  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.

- `prequeue_start_time: Optional[str]`

  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`.

- `queueing_method: Optional[str]`

  If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it.

- `session_duration: Optional[int]`

  If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it.

- `shuffle_at_event_start: Optional[bool]`

  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: Optional[bool]`

  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: Optional[int]`

  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[Literal["log", "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.

  - `"log"`

  - `"infinite_queue"`

- `turnstile_mode: Optional[Literal["off", "invisible", "visible_non_interactive", "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.

  - `"off"`

  - `"invisible"`

  - `"visible_non_interactive"`

  - `"visible_managed"`

### Returns

- `class Event: …`

  - `id: Optional[str]`

  - `created_on: Optional[datetime]`

  - `custom_page_html: Optional[str]`

    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: Optional[str]`

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

  - `disable_session_renewal: Optional[bool]`

    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.

  - `event_end_time: Optional[str]`

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

  - `event_start_time: Optional[str]`

    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`.

  - `modified_on: Optional[datetime]`

  - `name: Optional[str]`

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

  - `new_users_per_minute: Optional[int]`

    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.

  - `prequeue_start_time: Optional[str]`

    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`.

  - `queueing_method: Optional[str]`

    If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it.

  - `session_duration: Optional[int]`

    If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it.

  - `shuffle_at_event_start: Optional[bool]`

    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: Optional[bool]`

    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: Optional[int]`

    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[Literal["log", "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.

    - `"log"`

    - `"infinite_queue"`

  - `turnstile_mode: Optional[Literal["off", "invisible", "visible_non_interactive", "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.

    - `"off"`

    - `"invisible"`

    - `"visible_non_interactive"`

    - `"visible_managed"`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
event = client.waiting_rooms.events.create(
    waiting_room_id="699d98642c564d2e855e9661899b7252",
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    event_end_time="2021-09-28T17:00:00.000Z",
    event_start_time="2021-09-28T15:30:00.000Z",
    name="production_webinar_event",
)
print(event.id)
```

#### Response

```json
{
  "result": {
    "id": "25756b2dfe6e378a06b033b670413757",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
    "description": "Production event - DO NOT MODIFY",
    "disable_session_renewal": true,
    "event_end_time": "2021-09-28T17:00:00.000Z",
    "event_start_time": "2021-09-28T15:30:00.000Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "production_webinar_event",
    "new_users_per_minute": 200,
    "prequeue_start_time": "2021-09-28T15:00:00.000Z",
    "queueing_method": "random",
    "session_duration": 1,
    "shuffle_at_event_start": true,
    "suspended": true,
    "total_active_users": 200,
    "turnstile_action": "log",
    "turnstile_mode": "off"
  }
}
```

## Update event

`waiting_rooms.events.update(strevent_id, EventUpdateParams**kwargs)  -> Event`

**put** `/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}`

Updates a configured event for a waiting room.

### Parameters

- `zone_id: str`

  Identifier.

- `waiting_room_id: str`

- `event_id: str`

- `event_end_time: str`

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

- `event_start_time: str`

  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: str`

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

- `custom_page_html: Optional[str]`

  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: Optional[str]`

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

- `disable_session_renewal: Optional[bool]`

  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.

- `new_users_per_minute: Optional[int]`

  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.

- `prequeue_start_time: Optional[str]`

  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`.

- `queueing_method: Optional[str]`

  If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it.

- `session_duration: Optional[int]`

  If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it.

- `shuffle_at_event_start: Optional[bool]`

  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: Optional[bool]`

  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: Optional[int]`

  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[Literal["log", "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.

  - `"log"`

  - `"infinite_queue"`

- `turnstile_mode: Optional[Literal["off", "invisible", "visible_non_interactive", "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.

  - `"off"`

  - `"invisible"`

  - `"visible_non_interactive"`

  - `"visible_managed"`

### Returns

- `class Event: …`

  - `id: Optional[str]`

  - `created_on: Optional[datetime]`

  - `custom_page_html: Optional[str]`

    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: Optional[str]`

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

  - `disable_session_renewal: Optional[bool]`

    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.

  - `event_end_time: Optional[str]`

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

  - `event_start_time: Optional[str]`

    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`.

  - `modified_on: Optional[datetime]`

  - `name: Optional[str]`

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

  - `new_users_per_minute: Optional[int]`

    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.

  - `prequeue_start_time: Optional[str]`

    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`.

  - `queueing_method: Optional[str]`

    If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it.

  - `session_duration: Optional[int]`

    If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it.

  - `shuffle_at_event_start: Optional[bool]`

    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: Optional[bool]`

    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: Optional[int]`

    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[Literal["log", "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.

    - `"log"`

    - `"infinite_queue"`

  - `turnstile_mode: Optional[Literal["off", "invisible", "visible_non_interactive", "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.

    - `"off"`

    - `"invisible"`

    - `"visible_non_interactive"`

    - `"visible_managed"`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
event = client.waiting_rooms.events.update(
    event_id="25756b2dfe6e378a06b033b670413757",
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    waiting_room_id="699d98642c564d2e855e9661899b7252",
    event_end_time="2021-09-28T17:00:00.000Z",
    event_start_time="2021-09-28T15:30:00.000Z",
    name="production_webinar_event",
)
print(event.id)
```

#### Response

```json
{
  "result": {
    "id": "25756b2dfe6e378a06b033b670413757",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
    "description": "Production event - DO NOT MODIFY",
    "disable_session_renewal": true,
    "event_end_time": "2021-09-28T17:00:00.000Z",
    "event_start_time": "2021-09-28T15:30:00.000Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "production_webinar_event",
    "new_users_per_minute": 200,
    "prequeue_start_time": "2021-09-28T15:00:00.000Z",
    "queueing_method": "random",
    "session_duration": 1,
    "shuffle_at_event_start": true,
    "suspended": true,
    "total_active_users": 200,
    "turnstile_action": "log",
    "turnstile_mode": "off"
  }
}
```

## Patch event

`waiting_rooms.events.edit(strevent_id, EventEditParams**kwargs)  -> Event`

**patch** `/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}`

Patches a configured event for a waiting room.

### Parameters

- `zone_id: str`

  Identifier.

- `waiting_room_id: str`

- `event_id: str`

- `event_end_time: str`

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

- `event_start_time: str`

  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: str`

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

- `custom_page_html: Optional[str]`

  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: Optional[str]`

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

- `disable_session_renewal: Optional[bool]`

  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.

- `new_users_per_minute: Optional[int]`

  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.

- `prequeue_start_time: Optional[str]`

  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`.

- `queueing_method: Optional[str]`

  If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it.

- `session_duration: Optional[int]`

  If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it.

- `shuffle_at_event_start: Optional[bool]`

  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: Optional[bool]`

  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: Optional[int]`

  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[Literal["log", "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.

  - `"log"`

  - `"infinite_queue"`

- `turnstile_mode: Optional[Literal["off", "invisible", "visible_non_interactive", "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.

  - `"off"`

  - `"invisible"`

  - `"visible_non_interactive"`

  - `"visible_managed"`

### Returns

- `class Event: …`

  - `id: Optional[str]`

  - `created_on: Optional[datetime]`

  - `custom_page_html: Optional[str]`

    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: Optional[str]`

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

  - `disable_session_renewal: Optional[bool]`

    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.

  - `event_end_time: Optional[str]`

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

  - `event_start_time: Optional[str]`

    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`.

  - `modified_on: Optional[datetime]`

  - `name: Optional[str]`

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

  - `new_users_per_minute: Optional[int]`

    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.

  - `prequeue_start_time: Optional[str]`

    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`.

  - `queueing_method: Optional[str]`

    If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it.

  - `session_duration: Optional[int]`

    If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it.

  - `shuffle_at_event_start: Optional[bool]`

    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: Optional[bool]`

    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: Optional[int]`

    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[Literal["log", "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.

    - `"log"`

    - `"infinite_queue"`

  - `turnstile_mode: Optional[Literal["off", "invisible", "visible_non_interactive", "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.

    - `"off"`

    - `"invisible"`

    - `"visible_non_interactive"`

    - `"visible_managed"`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
event = client.waiting_rooms.events.edit(
    event_id="25756b2dfe6e378a06b033b670413757",
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    waiting_room_id="699d98642c564d2e855e9661899b7252",
    event_end_time="2021-09-28T17:00:00.000Z",
    event_start_time="2021-09-28T15:30:00.000Z",
    name="production_webinar_event",
)
print(event.id)
```

#### Response

```json
{
  "result": {
    "id": "25756b2dfe6e378a06b033b670413757",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
    "description": "Production event - DO NOT MODIFY",
    "disable_session_renewal": true,
    "event_end_time": "2021-09-28T17:00:00.000Z",
    "event_start_time": "2021-09-28T15:30:00.000Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "production_webinar_event",
    "new_users_per_minute": 200,
    "prequeue_start_time": "2021-09-28T15:00:00.000Z",
    "queueing_method": "random",
    "session_duration": 1,
    "shuffle_at_event_start": true,
    "suspended": true,
    "total_active_users": 200,
    "turnstile_action": "log",
    "turnstile_mode": "off"
  }
}
```

## Delete event

`waiting_rooms.events.delete(strevent_id, EventDeleteParams**kwargs)  -> EventDeleteResponse`

**delete** `/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}`

Deletes an event for a waiting room.

### Parameters

- `zone_id: str`

  Identifier.

- `waiting_room_id: str`

- `event_id: str`

### Returns

- `class EventDeleteResponse: …`

  - `id: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
event = client.waiting_rooms.events.delete(
    event_id="25756b2dfe6e378a06b033b670413757",
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    waiting_room_id="699d98642c564d2e855e9661899b7252",
)
print(event.id)
```

#### Response

```json
{
  "result": {
    "id": "25756b2dfe6e378a06b033b670413757"
  }
}
```

## Domain Types

### Event

- `class Event: …`

  - `id: Optional[str]`

  - `created_on: Optional[datetime]`

  - `custom_page_html: Optional[str]`

    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: Optional[str]`

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

  - `disable_session_renewal: Optional[bool]`

    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.

  - `event_end_time: Optional[str]`

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

  - `event_start_time: Optional[str]`

    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`.

  - `modified_on: Optional[datetime]`

  - `name: Optional[str]`

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

  - `new_users_per_minute: Optional[int]`

    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.

  - `prequeue_start_time: Optional[str]`

    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`.

  - `queueing_method: Optional[str]`

    If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it.

  - `session_duration: Optional[int]`

    If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it.

  - `shuffle_at_event_start: Optional[bool]`

    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: Optional[bool]`

    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: Optional[int]`

    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[Literal["log", "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.

    - `"log"`

    - `"infinite_queue"`

  - `turnstile_mode: Optional[Literal["off", "invisible", "visible_non_interactive", "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.

    - `"off"`

    - `"invisible"`

    - `"visible_non_interactive"`

    - `"visible_managed"`

### Event Delete Response

- `class EventDeleteResponse: …`

  - `id: Optional[str]`

# Details

## Preview active event details

`waiting_rooms.events.details.get(strevent_id, DetailGetParams**kwargs)  -> DetailGetResponse`

**get** `/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}/details`

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

### Parameters

- `zone_id: str`

  Identifier.

- `waiting_room_id: str`

- `event_id: str`

### Returns

- `class DetailGetResponse: …`

  - `id: Optional[str]`

  - `created_on: Optional[datetime]`

  - `custom_page_html: Optional[str]`

  - `description: Optional[str]`

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

  - `disable_session_renewal: Optional[bool]`

  - `event_end_time: Optional[str]`

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

  - `event_start_time: Optional[str]`

    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`.

  - `modified_on: Optional[datetime]`

  - `name: Optional[str]`

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

  - `new_users_per_minute: Optional[int]`

  - `prequeue_start_time: Optional[str]`

    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`.

  - `queueing_method: Optional[str]`

  - `session_duration: Optional[int]`

  - `shuffle_at_event_start: Optional[bool]`

    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: Optional[bool]`

    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: Optional[int]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
detail = client.waiting_rooms.events.details.get(
    event_id="25756b2dfe6e378a06b033b670413757",
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    waiting_room_id="699d98642c564d2e855e9661899b7252",
)
print(detail.id)
```

#### Response

```json
{
  "result": {
    "id": "25756b2dfe6e378a06b033b670413757",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
    "description": "Production event - DO NOT MODIFY",
    "disable_session_renewal": false,
    "event_end_time": "2021-09-28T17:00:00.000Z",
    "event_start_time": "2021-09-28T15:30:00.000Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "production_webinar_event",
    "new_users_per_minute": 0,
    "prequeue_start_time": "2021-09-28T15:00:00.000Z",
    "queueing_method": "random",
    "session_duration": 0,
    "shuffle_at_event_start": true,
    "suspended": true,
    "total_active_users": 0
  }
}
```

## Domain Types

### Event Query

- `class EventQuery: …`

  - `event_end_time: str`

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

  - `event_start_time: str`

    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: str`

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

  - `custom_page_html: Optional[str]`

    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: Optional[str]`

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

  - `disable_session_renewal: Optional[bool]`

    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.

  - `new_users_per_minute: Optional[int]`

    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.

  - `prequeue_start_time: Optional[str]`

    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`.

  - `queueing_method: Optional[str]`

    If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it.

  - `session_duration: Optional[int]`

    If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it.

  - `shuffle_at_event_start: Optional[bool]`

    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: Optional[bool]`

    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: Optional[int]`

    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[Literal["log", "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.

    - `"log"`

    - `"infinite_queue"`

  - `turnstile_mode: Optional[Literal["off", "invisible", "visible_non_interactive", "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.

    - `"off"`

    - `"invisible"`

    - `"visible_non_interactive"`

    - `"visible_managed"`

### Detail Get Response

- `class DetailGetResponse: …`

  - `id: Optional[str]`

  - `created_on: Optional[datetime]`

  - `custom_page_html: Optional[str]`

  - `description: Optional[str]`

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

  - `disable_session_renewal: Optional[bool]`

  - `event_end_time: Optional[str]`

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

  - `event_start_time: Optional[str]`

    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`.

  - `modified_on: Optional[datetime]`

  - `name: Optional[str]`

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

  - `new_users_per_minute: Optional[int]`

  - `prequeue_start_time: Optional[str]`

    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`.

  - `queueing_method: Optional[str]`

  - `session_duration: Optional[int]`

  - `shuffle_at_event_start: Optional[bool]`

    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: Optional[bool]`

    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: Optional[int]`