Apps & Surfaces

Surfaces

Explore the data types and operations available in Surfaces.

104 types · Used in operation arguments and return values.

CreateJourneyInputInput

Input for `createJourney`: always creates a fresh journey (there is no id to look up), leaving it with a single unpublished draft version.

CreateJourneySourceInputInput

Create a journey from authoritative XML with optional visibility and team assignments.

CreateJourneyVersionInputInput

Input for creating a new draft version of an existing journey.

CreateJourneyVersionSourceInputInput

Create a draft journey version from an author-owned XML document.

CreatePortalAPICredentialInputInput

Request to issue a Portal API credential.

CreatePortalAPICredentialPayloadObject

Result of issuing a Portal API credential.

CreatePortalInputInput

Configuration for a new Portal. Control assigns its address; no hostname is supplied.

CreatePortalLoginTicketInputInput

Request to issue a single-use Portal login ticket.

CreatePortalLoginTicketPayloadObject

Result of issuing a Portal login ticket.

CreatePortalMembershipInputInput

A new Portal membership connecting a user to a customer.

CreatePortalSiteInputInput

A new site for a Portal.

CreatePortalSiteVersionInputInput

The full source of a new immutable site snapshot.

CreatePortalUserInputInput

A new PortalUser.

CreateWorkspaceInputInput

Input for creating a workspace.

CreateWorkspaceVersionInputInput

Input for creating a new draft version of an existing workspace.

DataChangeEventObject

A real-time data change event delivered via subscription

DataChangeEventGroupObject

A group of data change event topics for a single resource

DeletePayloadObject

Result of a delete operation

HelpChapterObject

Published manual content for the Help reader.

HelpChapterInfoObject

Metadata for a published manual chapter.

HelpSearchResultObject

Hybrid semantic and text manual search results.

IaCGuideObject

An authoring guide, as a document with a stable file name. The same guides the MCP server serves, exposed so declarative tooling can sync them to a folder beside the schema.

IaCSchemaDocumentObject

The annotated infrastructure schema and the hash that pins it

IaCSchemaDocumentPayloadObject

A schema or Lua testing contract document and the hash that pins it

IaCValidationResultObject

Result of validating one artifact

IntScalar

The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

JourneyObject

An instance-served journey: a guided, multi-step workflow the runner executes. The container record joined with the version it currently serves (published when one exists, else the open draft). Who may see and author it is decided by `scope`.

JourneyAuthoringAnalysisObject

Execution-free validation and compilation results for Journey authoring.

JourneyConnectionObject

A page of the caller's visible journey library.

JourneyFilterInputInput

Filter for `listJourneys`, applied on top of (never instead of) the caller's scope- and requiredDomains-based visibility.

JourneyIDScalar

Unique identifier for a journey

JourneyPayloadObject

Result of a journey create / update / publish: either the resulting journey or the validation errors that prevented the write.

JourneySortInputInput

One ordering clause for `listJourneys`. Only the first clause is applied; the default is UPDATED_AT descending (most recently changed first).

JourneyVersionObject

One immutable-once-published snapshot of a journey definition. The authoring history returned by `listJourneyVersions`.

JourneyVersionConnectionObject

A page of a journey's authoring history returned by `listJourneyVersions`.

JourneyVersionIDScalar

Unique identifier for a journey version

JourneyVersionPayloadObject

Result of creating a journey version: either the created draft or the validation errors that prevented it.

JourneyViewObject

A published journey as a runner or menu reads it: no source, drafts or revision. Authoring uses the Journey type.

JourneyViewConnectionObject

A page of journey views, ordered by handle.

JSONScalar

Arbitrary JSON value (object, array, number, boolean, string, or null). Not introspectable — when the shape is known, prefer a typed `Type` registration. Numbers stored as numbers come back as numbers, not stringified.

MagicQueryInfoObject

A discoverable Magic Query noun and its accepted options.

MagicQueryOperationObject

The real GraphQL operation + variables a Magic Query resolves to.

MagicQuerySchemaObject

Input (JSON Schema) and output (introspection) contract for a Magic Query noun.

PortalObject

A customer-facing web Portal: its address, IAM ceiling and audience-to-site routing.

PortalAPICredentialObject

A bearer API credential for one Portal membership. Its secret is returned only at issuance and stored as a digest.

PortalAPICredentialConnectionObject

A page of API credentials.

PortalAPICredentialIDScalar

Typed identifier of a Portal API credential, serialized as a `poc_` TypeID string.

PortalAPICredentialPayloadObject

Result of a API credential mutation.

PortalAudienceInputInput

One audience-to-site binding of a Portal.

PortalComponentLibraryObject

The component library bundled with this server; a site's own component of the same name overrides one.