API Reference version 2

Get room web panel

GET/v2/room/{room_id_or_name}/extension/webPanel/{key}

Retrieve a web panel.

Path parameters

Type Parameter Description Required?
string key

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

Valid length range: 1 - 40.

Required
string room_id_or_name

The id of the room

Valid length range: 1 - 100.

Required
200 application/json
Type Property Description Required?
string name

The display name of the webPanel.

Required
integer weight

Determines the order in which webPanel appear. Web panels are displayed top to bottom or left to right in order of ascending weight.

object room

The room, if specified, that this web panel 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 url

The URL of the resource providing the view content.

Required
string created

Time the web panel was created in ISO 8601 format UTC.

Required
string authentication

The authentication method for this webpanel

Valid values: jwt, none.

Defaults to 'jwt'.

string location

The location of this webPanel

Valid values: hipchat.sidebar.right.

Required
string key

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

Required
object conditions

Conditions determine whether this web panel is shown

integer id

Internal ID of the extension.

Required
object icon

Icon to display on the left side of the webPanel title.

string url

Url for the icon.

Required
string url@2x

Url for the retina version of the icon.

Required