Custom source apps

Custom source apps let you import data into eazyBI from any service with a REST or GraphQL API, or from a SQL database, when eazyBI has no built-in integration for it. A custom source app works like a built-in source application, with its own connection form, import options, cube, incremental imports, and sample reports.

On this page:

When to use a custom source app

For a single REST API endpoint, the REST API source application is often enough: you map the columns of one response to dimensions and measures in eazyBI. A custom source app is a better choice in the following cases:

• The data comes from several related endpoints, for example, pull requests with their comments, reviews, and commits.
• The source system needs OAuth 2.0, a service account, or another authentication method that the REST API source application does not support.
• The data is large, and you want incremental imports of only the changed data.
• Several accounts should reuse the same source application: the same kind of data, cube, and sample reports.
• The data belongs to a Jira app, and you want to analyze it with Jira work items (issues), by Jira dimensions such as Project, Sprint, or Assignee. In this case, use a Jira custom addon app.

How custom source apps work

A custom source app is a package of JavaScript files. eazyBI installs the package and runs it as a source application in an eazyBI account. The package defines the following:

• Connection – the fields of the connection form and the authentication method, for example, an API token, OAuth 2.0, or a service account.
• Import options – which source objects to import, for example, projects or repositories, and optional custom fields.
• Data model – the cube dimensions, measures, and calculated members that you use in reports.
• Importer – the requests to the source system and the import of the received data, with incremental imports of changed data.
• Sample reports – reports and dashboards that eazyBI creates after the first import.

The diagram shows how a custom source app is built, installed, and used:

1. Build. An AI coding agent writes the app files. The eazyBI custom source apps skill teaches the agent how to build an app, and the eazyBI CLI runs its tests and installs it. Keep the app files in a Git repository.
2. Install. Install the app into one account or for all accounts of your site. You can also install a ready-made app from the eazyBI Marketplace.
3. Import and analyze. Add the app as a new source application in the Source Data tab of an account, enter the connection details, select the import options, and import the data. Then create reports from the imported cube, or start with the sample reports.

Security

eazyBI runs the JavaScript code of a custom source app in a sandboxed engine with the following restrictions:

• The code cannot read passwords, API tokens, or OAuth tokens. eazyBI adds them to the requests themselves.
• The app can send requests only to the hosts declared in its manifest.
• The app cannot run SQL queries against the eazyBI database. The connection to an external SQL database is read-only.
• The code has no access to the file system or to other network connections.

Only account owners and site admins can install custom source apps. A new app starts in the draft status, so you can test it before other users can select it.

eazyBI Marketplace

The eazyBI Marketplace lists ready-made custom source apps that you can install. eazyBI creates and maintains the Marketplace apps, for example, GitHub, Harvest, and Help Scout. For more about the Marketplace, see eazyBI Marketplace.

Apps with the Jira label are Jira custom addon apps: you turn them on in the import options of a Jira source application.

To install an app from the Marketplace:

1. In the Source Data tab, open the Custom Source Apps tab.
2. Click Install from Marketplace and search for the app.
3. Click the app to read its description, README, changelog, and license.
4. Click Install.
5. Test the import of the app in the account, and then enable the app for all users.

Install and manage custom source apps

Account owners install custom source apps into their accounts, and site admins install them for all accounts of the site. Besides apps from the eazyBI Marketplace, you can install an app you built with the eazyBI CLI, or upload it as a ZIP file or from a Git repository in the eazyBI UI. A new app starts in the draft status: test its import, and then enable it for all users.

For the installation options, enabling, updating, and disabling custom source apps, see Install and manage custom source apps.

Build a custom source app with an AI coding agent

Custom source apps are designed to be built with AI coding agents, such as Claude Code, Codex, or Rovo Dev. You describe the data you want to analyze in plain language, and the agent builds, tests, and installs the app with the eazyBI custom source apps skill and the eazyBI CLI.

For the prerequisites, project setup, a sample prompt, and testing, see Build a custom source app with an AI coding agent.

See also

• eazyBI Marketplace – ready-made custom source apps that you can install.
• Install and manage custom source apps – install, enable, update, and disable custom source apps.
• Build a custom source app with an AI coding agent – build, test, and install your own app.
• Jira custom addon apps – add the data of a Jira app to the import of a Jira source application.
• eazyBI custom source apps skill – the complete reference of the files, the JavaScript API, and the tests of a custom source app.
• eazybi_custom_sources – reference implementations of custom source apps.
• eazyBI CLI – install the CLI and log in to eazyBI.
• Import from REST API – import data from a single REST API endpoint without writing code.