## Create 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.

### Path Parameters

- `zone_id: string`

  Identifier.

- `waiting_room_id: string`

### Body Parameters

- `event_end_time: string`

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

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

- `name: string`

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

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

- `description: optional string`

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

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

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

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

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

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

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

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

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

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

  - `"log"`

  - `"infinite_queue"`

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

  - `"off"`

  - `"invisible"`

  - `"visible_non_interactive"`

  - `"visible_managed"`

### Returns

- `result: Event`

  - `id: optional string`

  - `created_on: optional string`

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

  - `description: optional string`

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

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

  - `event_end_time: optional string`

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

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

  - `modified_on: optional string`

  - `name: optional string`

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

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

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

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

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

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

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

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

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

    - `"log"`

    - `"infinite_queue"`

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

    - `"off"`

    - `"invisible"`

    - `"visible_non_interactive"`

    - `"visible_managed"`

### Example

```http
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/waiting_rooms/$WAITING_ROOM_ID/events \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "event_end_time": "2021-09-28T17:00:00.000Z",
          "event_start_time": "2021-09-28T15:30:00.000Z",
          "name": "production_webinar_event",
          "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
          "description": "Production event - DO NOT MODIFY",
          "prequeue_start_time": "2021-09-28T15:00:00.000Z",
          "queueing_method": "random"
        }'
```

#### 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"
  }
}
```