Plugins

Some organizations have unique use cases for tools, work with third parties that Cortex does not have an integration with, or need to pull in data from internal systems. For these uses, Cortex offers the ability to build a plugin.

Plugin code is stored as a single HTML file, which is injected into an iframe inside Cortex. To access external APIs and bypass CORS restrictions, Cortex provides plugins access to plugin proxies. Plugin proxies can be configured to enhance requests to designated URL prefixes with headers, including rules that have access to secrets. Cortex also provides plugins basic contextual information about where the plugin is running inside of the app.

Creating plugins

You can quickly spin up a new plugin repository using the Scaffolder tool. The repository includes React + TypeScript, linting and formatting (via eslint + prettier), testing (via testing-library), and compilation to a single HTML file (via webpack). Additionally, it comes with our core plugin library (@cortexapps/plugin-core) pre-installed, which provides access to context, proxy usage, and UI components.

For instructions on creating a plugin, see Creating a plugin.