Skip to main content

ToolRecord

A single tenant-scoped JSON record persisted via the Tools API. Each record belongs to a collection (a stable namespace) and carries a payload plus optional metadata.

type ToolRecord {
  archivedAt: ISO8601DateTime
  collection: String!
  companyId: ID!
  createdAt: ISO8601DateTime!
  id: ID!
  metadata: JSON!
  notificationDeliveredAt: ISO8601DateTime
  notificationDeliveryStatus: String
  payload: JSON!
  performerPartyId: ID!
  schemaVersion: Int!
  updatedAt: ISO8601DateTime!
}

Fields

`ToolRecord.archivedAt` ● `ISO8601DateTime` scalar common

When the record was archived, if soft-deleted.

`ToolRecord.collection` ● `String!` non-null scalar common

The collection this record belongs to (e.g. "freight_booking").

`ToolRecord.companyId` ● `ID!` non-null scalar common

The company that owns this record.

`ToolRecord.createdAt` ● `ISO8601DateTime!` non-null scalar common

When the record was first created.

`ToolRecord.id` ● `ID!` non-null scalar common

Stable record identifier (UUID).

`ToolRecord.metadata` ● `JSON!` non-null scalar common

Optional metadata associated with the payload.

`ToolRecord.notificationDeliveredAt` ● `ISO8601DateTime` scalar common

When the notification was confirmed delivered, if any.

`ToolRecord.notificationDeliveryStatus` ● `String` scalar common

Outcome of the collection's configured notification: skipped, delivered, or failed.

`ToolRecord.payload` ● `JSON!` non-null scalar common

The JSON payload to persist.

`ToolRecord.performerPartyId` ● `ID!` non-null scalar common

The party that created this record.

`ToolRecord.schemaVersion` ● `Int!` non-null scalar common

Version of the payload's schema; managed by the caller.

`ToolRecord.updatedAt` ● `ISO8601DateTime!` non-null scalar common

When the record was last persisted.

Returned By

upsertToolRecord mutation

Fields
Returned By