Request Status of All Widgets

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/api/organization/562a519b54f83b56/widget_status

Responses

200

Successful request

Expand All

object

data

Array of object (CallObjectAllWidgets)

object

name

string

The name of the Widget in Scheduler

public_name

string

Typically a more descriptive name given to the Widget in Scheduler. If no public_name was set, this defaults to the name value.

description

string

The Widget's description as it was configured in Scheduler

unique_id

string

The Widget's unique identifier, which is used to build the GET requests (points to that specific Widget) and used when submitting callback requests

offer_asap

string

Confirms whether or not the widget offers ASAP callbacks

offer_scheduled

string

Confirms whether or not the widget offers scheduled callbacks

ewt

string

Estimated time, in seconds, before the callback is launched

api_message

string

The API message as configured in the Template. This message represents the current state of the Widget.

Was this article helpful?