Skip to content

Installed Unified Models - Environment Unified Models Object

Properties

created_atstring · date-time

Timestamp when this record was created.

Example: 2024-01-10T10:00:00.000Z
environment_idstring · uuid

The ID of the environment where this unified model is installed.

Example: 1ba1f401-7183-47c5-9e39-e8e257e3c795
idstring · uuid

The ID of the environment-unified-model record.

Example: 4af1e38e-1d84-4bea-8ef4-2d705aec43bc
overrideobject

An optional object containing environment-level overrides for the unified model. Deep-merged on top of the base unified model. See EnvironmentUnifiedModelOverride for the typed shape.

Example:
{
  "resources": {
    "users": {
      "description": "Overrides the user resource description for this environment.",
      "integration_mapping": {
        "my_integration": {
          "list": {
            "path_mapping": "/v2/users"
          }
        }
      }
    }
  }
}
docsRecord<string, any>

Per-integration documentation overrides.

resourcesRecord<string, any>

Resource-level overrides keyed by resource name.

scopesRecord<string, any>

Per-integration extra OAuth scopes appended to the base unified-model scopes.

webhooksRecord<string, any>

Per-integration JSONata expressions that route inbound webhooks to unified-model resources.

unified_modelobject
categorystring

The category of the unified model.

Example: hris
created_atstring · date-time

The date and time when the unified model was created.

Example: 2021-08-10T10:00:00.000Z
descriptionstring

A brief description of what this unified model represents.

Example: This model provides a user directory interface for various HRIS integrations.
docsRecord<string, any>

Per-resource documentation (pricing plan / scopes / instructions).

idstring · uuid

The ID of the unified model.

Example: 7c5c8cc2-e68e-4af8-84d1-4ceea1489338
installed_environmentstring[]

A list of environment IDs where this unified model is installed.

namestring

The name of the unified model.

Example: user-directory
resourcesRecord<string, any>

Map of resource name (e.g. users, contacts) → resource definition (UnifiedModelResource).

Example:
{
  "users": {
    "description": "A resource representing user objects",
    "schema": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "email": {
          "type": "string"
        }
      }
    },
    "integration_mapping": {
      "my_integration": {
        "list": {
          "resource": "/users",
          "method": "get"
        }
      }
    }
  }
}
scopesRecord<string, any>

Per-resource OAuth/permission scopes required to call its methods.

sharingstring

The sharing policy of the unified model.

Example: deny
Possible values:
allowaskdeny
teamobject
10 properties
allow_impersonationboolean

Whether the team allows impersonation.

Example: false
created_atstring · date-time

The date and time when the team was created.

Example: 2021-08-10T10:00:00.000Z
domainstring

The domain of the team.

Example: example.com
idstring · uuid

The ID of the team.

Example: 05daecaf-4365-42e8-8370-8127de5dd717
is_verifiedboolean

Whether the team is verified or not.

Example: true
is_white_labelboolean

Whether the team is white-labeled or not.

Example: false
logostring

The URL of the team's logo.

Example: https://example.com/logo.png
namestring

The name of the team.

Example: My Awesome Team
tos_linkstring

A link to the team's Terms of Service, if available.

Example: https://example.com/tos
updated_atstring · date-time

The date and time when the team was last updated.

Example: 2021-08-10T10:00:00.000Z
team_idstring · uuid

The ID of the team that owns this unified model.

Example: 05daecaf-4365-42e8-8370-8127de5dd717
updated_atstring · date-time

The date and time when the unified model was last updated.

Example: 2021-08-10T10:30:00.000Z
versionnumber

The current version of the unified model.

Example: 3
webhooksRecord<string, any>

Per-resource webhook routing expression (JSONata that decides whether an inbound webhook should be delivered to this resource).

unified_model_idstring · uuid

The ID of the unified model being installed or overridden.

Example: 7c5c8cc2-e68e-4af8-84d1-4ceea1489338
updated_atstring · date-time

Timestamp when this record was last updated.

Example: 2024-01-11T12:30:00.000Z