Options
All
  • Public
  • Public/Protected
  • All
Menu

A partner successfully shares a Private Viewing Room — past this point the link works and the client can open the room. Fires from the publish mutation's success callback, so it means the room is live rather than that the gallery intended to share it.

value distinguishes a first share from an update to an already-shared room. Every share goes through the editor: the stale-room banner opens the editor rather than republishing in one click, so the gallery always reviews the preview before viewers see a change.

has_passcode is a boolean by design. The passcode itself is a shared access credential and is never sent.

content is a generic catch-all holding the header choices and the artwork detail fields the gallery chose to expose — field names only, never their values. Kept generic on purpose, matching OsCreatedStudioContent, so it is parsed ad-hoc downstream rather than maintained as a rigid set of top-level fields.

This schema describes events sent to Segment from SharedPrivateViewingRoom

example
{
  action: "sharedPrivateViewingRoom",
  context_module: "privateViewingRoomEditor",
  context_page_owner_type: "privateViewingRoom",
  value: "shared",
  list_id: "5d2b5b5d5e5b5d000e1b5b5d",
  artwork_count: 12,
  has_passcode: true,
  brand_kit: true,
  content: {
    showGalleryName: true,
    hasHeading: true,
    hasDescription: false,
    artworkFields: ["artistName", "artworkTitle", "year", "medium"]
  }
}

Hierarchy

  • SharedPrivateViewingRoom

Index

Properties

action

action: sharedPrivateViewingRoom

artwork_count

artwork_count: number

brand_kit

brand_kit: boolean

content

content: Record<string, unknown>

Generic catch-all for the header choices and exposed artwork detail fields

context_module

context_module: privateViewingRoomEditor

context_page_owner_type

context_page_owner_type: privateViewingRoom

has_passcode

has_passcode: boolean

Whether a passcode is set. The passcode itself is never sent

list_id

list_id: string

value

value: "shared" | "updated"

Generated using TypeDoc