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

Fetches the status of a configured waiting room. Response fields include:

  1. status: String indicating the status of the waiting room. The possible status are:
  1. event_id: String of the current event's id if an event is active, otherwise an empty string.
  2. estimated_queued_users: Integer of the estimated number of users currently waiting in the queue.
  3. estimated_total_active_users: Integer of the estimated number of users currently active on the origin.
  4. max_estimated_time_minutes: Integer of the maximum estimated time currently presented to the users.

Servers

Path parameters

Name Type Required Description
waiting_room_id String Yes
zone_id String Yes

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.