Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions src/content/docs/waiting-room/how-to/create-waiting-room.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,12 @@ For additional context on creating a waiting room, refer to [Get started](/waiti
2. Select **Create**.
3. Customize the [settings](/waiting-room/reference/configuration-settings/) for your waiting room. For additional guidance refer to [Best practices](/waiting-room/reference/best-practices/).
4. Select **Next**.
5. If you wish to [customize your waiting room](/waiting-room/how-to/customize-waiting-room/), update the HTML and CSS as needed. If you are using this waiting room to manage traffic for your mobile app or API, enable the JSON response toggle. Make sure that you have set up a [JSON friendly response](/waiting-room/how-to/json-response/) for your client (mobile or web app).
6. Select the **Queuing status code** to determine the HTTP status code that is returned when a user is in the waiting room.
7. Select **Next**.
8. Review your settings before saving. If you customized your waiting room, make sure to [preview the result](/waiting-room/how-to/customize-waiting-room/#preview-waiting-room).
9. Select **Save**. Your new waiting room will be enabled by default.
5. In this section, you can choose whether to enable [Turnstile](/turnstile/) for your waiting room. If you select **Yes**, you will need to choose your [Widget mode](/turnstile/concepts/widget/) and define the action to take if a turnstile challenge fails. The available Widget modes and actions depend on your plan type. Refer to the [Plans](/waiting-room/plans/) for more details.
6. If you wish to [customize your waiting room](/waiting-room/how-to/customize-waiting-room/), update the HTML and CSS as needed. If you are using this waiting room to manage traffic for your mobile app or API, enable the JSON response toggle. Make sure that you have set up a [JSON friendly response](/waiting-room/how-to/json-response/) for your client (mobile or web app).
7. Select the **Queuing status code** to determine the HTTP status code that is returned when a user is in the waiting room.
8. Select **Next**.
9. Review your settings before saving. If you customized your waiting room, make sure to [preview the result](/waiting-room/how-to/customize-waiting-room/#preview-waiting-room).
10. Select **Save**. Your new waiting room will be enabled by default.

</TabItem> <TabItem label="API">

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,34 @@ You can customize a variety of options for your waiting rooms.
</td>
<td></td>
</tr>
<tr>
<td>Turnstile Widget Mode</td>
<td>
<code>turnstile_mode</code>
</td>
<td>Yes, defaults <code>invisible</code>.</td>
<td>
The type of Turnstile widget to use - refer to the [Turnstile documentation](/turnstile/concepts/widget/#widget-types) for details. Valid values are <code>off</code>, <code>invisible</code>, <code>visible_non_interactive</code>, and <code>visible_managed</code>. Setting this to <code>off</code> will completely disable the Turnstile integration.
</td>
<td>
Setting this to <code>invisible</code> makes sense for most rooms, unless you would like end users to be aware the challenge is running.
</td>
<td></td>
</tr>
<tr>
<td>Turnstile Fail Action</td>
<td>
<code>turnstile_action</code>
</td>
<td>Yes, defaults to <code>log</code>.</td>
<td>
The action to take when an end user fails a Turnstile challenge. Valid values are <code>log</code> and <code>infinite_queue</code>.
</td>
<td>
Setting this to <code>log</code> makes sense for most rooms, unless you wish to aggressively block bots using an infinite queue.
</td>
<td></td>
</tr>
</tbody>
</table>

Expand Down
16 changes: 16 additions & 0 deletions src/content/plans/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -3125,6 +3125,22 @@
"pro": "No",
"biz": "Yes",
"ent": "Yes"
},
"turnstile_widget_mode": {
"title": "Turnstile Widget Mode",
"link": "/waiting-room/how-to/create-waiting-room/",
"free": "No",
"pro": "No",
"biz": "Invisible only",
"ent": "Invisible (default)\n\n<em>With add-on</em>\nAll options"
},
"turnstile_fail_action": {
"title": "Turnstile Fail Action",
"link": "/waiting-room/how-to/create-waiting-room/",
"free": "No",
"pro": "No",
"biz": "Log only",
"ent": "Log only (default)\n\n<em>With add-on</em>\nInfinite queue"
}
}
}
Expand Down
Loading