Skip to main content

Develop Plugins

A plugin adds a feature to your exchange without changing the exchange itself. Every plugin HollaEx publishes, from KYC to fiat on-ramps, is built the same way, and you can build your own the same way. This section is for developers and technical operators.

What a plugin can do​

A plugin is a single JSON file. It can contain any of these parts:

  • A server script. JavaScript that runs inside your exchange's plugin service. It can add API endpoints under /plugins/<plugin-name>/, receive webhooks from a provider, react to exchange events (such as a user's verification changing), run scheduled jobs, and call the exchange's own functions through the HollaEx tools library.
  • Settings. Two sets of values the operator fills in under the plugin's Configuration tab. meta is private and only the server script reads it. public_meta is public and the exchange website can read it. Mark a credential with secret: true: Operator Controls then never shows the saved value again (it shows ********), and the operator can only overwrite it.
  • Admin views. Extra screens in Operator Controls, shown as an Admin view tab on the plugin, for dashboards, record lists, forms and buttons that run jobs.
  • User-facing views. Pages and components on your exchange website. On a HollaEx Web v3 website, a plugin can add blocks to Site Studio, add pages with menu entries, and fill built-in steps such as the identity check, bank account, fiat deposit and withdrawal, or the support chat. On a Kit v2 Web website, a plugin adds web views instead.

How plugins work explains each part.

Custom plugins on HollaEx Cloud​

You can build your own plugins, or have a developer build them, and install them on your HollaEx Cloud exchange. That includes plugins with server scripts. Installing any plugin needs the Enterprise plan.

You don't need access to the exchange's servers. You build the plugin JSON on your own computer and install it from Operator Controls → Exchange → Plugins with Add plugin. See Build, test and install a plugin.

A plugin has full access to your exchange

A plugin's server script runs with the same backend access as the exchange. It can read and change user data, balances and KYC documents, and it can use your API keys. Install only plugins whose code you have reviewed or whose author you trust.

Ask HollaEx to build it​

Enterprise customers can ask HollaEx to build a custom plugin or integration, for example a connection to a bank or a local payment provider. Open a ticket from your HollaEx dashboard and describe what the plugin should do.

In this section​

  1. How plugins work: the parts of a plugin, its JSON fields, settings, libraries and what the server script can use.
  2. Build, test and install a plugin: the workflow from a starter project to a plugin running on your exchange, and how to ship updates.

Need help? Open a ticket from your HollaEx dashboard.