API Reference version 2

Web Panels

Web Panels are rendered as iframes in the sidebar or in a dialog.

API Documentation

See the API documentation for the Sidebar

Descriptor Attribute Reference

Type Property Description Required?
string authentication

The authentication method for this webpanel

Valid values: jwt, none.

Defaults to 'jwt'.

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
string key

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

Valid length range: 1 - 40.

Required
string location

The location of this webPanel

Valid values: hipchat.sidebar.right.

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
string url

The URL of the resource providing the view content.

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.