IntegrationMap Model
Overview
The integrationmap table serves as a central configuration registry for defining how an organization integrates with external systems or services, such as third-party platforms, APIs, or tools. It includes metadata and control flags that help manage integration behavior, enablement, defaults, and overrides.
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| id | string | Unique identifier for the integration map entry. | ❌ |
| provider | string | The name of the external service providerfor the integration. Helps categorize the integration. | ❌ |
| override | any | Indicates if default settings are overridden. | ❌ |
| ref_id | any | Reference ID for the related entity. | ❌ |
| bundle_id | any | Identifier for the associated bundle. Could represent a group of APIs, widgets, etc. | ❌ |
| label | string | Display name or label for the integration. Used in the UI or logs for easier identification. | ❌ |
| inputType | string | Type of input used in the integration. Helps define the integration setup workflow. | ❌ |
| isEnabled | boolean | Boolean flag (0/1) to indicate whether the integration is active and in use. | ❌ |
| isDefault | boolean | Boolean flag that marks this mapping as the default integration configuration for the given organization or site. | ❌ |
| createdBy | string | User who created the integration entry | ❌ |
| bundleBuildId | string | Identifier for a specific version of the integration bundle. Useful for deployments and versioning. | ❌ |
| created_at | date | Timestamp when the record was created. | ❌ |
| modified_at | date | Timestamp when the record was last updated. | ❌ |
| org_id | string | The organization this integration belongs to. Ensures the mapping is tenant-specific in multi-org environments. | ✅ |
| sites_id | string | The site within the organization that this integration applies to. Allows per-site customization of integrations. | ✅ |
| masterIntegrations_id | string | Reference to the master integration. | ❌ |
| standardItem_id | string | Reference to a standard component or item that this integration supports | ❌ |
| predefined_bundle_id | string | Reference to a predefined bundle. Used when this mapping comes from a known template or factory default. | ❌ |
| predefined_bundle | string | Name or identifier of the predefined bundle. | ❌ |
| integration_type | string | Defines the type of integration. Helps in logic/routing of integration flows. | ❌ |
| package_type | string | Type of package associated with the integration.May affect licensing or feature access. | ❌ |
| application_id | string | ID of the related application. Ensures scoping to an app/module. | ❌ |
| integrationSettings | any | Stores the settings/configuration details for the integration in text or JSON format | ❌ |
Sample JSON
{
"id": "example_value",
"provider": "example_value",
"override": "example_value",
"ref_id": "example_value",
"bundle_id": "example_value",
"label": "example_value",
"inputType": "example_value",
"isEnabled": "example_value",
"isDefault": "example_value",
"createdBy": "example_value",
"bundleBuildId": "example_value",
"created_at": "example_value",
"modified_at": "example_value",
"org_id": "example_value",
"sites_id": "example_value",
"masterIntegrations_id": "example_value",
"standardItem_id": "example_value",
"predefined_bundle_id": "example_value",
"predefined_bundle": "example_value",
"integration_type": "example_value",
"package_type": "example_value",
"application_id": "example_value",
"integrationSettings": "example_value"
}