API Reference version 2

Configuration Pages

Most integrations will need to be configured in order to work correctly. For this purpose, an integration can expose a 'configurable' capability that provides an HTML page to be included as a panel in the configuration dialog.

Attribute Reference

Type Property Description Required?
boolean allowAccessToRoomAdmins

If the add-on is installed globally, this property can allow the configuration page to be accessed in the room administration pages making it possible to have room specific configuration for the global add-on. This is only valid for globally installed add-ons.

Defaults to false.

string authentication

The authentication method for this configure page

Valid values: jwt, none.

Defaults to 'jwt'.

string url

The URL to embed into a configure dialog via an iframe