Working with tenants in the API

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

Tenants are denoted by a tenant_id, which you define when you initially link a user. This tenant_id is generally your own internal ID for customers.

The tenant object

The tenant holds 3 main configuration objects:

  1. Snapshots - The caching layer used to manage state, which we call "snapshots," lives on a tenant level, across all integrations.
  2. Tenant config - Not to be confused with a connector config for a tenant, the tenant-config.json is a persistent config that can be used to store custom mapping, keys, and other tenant-level settings.
  3. Schedules - These can be configured per flow, but they are managed and toggled on a tenant level.