Skip to main content

External Identities

Object

Data TypeField NameDescriptionPurposeRulesDisposition
ExternalIDExternalIDEach external system concerned with the parent object can keep track of its own system identity for the object with the ExternalID property of a class.A class used to group together the properties describing all the external systems concerned with the parent object.
  • Zero to many
  • Only one ExternalID per Integration.
  • These should only be used for identity resolution between SyncHive and integrations
  • The combination of externalID and externalSystemCode must form a unique key.
  • An integration can write the externalID for another integration.
  • An integration will only receive its own external ID.
  • An integration can refer to other integration external ID’s when sending inbound data.

Properties

Data TypeField NameDescriptionPurposeRules
StringexternalIDA unique identifier for this object as it exists in the external system referred to by the externalSystemCode.To allow for identity resolution between of object and data between external systems.One only
StringexternalSystemCodeA unique identifier for the external system. Currently the integration keyUsed to identify one of the external systems referencing this object.One only
StringinternalTypeIdentifies the object type of the parent object in the platformOne only