Object - Link

Type identifier: object:link Category: Object Operations

Description

Links a source Record (from) to a target Record (to) using a configured relationship version. Depending on relationship cardinality, the operation creates a relationship, repoints an existing relationship, or leaves an exact active relationship unchanged.

Input Handles

Handle	Data Type	Connection required	Description
`trigger`	`trigger`	No	Activates the link operation
`from`	`string`/`object`	No	Source Record ID or object with `id`; validated at runtime
`to`	`string`/`object`	No	Target Record ID or object with `id`; validated at runtime

Input Handle Details

`from`

Type: string (CUID2) or object with id property
Notes:
- Accepts a Record ID directly
- Accepts a Record object (extracts id property)
- Must contain a CUID2 ID; otherwise the node emits error

`to`

Type: string (CUID2) or object with id property
Notes:
- Same behaviour as from
- Target Record for the relationship

Output Handles

Handle	Data Type	Description
`success`	`trigger`	Triggered when the relationship is created, updated, or unchanged
`error`	`trigger`	Triggered for invalid endpoints and expected domain errors

Configuration Options

Property	Type	Required	Default	Description
`label`	`string`	Yes	`"Object - Link"`	Display label for the node
`schemaId`	`string`	Yes	`""`	Retained node configuration; not used by this node
`relationshipVersionId`	`string`	Yes	`""`	CUID2 of the relationship version

Configuration Details

`relationshipVersionId`

Type: string (CUID2)
Notes:
- References a Schema relationship version
- Determines the relationship type and direction
- Configured via relationship dropdown in UI

Behaviour

Execution Flow

Resolves connected from and to inputs.
Extracts each ID from a CUID2 string or an object with its own id property.
Routes missing or invalid IDs to error.
Creates or updates the relationship using relationshipVersionId and the run identity.
Emits success for created, updated, and unchanged actions.

Relationship Actions

Action	Behaviour
`created`	Creates a new relationship.
`updated`	Repoints the existing cardinality-conflicting relationship's endpoint.
`unchanged`	Leaves an exact active relationship unchanged.

When cardinality controls are unavailable or disabled, link requests create new relationships rather than repointing existing ones. The node has no data output.

Error Handling

Scenario	Behaviour
`from` or `to` is disconnected, missing, or has an invalid ID	Triggers `error`.
Expected relationship/domain rejection	Triggers `error`.

Examples

Link Records by ID

{
  "type": "object:link",
  "data": {
    "label": "Link Order to Customer",
    "schemaId": "order-schema-uuid",
    "relationshipVersionId": "order-customer-rel-uuid"
  }
}

Connects from input (order ID) to to input (customer ID).

Link From Query Results

{
  "type": "object:link",
  "data": {
    "label": "Assign Task to User",
    "schemaId": "task-schema-uuid",
    "relationshipVersionId": "task-assignee-rel-uuid"
  }
}

Can receive full Record objects from Object - Query nodes; automatically extracts IDs.

Object - Create

Creates a new Record in a specified Schema. The created Record can be queried or modified by subsequent nodes in the Flow.

Object - Query

Queries Records based on filter criteria. Supports complex filtering, pagination, and ordering. Returns matching Records with metadata. Results can be processed, displayed, or passed to downstream nodes.

Object - Query Link

Queries relationships between Records to find linked Records. Given either a source Record or target Record, finds the corresponding linked Record via a specific relationship type. Returns Record IDs for further processing.

Object - Unlink

Removes relationships between Records. Supports three modes: unlinking a single specific relationship, removing all outgoing relationships from a Record, or removing all incoming relationships to a Record.