Apps & Surfaces
Surfaces
Explore the data types and operations available in Surfaces.
104 types · Used in operation arguments and return values.
Input for `createJourney`: always creates a fresh journey (there is no id to look up), leaving it with a single unpublished draft version.
CreateJourneySourceInputInputCreate a journey from authoritative XML with optional visibility and team assignments.
CreateJourneyVersionInputInputInput for creating a new draft version of an existing journey.
CreateJourneyVersionSourceInputInputCreate a draft journey version from an author-owned XML document.
CreatePortalAPICredentialInputInputRequest to issue a Portal API credential.
CreatePortalAPICredentialPayloadObjectResult of issuing a Portal API credential.
CreatePortalInputInputConfiguration for a new Portal. Control assigns its address; no hostname is supplied.
CreatePortalLoginTicketInputInputRequest to issue a single-use Portal login ticket.
CreatePortalLoginTicketPayloadObjectResult of issuing a Portal login ticket.
CreatePortalMembershipInputInputA new Portal membership connecting a user to a customer.
CreatePortalSiteInputInputA new site for a Portal.
CreatePortalSiteVersionInputInputThe full source of a new immutable site snapshot.
CreatePortalUserInputInputA new PortalUser.
CreateWorkspaceInputInputInput for creating a workspace.
CreateWorkspaceVersionInputInputInput for creating a new draft version of an existing workspace.
DataChangeEventObjectA real-time data change event delivered via subscription
DataChangeEventGroupObjectA group of data change event topics for a single resource
DeletePayloadObjectResult of a delete operation
HelpChapterObjectPublished manual content for the Help reader.
HelpChapterInfoObjectMetadata for a published manual chapter.
HelpSearchResultObjectHybrid semantic and text manual search results.
IaCGuideObjectAn 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.
IaCSchemaDocumentObjectThe annotated infrastructure schema and the hash that pins it
IaCSchemaDocumentPayloadObjectA schema or Lua testing contract document and the hash that pins it
IaCValidationResultObjectResult of validating one artifact
IntScalarThe `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
JourneyObjectAn 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`.
JourneyAuthoringAnalysisObjectExecution-free validation and compilation results for Journey authoring.
JourneyConnectionObjectA page of the caller's visible journey library.
JourneyFilterInputInputFilter for `listJourneys`, applied on top of (never instead of) the caller's scope- and requiredDomains-based visibility.
JourneyIDScalarUnique identifier for a journey
JourneyPayloadObjectResult of a journey create / update / publish: either the resulting journey or the validation errors that prevented the write.
JourneySortInputInputOne ordering clause for `listJourneys`. Only the first clause is applied; the default is UPDATED_AT descending (most recently changed first).
JourneyVersionObjectOne immutable-once-published snapshot of a journey definition. The authoring history returned by `listJourneyVersions`.
JourneyVersionConnectionObjectA page of a journey's authoring history returned by `listJourneyVersions`.
JourneyVersionIDScalarUnique identifier for a journey version
JourneyVersionPayloadObjectResult of creating a journey version: either the created draft or the validation errors that prevented it.
JourneyViewObjectA published journey as a runner or menu reads it: no source, drafts or revision. Authoring uses the Journey type.
JourneyViewConnectionObjectA page of journey views, ordered by handle.
JSONScalarArbitrary 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.
MagicQueryInfoObjectA discoverable Magic Query noun and its accepted options.
MagicQueryOperationObjectThe real GraphQL operation + variables a Magic Query resolves to.
MagicQuerySchemaObjectInput (JSON Schema) and output (introspection) contract for a Magic Query noun.
PortalObjectA customer-facing web Portal: its address, IAM ceiling and audience-to-site routing.
PortalAPICredentialObjectA bearer API credential for one Portal membership. Its secret is returned only at issuance and stored as a digest.
PortalAPICredentialConnectionObjectA page of API credentials.
PortalAPICredentialIDScalarTyped identifier of a Portal API credential, serialized as a `poc_` TypeID string.
PortalAPICredentialPayloadObjectResult of a API credential mutation.
PortalAudienceInputInputOne audience-to-site binding of a Portal.
PortalComponentLibraryObjectThe component library bundled with this server; a site's own component of the same name overrides one.