Skip to main content

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

FieldTypeDescriptionRequired
idstringUnique identifier for the integration map entry.
providerstringThe name of the external service providerfor the integration. Helps categorize the integration.
overrideanyIndicates if default settings are overridden.
ref_idanyReference ID for the related entity.
bundle_idanyIdentifier for the associated bundle. Could represent a group of APIs, widgets, etc.
labelstringDisplay name or label for the integration. Used in the UI or logs for easier identification.
inputTypestringType of input used in the integration. Helps define the integration setup workflow.
isEnabledbooleanBoolean flag (0/1) to indicate whether the integration is active and in use.
isDefaultbooleanBoolean flag that marks this mapping as the default integration configuration for the given organization or site.
createdBystringUser who created the integration entry
bundleBuildIdstringIdentifier for a specific version of the integration bundle. Useful for deployments and versioning.
created_atdateTimestamp when the record was created.
modified_atdateTimestamp when the record was last updated.
org_idstringThe organization this integration belongs to. Ensures the mapping is tenant-specific in multi-org environments.
sites_idstringThe site within the organization that this integration applies to. Allows per-site customization of integrations.
masterIntegrations_idstringReference to the master integration.
standardItem_idstringReference to a standard component or item that this integration supports
predefined_bundle_idstringReference to a predefined bundle. Used when this mapping comes from a known template or factory default.
predefined_bundlestringName or identifier of the predefined bundle.
integration_typestringDefines the type of integration. Helps in logic/routing of integration flows.
package_typestringType of package associated with the integration.May affect licensing or feature access.
application_idstringID of the related application. Ensures scoping to an app/module.
integrationSettingsanyStores 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"
}