​
What is a tenant?

A tenant is one of your customers who has connected at least one integration via hotglue.

​
What is an active tenant?

An active tenant is any tenant that has run at least one sync job within the last 30 days. Billing is calculated based on the number of active tenants. Learn more about tenants and how they are used in the walkthrough below:

​
What is a subtenant?

Subtenants are used when a single tenant needs multiple distinct connections with the same connector. Learn more about subtenants.

​
Creating and deleting tenants

Tenants are automatically created when you link a connection with a new tenant_id. This can be done via magic links, the widget, or via the API. You can also clone or delete tenants via your dashboard or API:

​
Clone tenants to another environment

Cloning may be useful if you are migrating to a fresh environment, or if you want to test some changes in a QA environment on a real tenant. Before cloning, you must first ensure that the corresponding flows and sources/connectors have already been cloned to those environments. Once that’s done:
  1. Navigate to the Tenants tab in hotglue
  2. Click on the name of the tenant that you want to clone.
  3. Click Clone Tenant from the tenant management drawer.
  4. Select the environment to clone your tenant into.
Cloning your tenant will copy over the linkedSources, linkedTargets, and linkedConnectors to your new environment. That includes any forks that you have set on ETLs and field maps, alongside the incremental state. Cloned tenants will not automatically transfer snapshots, schedules, triggers, or job history.

​
Delete tenants

In some cases, you may want to completely delete a tenant and its data from hotglue. You can do this programmatically via the API, or from your hotglue dashboard: To delete a tenant:
  1. Navigate to the Tenants tab in hotglue
  2. Click on the name of the tenant that you want to delete.
  3. Click Delete Tenant from the tenant management drawer.
Tenant deletions are “hard” deletions, meaning that any sensitive data—including configs, snapshots, and job cache data—are cleared without a retention period. If you want to keep a tenant’s data but stop its jobs, you can just disable the tenant’s job schedules directly.