API Reference version 2

Get global dialog

GET/v2/extension/dialog/{key}

Retrieve a global dialog.

Path parameters

Type Parameter Description Required?
string key

Unique key (in the context of the integration) to identify this dialog.

Valid length range: 1 - 40.

Required
200 application/json
Type Property Description Required?
object room

The room, if specified, that this dialog is restricted to. Will be null for global extensions

May be null.

Required
string name

Name of the room.

Required
object links

URLs to retrieve room information

Required
string self

The URL to use to retrieve the full room information

Required
string webhooks

The URL to use to retrieve webhooks registered for this room

Required
string members

The URL to use to retrieve members for this room. Only available for private rooms. Note this link will be made available to public room from Dec 1, 2016

string participants

The URL to use to retrieve participants for this room

Required
string privacy

Privacy setting

Valid values: public, private.

Required
boolean is_archived

Whether or not this room is archived.

Required
string version

An etag-like random version string.

Required
integer id

ID of the room.

Required
string title

The title of the dialog.

Required
string url

The url where the dialog content is hosted.

Required
string created

Time the dialog was created in ISO 8601 format UTC.

Required
object options

Dialog options

string authentication

The authentication method for this dialog

Valid values: jwt, none.

Defaults to 'jwt'.

string key

Unique key (in the context of the integration) to identify this dialog.

Required
integer id

Internal ID of the extension.

Required