HummingDeck · JSON-LD Context

Hummingdeck Context

JSON-LD context defining the semantic vocabulary for Hummingdeck from HummingDeck.

63 Classes 143 Properties 4 Namespaces
View Context View on GitHub

Namespaces

schema: https://schema.org/
xsd: http://www.w3.org/2001/XMLSchema#
dcterms: http://purl.org/dc/terms/
hummingdeck: https://hummingdeck.com/schema#

Classes

DocumentView ShareLink RoomItem Room TaskAssignee ActionPlanSettings ActionPlanPhase ActionPlanTask ActionPlanProgressCount ActionPlan UpdateActionPlanRequest CreatePhaseRequest UpdatePhaseRequest CreateTaskRequest UpdateTaskRequest SetTaskStatusRequest RoomAnalytics RoomActivityEntry RoomActivityList RoomCapturedEmail RoomCapturedEmailList RoomView RoomViewList RoomLabel RoomLabelList RoomLabelRef CreateRoomLabelRequest UpdateRoomLabelRequest DeleteRoomLabelResult RoomTab RoomSummary RoomList RoomLinksList PrimaryRoomLink CreatedRoom PrimaryLinkRequest CreateRoomLinkRequest UpdateRoomLinkRequest RoomSenderRequest CreateRoomRequest UpdateRoomRequest CreateRoomTabRequest RenameRoomTabRequest ReorderRoomTabsRequest AddRoomSectionRequest AddRoomDocumentRequest AddRoomUrlRequest AddRoomEmbedRequest MoveRoomItemRequest ReorderRoomItemsRequest Document UploadedDocument Contact Company Decision EmailCapture WebhookSubscription UserProfile Error RoomCompanyReference RoomContactReference RoomTabActivityEntry RoomDocumentActivityEntry

Properties

Property Type Container
viewId string
shareSlug string
viewerEmail string
viewerName string
companyName string
deckTitle string
device string
location string
createdAt dateTime
id string
slug string
type string
recipientName string
recipientEmail string
contact
contactCreated boolean
company
companyCreated boolean
shareUrl reference
tabId string
position integer
title string
documentId string
processingStatus string
processingErrorCode string
deliveryMode string
urlId string
url reference
embedUrl reference
allowDownloads boolean
labels list
name string
status string
welcomeMessage string
viewerLayoutMode string
viewerThemeMode string
sender
tabs list
items list
links
updatedAt dateTime
side string
email string
displayName string
showDueDates boolean
notificationsEnabled boolean
recipientCompletionEnabled boolean
targetDate date
color string
relativeDayOffset integer
phaseId string
parentTaskId string
description string
assignee
dueDate date
visibility string
completedAt dateTime
completed integer
total integer
percent integer
plan reference
phases list
tasks list
dependencies list
progress
roomVisits integer
documentViews integer
uniqueViewers integer
averageSecondsInRoom integer
documentsOpened integer
documentsTotal integer
averageCompletionPercent integer
occurredAt dateTime
actorName string
actorEmail string
contactId string
companyId string
documentTitle string
taskTitle string
roomItemId string
durationSeconds integer
completionPercent integer
roomViewId string
roomActiveDurationSeconds integer
tabEntries list
documentViewsTruncated boolean
fileCount integer
data list
nextCursor string
source string
roomLinkId string
roomLinkLabel string
totalViews integer
firstSeenAt dateTime
lastSeenAt dateTime
roomId string
roomName string
enteredAt dateTime
since dateTime
affectedRoomCount integer
label string
documentCount integer
accessMode string
requireEmail boolean
isActive boolean
expiresAt dateTime
notifyOnView boolean
notifySlack boolean
allowedEmails list
allowedDomains list
room reference
primaryLink reference
companyDomain string
labelIds list
documentIds list
tabLabels
tabIds list
heightPx integer
itemIds list
fileType string
pageCount integer
thumbnailUrl reference
firstName string
lastName string
leadId string
leadName string
domain string
logoUrl reference
industry string
size string
decision string
decisionNote string
decidedAt dateTime
capturedAt dateTime
team string
teamSlug string
error string
code string
kind string
limit integer
feature string
requiredScope string
activeDurationSeconds integer

JSON-LD Document

Raw ↑ 
{
  "@context": {
    "@vocab": "https://hummingdeck.com/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "hummingdeck": "https://hummingdeck.com/schema#",
    "DocumentView": "hummingdeck:DocumentView",
    "viewId": {
      "@id": "hummingdeck:viewId",
      "@type": "xsd:string"
    },
    "shareSlug": {
      "@id": "hummingdeck:shareSlug",
      "@type": "xsd:string"
    },
    "viewerEmail": {
      "@id": "hummingdeck:viewerEmail",
      "@type": "xsd:string"
    },
    "viewerName": {
      "@id": "hummingdeck:viewerName",
      "@type": "xsd:string"
    },
    "companyName": {
      "@id": "hummingdeck:companyName",
      "@type": "xsd:string"
    },
    "deckTitle": {
      "@id": "hummingdeck:deckTitle",
      "@type": "xsd:string"
    },
    "device": {
      "@id": "hummingdeck:device",
      "@type": "xsd:string"
    },
    "location": {
      "@id": "hummingdeck:location",
      "@type": "xsd:string"
    },
    "createdAt": {
      "@id": "hummingdeck:createdAt",
      "@type": "xsd:dateTime"
    },
    "ShareLink": "hummingdeck:ShareLink",
    "id": {
      "@id": "hummingdeck:id",
      "@type": "xsd:string"
    },
    "slug": {
      "@id": "hummingdeck:slug",
      "@type": "xsd:string"
    },
    "type": {
      "@id": "hummingdeck:type",
      "@type": "xsd:string"
    },
    "recipientName": {
      "@id": "hummingdeck:recipientName",
      "@type": "xsd:string"
    },
    "recipientEmail": {
      "@id": "hummingdeck:recipientEmail",
      "@type": "xsd:string"
    },
    "contact": {
      "@id": "hummingdeck:contact"
    },
    "contactCreated": {
      "@id": "hummingdeck:contactCreated",
      "@type": "xsd:boolean"
    },
    "company": {
      "@id": "hummingdeck:company"
    },
    "companyCreated": {
      "@id": "hummingdeck:companyCreated",
      "@type": "xsd:boolean"
    },
    "shareUrl": {
      "@id": "hummingdeck:shareUrl",
      "@type": "@id"
    },
    "RoomItem": "hummingdeck:RoomItem",
    "tabId": {
      "@id": "hummingdeck:tabId",
      "@type": "xsd:string"
    },
    "position": {
      "@id": "hummingdeck:position",
      "@type": "xsd:integer"
    },
    "title": {
      "@id": "hummingdeck:title",
      "@type": "xsd:string"
    },
    "documentId": {
      "@id": "hummingdeck:documentId",
      "@type": "xsd:string"
    },
    "processingStatus": {
      "@id": "hummingdeck:processingStatus",
      "@type": "xsd:string"
    },
    "processingErrorCode": {
      "@id": "hummingdeck:processingErrorCode",
      "@type": "xsd:string"
    },
    "deliveryMode": {
      "@id": "hummingdeck:deliveryMode",
      "@type": "xsd:string"
    },
    "urlId": {
      "@id": "hummingdeck:urlId",
      "@type": "xsd:string"
    },
    "url": {
      "@id": "hummingdeck:url",
      "@type": "@id"
    },
    "embedUrl": {
      "@id": "hummingdeck:embedUrl",
      "@type": "@id"
    },
    "allowDownloads": {
      "@id": "hummingdeck:allowDownloads",
      "@type": "xsd:boolean"
    },
    "Room": "hummingdeck:Room",
    "labels": {
      "@id": "hummingdeck:labels",
      "@container": "@list"
    },
    "name": {
      "@id": "hummingdeck:name",
      "@type": "xsd:string"
    },
    "status": {
      "@id": "hummingdeck:status",
      "@type": "xsd:string"
    },
    "welcomeMessage": {
      "@id": "hummingdeck:welcomeMessage",
      "@type": "xsd:string"
    },
    "viewerLayoutMode": {
      "@id": "hummingdeck:viewerLayoutMode",
      "@type": "xsd:string"
    },
    "viewerThemeMode": {
      "@id": "hummingdeck:viewerThemeMode",
      "@type": "xsd:string"
    },
    "sender": {
      "@id": "hummingdeck:sender"
    },
    "tabs": {
      "@id": "hummingdeck:tabs",
      "@container": "@list"
    },
    "items": {
      "@id": "hummingdeck:items",
      "@container": "@list"
    },
    "links": {
      "@id": "hummingdeck:links"
    },
    "updatedAt": {
      "@id": "hummingdeck:updatedAt",
      "@type": "xsd:dateTime"
    },
    "TaskAssignee": "hummingdeck:TaskAssignee",
    "side": {
      "@id": "hummingdeck:side",
      "@type": "xsd:string"
    },
    "email": {
      "@id": "hummingdeck:email",
      "@type": "xsd:string"
    },
    "displayName": {
      "@id": "hummingdeck:displayName",
      "@type": "xsd:string"
    },
    "ActionPlanSettings": "hummingdeck:ActionPlanSettings",
    "showDueDates": {
      "@id": "hummingdeck:showDueDates",
      "@type": "xsd:boolean"
    },
    "notificationsEnabled": {
      "@id": "hummingdeck:notificationsEnabled",
      "@type": "xsd:boolean"
    },
    "recipientCompletionEnabled": {
      "@id": "hummingdeck:recipientCompletionEnabled",
      "@type": "xsd:boolean"
    },
    "targetDate": {
      "@id": "hummingdeck:targetDate",
      "@type": "xsd:date"
    },
    "ActionPlanPhase": "hummingdeck:ActionPlanPhase",
    "color": {
      "@id": "hummingdeck:color",
      "@type": "xsd:string"
    },
    "relativeDayOffset": {
      "@id": "hummingdeck:relativeDayOffset",
      "@type": "xsd:integer"
    },
    "ActionPlanTask": "hummingdeck:ActionPlanTask",
    "phaseId": {
      "@id": "hummingdeck:phaseId",
      "@type": "xsd:string"
    },
    "parentTaskId": {
      "@id": "hummingdeck:parentTaskId",
      "@type": "xsd:string"
    },
    "description": {
      "@id": "hummingdeck:description",
      "@type": "xsd:string"
    },
    "assignee": {
      "@id": "hummingdeck:assignee"
    },
    "dueDate": {
      "@id": "hummingdeck:dueDate",
      "@type": "xsd:date"
    },
    "visibility": {
      "@id": "hummingdeck:visibility",
      "@type": "xsd:string"
    },
    "completedAt": {
      "@id": "hummingdeck:completedAt",
      "@type": "xsd:dateTime"
    },
    "ActionPlanProgressCount": "hummingdeck:ActionPlanProgressCount",
    "completed": {
      "@id": "hummingdeck:completed",
      "@type": "xsd:integer"
    },
    "total": {
      "@id": "hummingdeck:total",
      "@type": "xsd:integer"
    },
    "percent": {
      "@id": "hummingdeck:percent",
      "@type": "xsd:integer"
    },
    "ActionPlan": "hummingdeck:ActionPlan",
    "plan": {
      "@id": "hummingdeck:plan",
      "@type": "@id"
    },
    "phases": {
      "@id": "hummingdeck:phases",
      "@container": "@list"
    },
    "tasks": {
      "@id": "hummingdeck:tasks",
      "@container": "@list"
    },
    "dependencies": {
      "@id": "hummingdeck:dependencies",
      "@container": "@list"
    },
    "progress": {
      "@id": "hummingdeck:progress"
    },
    "UpdateActionPlanRequest": "hummingdeck:UpdateActionPlanRequest",
    "CreatePhaseRequest": "hummingdeck:CreatePhaseRequest",
    "UpdatePhaseRequest": "hummingdeck:UpdatePhaseRequest",
    "CreateTaskRequest": "hummingdeck:CreateTaskRequest",
    "UpdateTaskRequest": "hummingdeck:UpdateTaskRequest",
    "SetTaskStatusRequest": "hummingdeck:SetTaskStatusRequest",
    "RoomAnalytics": "hummingdeck:RoomAnalytics",
    "roomVisits": {
      "@id": "hummingdeck:roomVisits",
      "@type": "xsd:integer"
    },
    "documentViews": {
      "@id": "hummingdeck:documentViews",
      "@type": "xsd:integer"
    },
    "uniqueViewers": {
      "@id": "hummingdeck:uniqueViewers",
      "@type": "xsd:integer"
    },
    "averageSecondsInRoom": {
      "@id": "hummingdeck:averageSecondsInRoom",
      "@type": "xsd:integer"
    },
    "documentsOpened": {
      "@id": "hummingdeck:documentsOpened",
      "@type": "xsd:integer"
    },
    "documentsTotal": {
      "@id": "hummingdeck:documentsTotal",
      "@type": "xsd:integer"
    },
    "averageCompletionPercent": {
      "@id": "hummingdeck:averageCompletionPercent",
      "@type": "xsd:integer"
    },
    "RoomActivityEntry": "hummingdeck:RoomActivityEntry",
    "occurredAt": {
      "@id": "hummingdeck:occurredAt",
      "@type": "xsd:dateTime"
    },
    "actorName": {
      "@id": "hummingdeck:actorName",
      "@type": "xsd:string"
    },
    "actorEmail": {
      "@id": "hummingdeck:actorEmail",
      "@type": "xsd:string"
    },
    "contactId": {
      "@id": "hummingdeck:contactId",
      "@type": "xsd:string"
    },
    "companyId": {
      "@id": "hummingdeck:companyId",
      "@type": "xsd:string"
    },
    "documentTitle": {
      "@id": "hummingdeck:documentTitle",
      "@type": "xsd:string"
    },
    "taskTitle": {
      "@id": "hummingdeck:taskTitle",
      "@type": "xsd:string"
    },
    "roomItemId": {
      "@id": "hummingdeck:roomItemId",
      "@type": "xsd:string"
    },
    "durationSeconds": {
      "@id": "hummingdeck:durationSeconds",
      "@type": "xsd:integer"
    },
    "completionPercent": {
      "@id": "hummingdeck:completionPercent",
      "@type": "xsd:integer"
    },
    "roomViewId": {
      "@id": "hummingdeck:roomViewId",
      "@type": "xsd:string"
    },
    "roomActiveDurationSeconds": {
      "@id": "hummingdeck:roomActiveDurationSeconds",
      "@type": "xsd:integer"
    },
    "tabEntries": {
      "@id": "hummingdeck:tabEntries",
      "@container": "@list"
    },
    "documentViewsTruncated": {
      "@id": "hummingdeck:documentViewsTruncated",
      "@type": "xsd:boolean"
    },
    "fileCount": {
      "@id": "hummingdeck:fileCount",
      "@type": "xsd:integer"
    },
    "RoomActivityList": "hummingdeck:RoomActivityList",
    "data": {
      "@id": "hummingdeck:data",
      "@container": "@list"
    },
    "nextCursor": {
      "@id": "hummingdeck:nextCursor",
      "@type": "xsd:string"
    },
    "RoomCapturedEmail": "hummingdeck:RoomCapturedEmail",
    "source": {
      "@id": "hummingdeck:source",
      "@type": "xsd:string"
    },
    "roomLinkId": {
      "@id": "hummingdeck:roomLinkId",
      "@type": "xsd:string"
    },
    "roomLinkLabel": {
      "@id": "hummingdeck:roomLinkLabel",
      "@type": "xsd:string"
    },
    "totalViews": {
      "@id": "hummingdeck:totalViews",
      "@type": "xsd:integer"
    },
    "firstSeenAt": {
      "@id": "hummingdeck:firstSeenAt",
      "@type": "xsd:dateTime"
    },
    "lastSeenAt": {
      "@id": "hummingdeck:lastSeenAt",
      "@type": "xsd:dateTime"
    },
    "RoomCapturedEmailList": "hummingdeck:RoomCapturedEmailList",
    "RoomView": "hummingdeck:RoomView",
    "roomId": {
      "@id": "hummingdeck:roomId",
      "@type": "xsd:string"
    },
    "roomName": {
      "@id": "hummingdeck:roomName",
      "@type": "xsd:string"
    },
    "enteredAt": {
      "@id": "hummingdeck:enteredAt",
      "@type": "xsd:dateTime"
    },
    "RoomViewList": "hummingdeck:RoomViewList",
    "since": {
      "@id": "hummingdeck:since",
      "@type": "xsd:dateTime"
    },
    "RoomLabel": "hummingdeck:RoomLabel",
    "RoomLabelList": "hummingdeck:RoomLabelList",
    "RoomLabelRef": "hummingdeck:RoomLabelRef",
    "CreateRoomLabelRequest": "hummingdeck:CreateRoomLabelRequest",
    "UpdateRoomLabelRequest": "hummingdeck:UpdateRoomLabelRequest",
    "DeleteRoomLabelResult": "hummingdeck:DeleteRoomLabelResult",
    "affectedRoomCount": {
      "@id": "hummingdeck:affectedRoomCount",
      "@type": "xsd:integer"
    },
    "RoomTab": "hummingdeck:RoomTab",
    "label": {
      "@id": "hummingdeck:label",
      "@type": "xsd:string"
    },
    "RoomSummary": "hummingdeck:RoomSummary",
    "documentCount": {
      "@id": "hummingdeck:documentCount",
      "@type": "xsd:integer"
    },
    "RoomList": "hummingdeck:RoomList",
    "RoomLinksList": "hummingdeck:RoomLinksList",
    "PrimaryRoomLink": "hummingdeck:PrimaryRoomLink",
    "accessMode": {
      "@id": "hummingdeck:accessMode",
      "@type": "xsd:string"
    },
    "requireEmail": {
      "@id": "hummingdeck:requireEmail",
      "@type": "xsd:boolean"
    },
    "isActive": {
      "@id": "hummingdeck:isActive",
      "@type": "xsd:boolean"
    },
    "expiresAt": {
      "@id": "hummingdeck:expiresAt",
      "@type": "xsd:dateTime"
    },
    "notifyOnView": {
      "@id": "hummingdeck:notifyOnView",
      "@type": "xsd:boolean"
    },
    "notifySlack": {
      "@id": "hummingdeck:notifySlack",
      "@type": "xsd:boolean"
    },
    "allowedEmails": {
      "@id": "hummingdeck:allowedEmails",
      "@container": "@list"
    },
    "allowedDomains": {
      "@id": "hummingdeck:allowedDomains",
      "@container": "@list"
    },
    "CreatedRoom": "hummingdeck:CreatedRoom",
    "room": {
      "@id": "hummingdeck:room",
      "@type": "@id"
    },
    "primaryLink": {
      "@id": "hummingdeck:primaryLink",
      "@type": "@id"
    },
    "PrimaryLinkRequest": "hummingdeck:PrimaryLinkRequest",
    "CreateRoomLinkRequest": "hummingdeck:CreateRoomLinkRequest",
    "companyDomain": {
      "@id": "hummingdeck:companyDomain",
      "@type": "xsd:string"
    },
    "UpdateRoomLinkRequest": "hummingdeck:UpdateRoomLinkRequest",
    "RoomSenderRequest": "hummingdeck:RoomSenderRequest",
    "CreateRoomRequest": "hummingdeck:CreateRoomRequest",
    "labelIds": {
      "@id": "hummingdeck:labelIds",
      "@container": "@list"
    },
    "documentIds": {
      "@id": "hummingdeck:documentIds",
      "@container": "@list"
    },
    "tabLabels": {
      "@id": "hummingdeck:tabLabels"
    },
    "UpdateRoomRequest": "hummingdeck:UpdateRoomRequest",
    "CreateRoomTabRequest": "hummingdeck:CreateRoomTabRequest",
    "RenameRoomTabRequest": "hummingdeck:RenameRoomTabRequest",
    "ReorderRoomTabsRequest": "hummingdeck:ReorderRoomTabsRequest",
    "tabIds": {
      "@id": "hummingdeck:tabIds",
      "@container": "@list"
    },
    "AddRoomSectionRequest": "hummingdeck:AddRoomSectionRequest",
    "AddRoomDocumentRequest": "hummingdeck:AddRoomDocumentRequest",
    "AddRoomUrlRequest": "hummingdeck:AddRoomUrlRequest",
    "AddRoomEmbedRequest": "hummingdeck:AddRoomEmbedRequest",
    "heightPx": {
      "@id": "hummingdeck:heightPx",
      "@type": "xsd:integer"
    },
    "MoveRoomItemRequest": "hummingdeck:MoveRoomItemRequest",
    "ReorderRoomItemsRequest": "hummingdeck:ReorderRoomItemsRequest",
    "itemIds": {
      "@id": "hummingdeck:itemIds",
      "@container": "@list"
    },
    "Document": "hummingdeck:Document",
    "fileType": {
      "@id": "hummingdeck:fileType",
      "@type": "xsd:string"
    },
    "pageCount": {
      "@id": "hummingdeck:pageCount",
      "@type": "xsd:integer"
    },
    "thumbnailUrl": {
      "@id": "hummingdeck:thumbnailUrl",
      "@type": "@id"
    },
    "UploadedDocument": "hummingdeck:UploadedDocument",
    "Contact": "hummingdeck:Contact",
    "firstName": {
      "@id": "hummingdeck:firstName",
      "@type": "xsd:string"
    },
    "lastName": {
      "@id": "hummingdeck:lastName",
      "@type": "xsd:string"
    },
    "leadId": {
      "@id": "hummingdeck:leadId",
      "@type": "xsd:string"
    },
    "leadName": {
      "@id": "hummingdeck:leadName",
      "@type": "xsd:string"
    },
    "Company": "hummingdeck:Company",
    "domain": {
      "@id": "hummingdeck:domain",
      "@type": "xsd:string"
    },
    "logoUrl": {
      "@id": "hummingdeck:logoUrl",
      "@type": "@id"
    },
    "industry": {
      "@id": "hummingdeck:industry",
      "@type": "xsd:string"
    },
    "size": {
      "@id": "hummingdeck:size",
      "@type": "xsd:string"
    },
    "Decision": "hummingdeck:Decision",
    "decision": {
      "@id": "hummingdeck:decision",
      "@type": "xsd:string"
    },
    "decisionNote": {
      "@id": "hummingdeck:decisionNote",
      "@type": "xsd:string"
    },
    "decidedAt": {
      "@id": "hummingdeck:decidedAt",
      "@type": "xsd:dateTime"
    },
    "EmailCapture": "hummingdeck:EmailCapture",
    "capturedAt": {
      "@id": "hummingdeck:capturedAt",
      "@type": "xsd:dateTime"
    },
    "WebhookSubscription": "hummingdeck:WebhookSubscription",
    "UserProfile": "hummingdeck:UserProfile",
    "team": {
      "@id": "hummingdeck:team",
      "@type": "xsd:string"
    },
    "teamSlug": {
      "@id": "hummingdeck:teamSlug",
      "@type": "xsd:string"
    },
    "Error": "hummingdeck:Error",
    "error": {
      "@id": "hummingdeck:error",
      "@type": "xsd:string"
    },
    "code": {
      "@id": "hummingdeck:code",
      "@type": "xsd:string"
    },
    "kind": {
      "@id": "hummingdeck:kind",
      "@type": "xsd:string"
    },
    "limit": {
      "@id": "hummingdeck:limit",
      "@type": "xsd:integer"
    },
    "feature": {
      "@id": "hummingdeck:feature",
      "@type": "xsd:string"
    },
    "requiredScope": {
      "@id": "hummingdeck:requiredScope",
      "@type": "xsd:string"
    },
    "RoomCompanyReference": "hummingdeck:RoomCompanyReference",
    "RoomContactReference": "hummingdeck:RoomContactReference",
    "RoomTabActivityEntry": "hummingdeck:RoomTabActivityEntry",
    "activeDurationSeconds": {
      "@id": "hummingdeck:activeDurationSeconds",
      "@type": "xsd:integer"
    },
    "RoomDocumentActivityEntry": "hummingdeck:RoomDocumentActivityEntry"
  },
  "@type": "schema:Dataset",
  "schema:name": "HummingDeck API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects HummingDeck's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-10-24) from openapi/hummingdeck-openapi.json.",
  "dcterms:created": "2026-10-24",
  "dcterms:source": [
    "openapi/hummingdeck-openapi.json"
  ]
}