Skip to content

projectObject

A project object groups the stops required to complete a project, linking the project’s unique id to its associated stop objects.

{
"id": <integer>,
"contractRef": { context, key } | null,
}
id integer
Unique identifier for this project.
type projectParamsKey
The project type — references a projectParams key, which defines the lead stop type and the project’s lifecycle hooks.
contractRef { context, key }
Helix-only — reference to the contract this project was raised under: `context` names the source ("local" = the records-store, else a client store) and `key` is the record id within it. Surfaced by the Contact-Centre search (see helixAppObject); never sent to Spiral.
stops stopObject
The single root stop for the project; further stops nest beneath it via to / and / with / then / asset.