Content

Document Created

When a document is successfully created.

json

{
  "eventType": "content.document.documentCreated",
  "documentId": string,
  "product": "lucidchart" | "lucidscale" | "lucidspark"
}

Document Opened

When a document is opened. The documentOpenedMethod describes whether it was opened in the app, externally (for example, in an embedded viewer), or through a device integration. Unknown is used when the method is not recognized.

json

{
  "eventType": "content.document.documentOpened",
  "documentId": string,
  "product": "lucidchart" | "lucidscale" | "lucidspark",
  "documentOpenedMethod": {
    "MethodType": "InApp"
  } | {
    "MethodType": "External"
  } | {
    "MethodType": "InDevice",
    "ClientId": string,
    "AppName": string,
    "DeviceId": string | null
  } | {
    "MethodType": "Unknown"
  }
}

Documents Trashed

When a document or multiple documents are placed in the trash folder.

json

{
  "eventType": "content.document.documentsTrashed",
  "documentIds": List[string]
}

Document Deleted

When a document is permanently deleted (i.e., when a user deletes a document from the trash).

json

{
  "eventType": "content.document.documentDeleted",
  "documentId": string
}

Document Duplicated

When a document is duplicated.

json

{
  "eventType": "content.document.documentDuplicated",
  "originalDocumentId": string,
  "newDocumentId": string
}

Document Restoration

When a document is restored by an admin.

json

{
  "eventType": "content.document.documentRestoration",
  "documentId": string
}

Document Folder Entrypoint Updated

When documents are moved to a different folder.

json

{
  "eventType": "content.document.documentFolderEntrypointUpdated",
  "documentIds": List[string],
  "destinationFolderId": number,
  "destinationFolderName": string,
  "isTeamFolder": boolean
}

Update Collaborator Role

When an individual contributor’s role is changed on a document or folder. This includes when a user is added (e.g., via email, share link, Slack, join ID) or removed from a document/folder.

json

{
  "eventType": "content.document.updateCollaboratorRole",
  "role": "comment" | "edit" | "editandshare" | "none" | "view"
}

Remove Collaborator

When a collaborator is removed from a document/folder.

json

{
  "eventType": "content.document.removeCollaborator"
}

Document Downloaded

When a document is downloaded or exported. The method field is download for a download, google-drive for an export to Google Drive, or unknown when the method is unrecognized.

json

{
  "eventType": "content.document.documentDownloaded",
  "documentId": string,
  "product": "lucidchart" | "lucidscale" | "lucidspark",
  "format": "bpmn" | "csv" | "dpi" | "gif" | "image" | "jpeg" | "pdf" | "png" | "png32" | "slides-to-pdf" | "svg" | "svg+xml" | "svg-transparent" | "unknown" | "vdx" | "vsdx",
  "method": "download" | "google-drive" | "unknown"
}

Document Uploaded

When a user uploads a form of document as a Lucid document (Visio, Gliffy, pdf, etc.).

json

{
  "eventType": "content.document.documentUploaded",
  "documentId": string,
  "product": "lucidchart" | "lucidscale" | "lucidspark",
  "source": string,
  "filename": string
}

Update Published Document Password

When a user adds a password requirement to a published document.

json

{
  "eventType": "content.document.updatePublishedDocumentPassword"
}

Remove Published Document Password

When a user removes the password requirement on a published document.

json

{
  "eventType": "content.document.removePublishedDocumentPassword"
}

Create Publish Link

When a publish link is created for a document.

json

{
  "eventType": "content.document.createPublishLink",
  "publishedLink": {
    "name": "area selection" | "full document" | "single page" | "unknown",
    "link": string,
    "format": string
  }
}

Remove Publish Link

When a user removes a publish link for a document.

json

{
  "eventType": "content.document.removePublishLink",
  "publishedLink": {
    "name": "area selection" | "full document" | "single page" | "unknown",
    "link": string,
    "format": string
  }
}

Set Embedded

When the embedded attribute on a document is turned on or off.

json

{
  "eventType": "content.document.setEmbedded",
  "embedded": boolean
}

Update Share Link Settings

When the share link settings for a document is changed.

json

{
  "eventType": "content.document.updateShareLinkSettings",
  "shareLinkEnabled": boolean,
  "restrictedToAccount": boolean,
  "role": "comment" | "edit" | "editandshare" | "none" | "view"
}

Toggle Join ID

When Join ID is turned on or off for a document.

json

{
  "eventType": "content.document.toggleJoinId",
  "documentId": string,
  "joinIdEnabled": boolean,
  "joinId": string
}

Generate Document Access Pin

When a user generates a document support PIN to give a Lucid support agent access to view a document.

json

{
  "eventType": "content.document.generateDocumentAccessPin",
  "documentId": string,
  "expiration": timestamp
}

Document Classification Changed

When the classification of a document is changed, including changes made by a user and the automatic assignment of the default classification when a document is created.

json

{
  "eventType": "content.document.documentClassificationChanged",
  "documentId": string,
  "method": "NewlyCreatedDocument" | "Unknown" | "User",
  "oldClassification": string | null,
  "newClassification": string | null
}

Bulk Document Export

When a bulk document export job is created.

json

{
  "eventType": "content.document.bulkDocumentExport",
  "bulkExportName": string,
  "jobId": string,
  "format": string
}

Folder Created

When a folder is created.

json

{
  "eventType": "content.folder.folderCreated",
  "folderId": number,
  "folderName": string
}

Repository Created

When a repository is created.

json

{
  "eventType": "content.folder.repositoryCreated",
  "repositoryId": number,
  "repositoryName": string,
  "repositoryAccessType": string
}

Repository Access Type Changed

When the access type of a repository changes.

json

{
  "eventType": "content.folder.repositoryAccessTypeChanged",
  "userRole": string,
  "previousAccessType": string,
  "newAccessType": string
}

Moved Asset

When an asset or document is imported into, moved within, transferred between, or moved out of repositories, or when an asset is archived or unarchived.

json

{
  "eventType": "content.asset.movedAsset",
  "action": string,
  "userRole": string,
  "source": string,
  "sourceRepositoryAccessType": string,
  "destination": string,
  "destinationRepositoryAccessType": string,
  "itemType": string
}

Changed Approval Status

When the approval status of a repository asset changes.

json

{
  "eventType": "content.asset.changedApprovalStatus",
  "approvalStatus": string,
  "userRole": string,
  "repositoryAccessType": string
}