Skip to content

SharedResourceEnvelope ​

Type: Object

A template published in the shared-resource catalog: the metadata a tenant browses before installing it. Served by the CoCoCo control plane, not by this tenant's database; the template's payload itself is not exposed here.

Fields ​

NameTypeArgsDescriptionDeprecated
authorStringName of the publisher of the template. Null when the catalog entry is unattributed.
categoryStringCatalog grouping the template is filed under (matched exactly by the category argument of sharedResources). Null when uncategorised.
createdAtString!ISO 8601 timestamp of when the template was first published to the catalog.
descriptionStringLong-form summary of what the template does. Null when the author supplied none.
handleString!Stable machine-readable slug identifying the template in the catalog, independent of its display name.
iconStringIcon identifier for catalog listings, chosen by the template author. Null when unset.
idSharedResourceTemplateID!TypeID of the catalog template ("srt_01K…"). Stable across versions and the id to pass to installSharedResource.
nameString!Human-readable display name of the template, as shown in the catalog.
resourceTypeSharedResourceType!Kind of resource this template installs; determines which domain resource is created on install and which write permission is required.
statusSharedResourceStatus!Publication status. Only PUBLISHED templates are intended for installation; DEPRECATED ones remain resolvable for already-installed tenants.
tags[String!]!Free-form keywords used for catalog search and filtering. Empty when the author supplied none.
updatedAtString!ISO 8601 timestamp of the template's last catalog edit (content, metadata, or status).
versionString!Version string of the template as published; recorded on the installation record so upgrades can be detected.

Connect machines, automate workflows, and build custom apps for print production.