# Integration Entities {#integration-entities}


Entities for third-party integration configurations, tenant bindings, entity mappings, and settings.


## Integration {#integration}


| Column            | Type     | Description          |
| ----------------- | -------- | -------------------- |
| `name`            | string   | Integration name     |
| `imgSrc`          | string?  | Logo URL             |
| `isComingSoon`    | boolean  | Coming soon flag     |
| `isPaid`          | boolean? | Requires payment     |
| `version`         | string?  | Version number       |
| `docUrl`          | string?  | Documentation URL    |
| `isFreeTrial`     | boolean? | Free trial available |
| `freeTrialPeriod` | number?  | Trial period (days)  |
| `order`           | number?  | Display order        |


## IntegrationTenant {#integrationtenant}


Binds an integration to a specific tenant.

| Column          | Type    | Description       |
| --------------- | ------- | ----------------- |
| `name`          | string? | Connection name   |
| `integrationId` | UUID    | FK to integration |

**Relations:** `entitySettings` (OneToMany IntegrationEntitySetting), `settings` (OneToMany IntegrationSetting)


## IntegrationSetting {#integrationsetting}


Key-value settings for integration configuration.

| Column                | Type   | Description              |
| --------------------- | ------ | ------------------------ |
| `settingsName`        | string | Setting key              |
| `settingsValue`       | string | Setting value            |
| `integrationTenantId` | UUID   | FK to integration tenant |


## IntegrationMap {#integrationmap}


Maps external entities to internal Gauzy entities.

| Column                | Type   | Description              |
| --------------------- | ------ | ------------------------ |
| `sourceId`            | string | External entity ID       |
| `gauzyId`             | string | Internal Gauzy entity ID |
| `entity`              | string | Entity type              |
| `integrationTenantId` | UUID   | FK to integration tenant |


## IntegrationEntitySetting {#integrationentitysetting}


Configures which entities are synced for an integration.

| Column                | Type    | Description              |
| --------------------- | ------- | ------------------------ |
| `entity`              | enum    | Entity type to sync      |
| `sync`                | boolean | Whether to sync          |
| `integrationTenantId` | UUID    | FK to integration tenant |


## Related Pages {#related-pages}


- [Integration Endpoints](https://sourcey-gauzy.pages.dev/api/integration-endpoints/index.md) — API reference
- [Integrations Overview](https://sourcey-gauzy.pages.dev/integrations/integrations-overview/index.md) — integrations guide