| Property Name | Type | Description |
|---|---|---|
| cloudId | String | Id of the Compass site to search for the component/create the component on if it does not already exist. |
| customFields | Array<CustomFieldInput> | |
| dataManager | DataManagerInput | The external integration that manages data for this component. |
| description | String | The description of the component. |
| eventSources | Array<CreateEventSourceInput | EventSource> | The collection of event sources to sync on the component. If a given event source does not exist on the component, it gets created. If an event source exists in Compass but not in the collection defined here, the event source on Compass gets deleted. If an empty list or null is supplied, the existing event sources on the Compass component are removed. If this value is left undefined, no action is taken on the existing collection of event sources on the Compass component. |
| externalAlias | CompassExternalAliasInput | External alias to search for the component by. |
| fields | Record<String, Array<String>> | A collection of fields for storing data about the component. Where the key is the name in the field definition and the value is the CompassFieldValueInput. |
| labels | Array<String> | A collection of labels that provide additional contextual information about the component. |
| links | Array<CreateLinkInput | Link> | The collection of links to sync on the component. If a given link does not exist on the component, it gets created. If a link exists in Compass but not in the collection defined here, the link on Compass gets deleted. If an empty list or null is supplied, the existing links on the Compass component are removed. If this value is left undefined, no action is taken on the existing collection of links on the Compass component. |
| name | String | The name to apply to the component. |
| options | SyncComponentByExternalAliasInputOptions | Options for how to handle sync behavior. |
| ownerId | String | The unique identifier (ID) of the team that owns the component. |
| relationships | Array<Relationship> | A collection of relationships between the component and other entities in Compass. |
| slug | String | The unique slug of the component. |
| type | CompassComponentType | The type to apply to the component. |
| typeId | String |
Rate this page: