Create a custom waiting room page preview

POST

https://api.cloudflare.com/client/v4/zones/{zone_identifier}/waiting_rooms/preview

Last modified:2022-12-16 13:48:35

Creates a waiting room page preview. Upload a custom waiting room page for preview. You will receive a preview URL in the form http://waitingrooms.dev/preview/<uuid>. You can use the following query parameters to change the state of the preview:

force_queue: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website (also known as queueAll).

queue_is_full: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.

queueing_method: The queueing method currently used by the waiting room.

fifo indicates a FIFO queue.

random indicates a Random queue.

passthrough indicates a Passthrough queue. Keep in mind that the waiting room page will only be displayed if force_queue=true or event=prequeueing — for other cases the request will pass through to the origin. For our preview, this will be a fake origin website returning "Welcome".

reject indicates a Reject queue.

event: Used to preview a waiting room event.

none indicates no event is occurring.

prequeueing indicates that an event is prequeueing (between prequeue_start_time and event_start_time).

started indicates that an event has started (between event_start_time and event_end_time).

shuffle_at_event_start: Boolean indicating if the event will shuffle users in the prequeue when it starts. This can only be set to true if an event is active (event is not none).

For example, you can make a request to

http://waitingrooms.dev/preview/<uuid>?force_queue=false&queue_is_full=false&queueing_method=random&event=started&shuffle_at_event_start=true

6. waitTime: Non-zero, positive integer indicating the estimated wait time in minutes. The default value is 10 minutes.

For example, you can make a request to http://waitingrooms.dev/preview/<uuid>?waitTime=50 to configure the estimated wait time as 50 minutes.

Request

Path Params

zone_identifier

string

required

Body Params application/json

custom_html

string

required

Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge:

{{waitTimeKnown}} Acts like a boolean value that indicates the behavior to take when wait time is not available, for instance when queue_all is true.

{{waitTimeFormatted}} Estimated wait time for the user. For example, five minutes. Alternatively, you can use:

{{waitTime}} Number of minutes of estimated wait for a user.

{{waitTimeHours}} Number of hours of estimated wait for a user (Math.floor(waitTime/60)).

{{waitTimeHourMinutes}} Number of minutes above the waitTimeHours value (waitTime%60).

{{queueIsFull}} Changes to true when no more people can be added to the queue.

To view the full list of variables, look at the cfWaitingRoom object described under the json_response_enabled property in other Waiting Room API calls.

Default:

Example:

{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}

Example

{
    "custom_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cloudflare.com/client/v4/zones//waiting_rooms/preview' \
--header 'Content-Type: application/json' \
--data-raw '{
    "custom_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}"
}'

Responses

🟢200Create a custom waiting room page preview response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "preview_url": "http://waitingrooms.dev/preview/35af8c12-6d68-4608-babb-b53435a5ddfb"
    },
    "success": true
}

🟢200Create a custom waiting room page preview response failure

Modified at 2022-12-16 13:48:35

Create waiting room

Delete waiting room