API Reference version 2

Create global web panel

PUT/v2/extension/webPanel/{key}

Create a global web panel.

Dynamically created web panel have the following restrictions:

  • You can only create 10 global web panels
  • You cannot modify a web panel that was declared in the descriptor

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

Request body

Type Property Description Required?
object name

The display name of the webPanel.

Required
string i18n

The optional localization key, used to look up the localized value.

Valid length range: 1 - 40.

string value

The default text.

Valid length range: 1 - 100.

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.

Defaults to 100.

string url

The URL of the resource providing the view content.

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

Valid length range: 1 - 40.

Required
array conditions

Conditions determine whether this web panel is shown

A mixed array of the following types.

object [conditions array, option 1]

An object with the following properties.

Required
boolean invert

A flag indicating whether to invert the boolean result of the condition.

object params

A map of key/value parameters for a built-in condition.

string condition

The identifier of a built-in condition.

Valid values: room_is_public, user_is_admin, user_is_guest, user_is_room_owner.

Required
object [conditions array, option 2]

An object with the following properties.

Required
array conditions

The conditions to compose using the specific logical operator.

A mixed array of the following types.

Required
object [conditions array, option 1]

An object with the following properties.

Required
boolean invert

A flag indicating whether to invert the boolean result of the condition.

object params

A map of key/value parameters for a built-in condition.

string condition

The identifier of a built-in condition.

Valid values: room_is_public, user_is_admin, user_is_guest, user_is_room_owner.

Required
object [conditions array, option 2]

An object with the following properties.

Required
array conditions

The conditions to compose using the specific logical operator.

A mixed array of the following types.

Required
object [conditions array, option 1]

An object with the following properties.

Required
boolean invert

A flag indicating whether to invert the boolean result of the condition.

object params

A map of key/value parameters for a built-in condition.

string condition

The identifier of a built-in condition.

Valid values: room_is_public, user_is_admin, user_is_guest, user_is_room_owner.

Required
string type

Defines what logical operator is used to evaluate the list of conditions.

Valid values: and, or, AND, OR.

Required
string type

Defines what logical operator is used to evaluate the list of conditions.

Valid values: and, or, AND, OR.

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
201 application/json
Type Property Description Required?
str | int id

The unique identifier for the created entity

Required
object links

An object with the following properties.

Required
string self Required