API Reference version 2

Get room action

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

Retrieve an action.

Path parameters

Type Parameter Description Required?
string key

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

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 action.

Required
integer weight

Determines the order in which the action appears in menu or list.

Required
string created

Time the action was created in ISO 8601 format UTC.

Required
string location

The location of this action

Valid values: hipchat.message.action, hipchat.input.action.

Required
string key

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

Required
object target

Defines how the action is handled in the client, such as opening a dialog or a sidebar.

Required
object options

An object containing options which vary based on the type of target.

string key

The key of a dialog, glance or web panel that should be opened in response to this action.

Valid length range: 1 - 40.

Required
object conditions

Conditions determine whether this action is shown

integer id

Internal ID of the extension.

Required
object room

The room, if specified, that this action 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