Event Reporting - Event Reference
Event Reporting is documented with the Smartsheet API. The list below includes all currently supported events. It includes the objectType
, action
, and additionalDetails
properties for each event. This list will constantly grow as new events are introduced to cover new functionalities in Smartsheet.
Each heading below describes a distinct event type, listed as <Object type> - <Action>.
NOTE: Event Reporting is supported for both Smartsheet Commercial and Smartsheet Gov.
Access Token
ACCESS_TOKEN - AUTHORIZE
Triggered when an access token creation is authorized by a user.
additionalDetails
:tokenName
: Name of the newly created access token. (Only included in cases when a name was given to the token)tokenDisplayValue
: 4 or more characters used as a mnemonic to represent this access token. Even though this value serves as a visual token differentiator, this value isn’t an Id because it isn’t guaranteed to be unique across all tokens. This value is the same displayed by Smartsheet UI for each access token listed under Apps & Integrations > API Access.tokenExpirationTimestamp
: Date and time when this access token expires.accessScopes
: Comma-delimited list of access scopes granted to this access token. The full list of available scopes can be seen hereappClientId
: The client Id of the app to which this access token was granted. (Only included in cases when the access token was generated for an app)appName
: The name of the app to which this access token was granted. (Only included in cases when the access token was generated for an app)
ACCESS_TOKEN - REFRESH
Triggered when an access token is refreshed. See here for more information about access token refresh.
additionalDetails
:tokenDisplayValue
: 4 or more characters used as a mnemonic to represent this access token. Even though this value serves as a visual token differentiator, this value isn’t an Id because it isn’t guaranteed to be unique across all tokens. This value is the same displayed by Smartsheet UI for each access token listed under Apps & Integrations > API Access.tokenExpirationTimestamp
: Date and time when this access token expires.
ACCESS_TOKEN - REVOKE
Triggered when an access token is revoked.
additionalDetails
:tokenDisplayValue
: 4 or more characters used as a mnemonic to represent this access token. Even though this value serves as a visual token differentiator, this value isn’t an Id because it isn’t guaranteed to be unique across all tokens. This value is the same displayed by Smartsheet UI for each access token listed under Apps & Integrations > API Access.tokenUserId
: Id of the user who owns this token.
Account
ACCOUNT - BULK_UPDATE
Triggered when an admin bulk updates users. This can be done through User Management
console on UI.
additionalDetails
: (none)
ACCOUNT - DOWNLOAD_SHEET_ACCESS_REPORT
Triggered when an admin downloads sheet access report for an organization account. This can be done through User Management
console on UI.
additionalDetails
: (none)
ACCOUNT - DOWNLOAD_USER_LIST
Triggered when an admin downloads user list report for an organization account. This can be done through User Management
console on UI.
additionalDetails
: (none)
ACCOUNT - DOWNLOAD_LOGIN_HISTORY
Triggered when an admin downloads login history report for the users. This can be done through Login History
console on UI.
additionalDetails
: (none)
ACCOUNT - DOWNLOAD_PUBLISHED_ITEMS_REPORT
Triggered when an admin downloads published items report. This can be done through User Management
console on UI.
additionalDetails
: (none)
ACCOUNT - IMPORT_USERS
Triggered when an admin imports users through a CSV file. This can be done through User Administration
console on UI.
additionalDetails
: (none)
ACCOUNT - LIST_SHEETS
Triggered when a summarized list of all sheets owned by the members of the organization account is generated. This can be done through API.
additionalDetails
: (none)
ACCOUNT - RENAME
Triggered when the organization account is renamed. This can be done through Account Administration
console on UI.
additionalDetails
:newName
: New name of the organization accountoldName
: Previous name of the organization account
ACCOUNT - UPDATE_MAIN_CONTACT
Triggered when the main contact of the organization account is updated. This can be done through Account Administration
console on UI.
additionalDetails
:newContactUserId
: Id of the new main contactoldContactUserId
: Id of the former main contact
Attachment
ATTACHMENT - CREATE
Triggered when an attachment is created (i.e. uploaded) in a sheet, in a sheet row, or in a workspace.
additionalDetails
:sheetId
: Id of the sheet that contains the attachment. (This property is included only if theworkspaceId
property below isn’t included)workspaceId
: Id of the workspace that directly contains the attachment. (This property is included only if thesheetId
property above isn’t included)attachmentName
: Name of the attachment.
ATTACHMENT - UPDATE
Triggered when an existing attachment is updated (e.g. its description changed).
additionalDetails
:sheetId
: Id of the sheet that contains the attachment. (This property is included only if theworkspaceId
property below isn’t included)workspaceId
: Id of the workspace that directly contains the attachment. (This property is included only if thesheetId
property above isn’t included)
ATTACHMENT - LOAD
Triggered when an attachment is loaded (i.e. viewed or downloaded).
additionalDetails
:sheetId
: Id of the sheet that contains the attachment. (This property is included only if theworkspaceId
property below isn’t included)workspaceId
: Id of the workspace that directly contains the attachment. (This property is included only if thesheetId
property above isn’t included)multiFileDownloadName
: name of the compressed file containing the multiple attachments downloaded at once. (Only included if more than one attachment was selected to be downloaded in the same user action. Please notice that multi-attachment download action allows the user to specify the name of the zip file that shoud include all attachments, which is what is being provided here. The download of a single attachment uses the attachment name as the download file name and it cannot be changed, and it isn’t provided in this event because it is provided in the ATTACHMENT-CREATE event or by querying Smartsheet API with the attachment ID)
ATTACHMENT - DELETE
Triggered when an attachment is deleted.
additionalDetails
:sheetId
: Id of the sheet that contains the attachment. (This property is included only if theworkspaceId
property below isn’t included)workspaceId
: Id of the workspace that directly contains the attachment. (This property is included only if thesheetId
property above isn’t included)
ATTACHMENT - SEND
Triggered when an attachment is directly (i.e. instead of indirectly as part of another operation) sent by email to user(s) or user group(s). An individual ATTACHMENT - SEND event is issued for each user or user group listed as recipient.
additionalDetails
:recipientEmail
: Single email address either of a user explicitly included in the recipient list or of the sender (when CC sender is requested), e.g. “[email protected]”. (This property is included only if the recipientGroupId property below isn’t included)recipientGroupId
: Single ID of a user group explicitly included in the recipient list, e.g."345987624123"
. (This property is included only if therecipientEmail
property above isn’t included)sheetId
: Id of the sheet that contains the attachment. (This property is included only if theworkspaceId
property below isn’t included)workspaceId
: Id of the workspace that directly contains the attachment. (This property is included only if thesheetId
property above isn’t included)
Dashboard
DASHBOARD - CREATE
Triggered when a dashboard is created. Dashboards can be created in the UI with the Create New
button, by selecting the Save As New
option on an existing dashboard, or through the API.
additionalDetails
:dashboardName
: Name of the newly created dashboardsourceGlobalTemplateId
: Id of the global template that was used to create the dashboard. (Specific toCreate New
actions)sourceObjectId
: Id of the source dashboard. (Specific toSave As New
actions)sourceType
: The source object used to create the dashboard, currently only ‘global_template’ is valid
DASHBOARD - DELETE
Triggered when a dashboard is deleted.
additionalDetails
: (none)
DASHBOARD - LOAD
Triggered when a dashboard is viewed in the UI or loaded through the API.
additionalDetails
: (none)
DASHBOARD - ADD_PUBLISH
Triggered when a user publishes a dashboard or republishes a dashboard with new settings.
additionalDetails
:accessibleBy
: Indicates who can use the link to view the dashboard:"ALL"
(accessible to any person with the link),"ORG"
(accessible only by those belonging to the org).publishType
: Indicates permissions granted to users with a valid link. All dashboard publishes are read only:"read_only"
.publishFormat
: Indicates format of the published dashboard. Dashboards are published in a rich media format:"FULL"
,
DASHBOARD - REMOVE_PUBLISH
Triggered when a user disables publish option for a dashboard.
additionalDetails
: (none)
DASHBOARD - ADD_SHARE
Triggered when a group or user is added to the dashboard’s sharing list, or when a group or user’s share permissions are changed.
additionalDetails
:accessLevel
: Indicates the access level granted to the group or user:"VIEWER"
,"EDITOR"
,"EDITOR_SHARE"
, or"ADMIN"
. Note that this access level represents the access level granted by this specific sharing action; it is not the group or user’s effective access level for the sheet.userId
: Id of the user that was added to the dashboard’s sharing list. (Specific to share to user actions)groupId
: Id of the group that was added to the dashboard’s sharing list. (Specific to share to group actions)
</details>
DASHBOARD - REMOVE_SHARE
Triggered when a group or user is removed from a dashboard’s sharing list.
additionalDetails
:userId
: Id of the user that was removed from the dashboard’s sharing list. (Specific to remove share from user actions)groupId
: Id of the group that was removed from the dashboard’s sharing list. (Specific to remove share from group actions)
DASHBOARD - ADD_SHARE_MEMBER
Triggered when a user is added to a group that a dashboard has been shared to via the dashboard’s sharing list, or via a workspace’s sharing list. If a dashboard has been shared to a group directly via the dashboard’s sharing list, and via a workspace’s sharing list, then an event will be generated for each of these shares.
additionalDetails
:accessLevel
: Indicates the access level granted to the user:"VIEWER"
,"EDITOR"
,"EDITOR_SHARE"
, or"ADMIN"
. Note that this access level represents the access level that has been granted to the user via group membership; it is not the user’s effective access level for the dashboard.groupId
: Id of the group the user was added to.userId
: Id of the user that was added to the group.workspaceId
: Id of the workspace that the group is shared to. (Specific to cases where the dashboard is shared to the group via a workspace’s sharing list)
DASHBOARD - REMOVE_SHARE_MEMBER
Triggered when a user is removed from a group that a dashboard has been shared to via the dashboard’s sharing list, or via a workspace’s sharing list. If a dashboard has been shared to a group directly via the dashboard’s sharing list, and via a workspace’s sharing list, then an event will be generated for each of these shares.
additionalDetails
:groupId
: Id of the group that the user was removed from.userId
: Id of user that was removed from the group.workspaceId
: Id of the workspace that the group is shared to. (Specific to cases where the dashboard is shared to the group via a workspace’s sharing list)
DASHBOARD - ADD_WORKSPACE_SHARE
Triggered when a group or user is added to a workspace’s sharing list. Note that this event will appear for each dashboard that is in the workspace. If a group or user is added to a workspace’s sharing list and the workspace is empty, then no events will be recorded.
additionalDetails
:accessLevel
: Indicates the access level granted to the group or user:"VIEWER"
,"EDITOR"
,"EDITOR_SHARE"
, or"ADMIN"
. Note that this access level represents the access level granted by this specific sharing action; it is not the group or user’s effective access level for the dashboard.userId
: Id of the user that the workspace was shared to. (Specific to share to user actions)groupId
: Id of the group that the workspace was shared to. (Specific to share to group actions)workspaceId
: Id of the workspace that was shared to the group or user.
DASHBOARD - REMOVE_WORKSPACE_SHARE
Triggered when a group or user is removed from a workspace’s sharing list. Note that this event will appear for each dashboard that is in the workspace. If a group or user is removed from a workspace’s sharing list and the workspace is empty, then no events will be recorded.
additionalDetails
:userId
: Id of the user that was removed from the workspace. (Specific to remove share from user actions)groupId
: Id of the group that was removed from the workspace. (Specific to remove share from group actions)workspaceId
: Id of the workspace the group or user was removed from.
DASHBOARD - TRANSFER_OWNERSHIP
Triggered when the ownership of a dashboard is transferred.
additionalDetails
:oldUserId
: Id of the former dashboard owner.oldAccessLevel
: New access level of the former owner:"ADMIN"
.newUserId
: Id of the new dashboard owner.newAccessLevel
: New access level of the new owner:"OWNER"
.
DASHBOARD - MOVE
Triggered when a dashboard is moved between workspaces and/or folders.
additionalDetails
:newParentContainerId
: Id of the destination folder for the move event. (Specific to actions where the dashboard was moved to a different folder).parentContainerId
: Id of the parent container of the dashboard. (Specific to move events where a folder containing the dashboard is moved to a folder in a different workspace, indicates that the dashboard has moved to a new workspace but is still within the same folder)folderName
: name of the destination folder for the move event. (Specific to actions where the dashboard was moved to a different folder).workspaceId
: Id of the workspace the dashboard is currently in. If the move was between two workspaces theworkspaceId
will be the Id of the destination workspace.
DASHBOARD - PURGE
Triggered when a dashboard is deleted from the deleted items bin.
additionalDetails
: (none)
DASHBOARD - RENAME
Triggered when a dashboard is renamed in the UI or via the API (update).
additionalDetails
:oldName
: Old name of the dashboard.newName
: New name of the dashboard.
DASHBOARD - RESTORE
Triggered when a dashboard is in the deleted items bin and is restored (Undelete
).
additionalDetails
: (none)
DASHBOARD - SAVE_AS_NEW
Triggered when a user saves a copy of a dashboard by using the Save As New
option. This event is recorded for the original dashboard.
If the original dashboard belongs to a different organization, then Save As New
event will be generated for the organization with original dashboard and for the organization with copied dashboard.
For copied dashboard, Save As New
event is paired with a DASHBOARD - CREATE
event.
additionalDetails
: (none)
DASHBOARD - UPDATE
Triggered when a change is made to a dashboard and the dashboard is saved.
additionalDetails
: (none)
Discussion
DISCUSSION - CREATE
Triggered when a row-level, grid-level, or workspace-level comment is added.
additionalDetails
:sheetRowId
: Id of the sheet row containing the discussion. (this property is included only if the discussion is on a sheet row)sheetId
: Id of the sheet the discussion is on. (This property is included only if theworkspaceId
property below isn’t included)workspaceId
: Id of the workspace the discussion is directly on. (This property is included only if thesheetId
property above isn’t included)
DISCUSSION - DELETE
Triggered when a comment that has no replies is deleted.
additionalDetails
:sheetRowId
: Id of the sheet row containing the discussion. (this property is included only if the discussion is on a sheet row)sheetId
: Id of the sheet the discussion is on. (This property is included only if theworkspaceId
property below isn’t included)workspaceId
: Id of the workspace the discussion is directly on. (This property is included only if thesheetId
property above isn’t included)
DISCUSSION - UPDATE
Triggered when a reply is made to a comment, or a reply is deleted from a comment.
additionalDetails
:sheetRowId
: Id of the sheet row containing the discussion. (this property is included only if the discussion is on a sheet row)sheetId
: Id of the sheet the discussion is on. (This property is included only if theworkspaceId
property below isn’t included)workspaceId
: Id of the workspace the discussion is directly on. (This property is included only if thesheetId
property above isn’t included)
DISCUSSION - SEND
Triggered when a discussion (i.e. whole thread of top comment and replies) is directly (i.e. instead of indirectly as part of another operation) sent by email to user(s) or user group(s). An individual DISCUSSION - SEND event is issued for each user or user group listed as recipient.
additionalDetails
:recipientEmail
: Single email address either of a user explicitly included in the recipient list or of the sender (when CC sender is requested), e.g. “[email protected]”. (This property is included only if the recipientGroupId property below isn’t included)recipientGroupId
: Single ID of a user group explicitly included in the recipient list, e.g."345987624123"
. (This property is included only if therecipientEmail
property above isn’t included)sheetRowId
: Id of the sheet row containing the discussion. (this property is included only if the discussion is on a sheet row)sheetId
: Id of the sheet the discussion is on. (This property is included only if theworkspaceId
property below isn’t included)workspaceId
: Id of the workspace the discussion is directly on. (This property is included only if thesheetId
property above isn’t included)includeAttachments
: Indicates whether the discussion was sent with its respective attachments:"true"
or"false"
.
DISCUSSION - SEND_COMMENT
Triggered when a discussion comment (or discussion comment reply) is directly (i.e. instead of indirectly as part of another operation) sent by email to user(s) or user group(s). An individual DISCUSSION - SEND_COMMENT event is issued for each user or user group listed as recipient.
additionalDetails
:recipientEmail
: Single email address either of a user explicitly included in the recipient list or of the sender (when CC sender is requested), e.g. “[email protected]”. (This property is included only if the recipientGroupId property below isn’t included)recipientGroupId
: Single ID of a user group explicitly included in the recipient list, e.g."345987624123"
. (This property is included only if therecipientEmail
property above isn’t included)commentId
: Id of the comment.sheetRowId
: Id of the sheet row containing the discussion. (this property is included only if the discussion is on a sheet row)sheetId
: Id of the sheet the discussion is on. (This property is included only if theworkspaceId
property below isn’t included)workspaceId
: Id of the workspace the discussion is directly on. (This property is included only if thesheetId
property above isn’t included)includeAttachments
: Indicates whether the discussion comment (or discussion comment reply) was sent with its respective attachments:"true"
or"false"
.
Folder
FOLDER - CREATE
Triggered when a folder is created. Folders can be created in the UI with the Create New
button, by selecting the Save As New
option on an existing folder, or through the API.
additionalDetails
:folderName
: Name of the folder.sourceFolderId
: Id of folder that was copied to create the new folder. (Only included if the folder was created as a result of a save as new or copy)
FOLDER - RENAME
Triggered when a folder is renamed in the UI or via the API (update).
additionalDetails
:oldName
: Old name of the folder.newName
: New name of the folder.
FOLDER - SAVE_AS_NEW
Triggered when a user saves a copy of a folder by using the Save As New
option via UI or Copy Folder
via API. This event is recorded for the original folder. Each Save As New
event is paired with a FOLDER - CREATE
event that is recorded for the copy of the folder.
additionalDetails
: (none)
FOLDER - DELETE
Triggered when a folder is deleted.
additionalDetails
: (none)
FOLDER - REQUEST_BACKUP
Triggered when a user requests a backup for a folder.
additionalDetails
:includeAttachments
: Indicates whether attachments should be included in the recurring backup:"true"
or"false"
.sendCompletionEmail
: Indicates whether an email should be sent to the workspace’s owner every time a recurring backup completes:"true"
or"false"
.
FOLDER - EXPORT
Triggered when a user exports the folder.
additionalDetails
:formatType
: The format that the folder was exported (“excel” or “pdf”). Notice that the same value “excel” is displayed either when exporting to Microsoft Excel or when exporting to Google Sheets.
Form
FORM - CREATE
Triggered when a sheet form is created.
additionalDetails
:formName
: Name of the form.sheetId
: Id of the form’s sheet.
FORM - UPDATE
Triggered when an existing sheet form is updated.
additionalDetails
:sheetId
: Id of the form’s sheet.
FORM - DEACTIVATE
Triggered when a sheet form is deactivated.
additionalDetails
:sheetId
: Id of the form’s sheet.
FORM - ACTIVATE
Triggered when a sheet form is activated.
additionalDetails
:sheetId
: Id of the form’s sheet.
FORM - DELETE
Triggered when a sheet form is deleted.
additionalDetails
:sheetId
: Id of the form’s sheet.
Group
GROUP - CREATE
Triggered when a group is created.
additionalDetails
:groupName
: Name of the group.
GROUP - DOWNLOAD_SHEET_ACCESS_REPORT
Triggered when an admin downloads sheet access report for a group. This can be done through Group Management
console on UI.
additionalDetails
: (none)
GROUP - RENAME
Triggered when a group name is updated.
additionalDetails
:oldName
: Old name of the group.newName
: New name of the group.
GROUP - UPDATE
Triggered when a group description is updated.
additionalDetails
: (none)
GROUP - DELETE
Triggered when a group is deleted.
additionalDetails
: (none)
GROUP - TRANSFER_OWNERSHIP
Triggered when a group ownership is transferred.
additionalDetails
:oldOwnerUserId
: Id of the former group owner.newOwnerUserId
: Id of the new group owner.
GROUP - ADD_MEMBER
Triggered when a member is added to a group.
additionalDetails
:memberUserId
: Id of the user that was added to the group.
GROUP - REMOVE_MEMBER
Triggered when a member is removed from a group.
additionalDetails
:memberUserId
: Id of the user that was removed from the group.
Sheet
SHEET - CREATE
Triggered when a sheet is created (inserted).
additionalDetails
:sourceObjectId
: Id of sheet that was copied to create the new sheet. (Only included if the sheet was created as a result of a copy or save as new)sourceGlobalTemplateId
: Id of the global template that was used to create the new sheet (Only included if the sheet was created using a global template)sourceTemplateId
: Id of the template used to create the sheet. (Only included if the sheet was created using a template, that is not a global template)sourceType
: Type of object used to create the new sheet. Either “sheet”, “template”, “globale_template”, or “import”.sheetName
: Name of the newly created sheet
SHEET - UPDATE
Triggered when an existing sheet is updated.
additionalDetails
: (none)
SHEET - LOAD
Triggered when a sheet is viewed in the UI or loaded through the API.
additionalDetails
: (none)
SHEET - DELETE
Triggered when a sheet is deleted.
additionalDetails
: (none)
SHEET - RENAME
Triggered when an existing sheet is renamed.
additionalDetails
:newName
: New name of the sheetoldName
: Previous name of the sheet
SHEET - PURGE
Triggered when a sheet is deleted (“Delete Forever”) from the deleted items bin.
additionalDetails
: (none)
SHEET - RESTORE
Triggered when a sheet is in the deleted items bin and is restored (Undelete
).
additionalDetails
: (none)
SHEET - ADD_SHARE
Triggered when a group or user is added to the sheet’s sharing list, or when a group or user’s share permissions are changed.
additionalDetails
:accessLevel
: Indicates the access level granted to the group or user:"VIEWER"
,"EDITOR"
,"EDITOR_SHARE"
, or"ADMIN"
. Note that this access level represents the access level granted by this specific sharing action; it is not the group or user’s effective access level for the sheet.userId
: Id of the user that was added to the sheet’s sharing list. (Specific to share to user actions)groupId
: Id of the group that was added to the sheet’s sharing list. (Specific to share to group actions)
</details>
SHEET - REMOVE_SHARE
Triggered when a group or user is removed from a sheet’s sharing list.
additionalDetails
:userId
: Id of the user that was removed from the sheet’s sharing list. (Specific to remove share from user actions)groupId
: Id of the group that was removed from the sheet’s sharing list. (Specific to remove share from group actions)
SHEET - ADD_SHARE_MEMBER
Triggered when a user is added to a group that a sheet has been shared to via the sheet’s sharing list, or via a workspace’s sharing list. If a sheet has been shared to a group directly via the sheet’s sharing list, and via a workspace’s sharing list, then an event will be generated for each of these shares.
additionalDetails
:accessLevel
: Indicates the access level granted to the user:"VIEWER"
,"EDITOR"
,"EDITOR_SHARE"
, or"ADMIN"
. Note that this access level represents the access level that has been granted to the user via group membership; it is not the user’s effective access level for the sheet.groupId
: Id of the group the user was added to.userId
: Id of the user that was added to the group.workspaceId
: Id of the workspace that the group is shared to. (Specific to cases where the sheet is shared to the group via a workspace’s sharing list)
SHEET - REMOVE_SHARE_MEMBER
Triggered when a user is removed from a group that a sheet has been shared to via the sheet’s sharing list, or via a workspace’s sharing list. If a sheet has been shared to a group directly via the sheet’s sharing list, and via a workspace’s sharing list, then an event will be generated for each of these shares.
additionalDetails
:groupId
: Id of the group that the user was removed from.userId
: Id of user that was removed from the group.workspaceId
: Id of the workspace that the group is shared to. (Specific to cases where the sheet is shared to the group via a workspace’s sharing list)
SHEET - ADD_WORKSPACE_SHARE
Triggered when a group or user is added to a workspace’s sharing list. Note that this event will appear for each sheet that is in the workspace. If a group or user is added to a workspace’s sharing list and the workspace is empty, then no events will be recorded.
additionalDetails
:accessLevel
: Indicates the access level granted to the group or user:"VIEWER"
,"EDITOR"
,"EDITOR_SHARE"
, or"ADMIN"
. Note that this access level represents the access level granted by this specific sharing action; it is not the group or user’s effective access level for the sheet.userId
: Id of the user that the workspace was shared to. (Specific to share to user actions)groupId
: Id of the group that the workspace was shared to. (Specific to share to group actions)workspaceId
: Id of the workspace that was shared to the group or user.
SHEET - REMOVE_WORKSPACE_SHARE
Triggered when a group or user is removed from a workspace’s sharing list. Note that this event will appear for each sheet that is in the workspace. If a group or user is removed from a workspace’s sharing list and the workspace is empty, then no events will be recorded.
additionalDetails
:userId
: Id of the user that was removed from the workspace. (Specific to remove share from user actions)groupId
: Id of the group that was removed from the workspace. (Specific to remove share from group actions)workspaceId
: Id of the workspace the group or user was removed from.
SHEET - TRANSFER_OWNERSHIP
Triggered when the ownership of a sheet is transferred.
additionalDetails
:oldUserId
: Id of the former sheet owner.oldAccessLevel
: New access level of the former owner:"ADMIN"
.newUserId
: Id of the new sheet owner.newAccessLevel
: New access level of the new owner:"OWNER"
.
SHEET - SAVE_AS_NEW
Triggered when a user saves a copy of a sheet by using the Save As New
option. This event is recorded for the original sheet.
If the original sheet belongs to a different organization, then an event will be generated for organization with original sheet and for the organization with copied sheet.
For copied sheet, Save As New
event is paired with a SHEET - CREATE
event.
additionalDetails
: (none)
SHEET - SAVE_AS_TEMPLATE
Triggered when a user saves a copy of a sheet as a template by using the Save As Template
option. This event is recorded for the original sheet.
If the original sheet belongs to a different organization, then an event will be generated for organization with original sheet and for the organization with copied sheet.
For copied sheet, Save As Template
event is paired with a SHEET - CREATE
event.
additionalDetails
: (none)
SHEET - SEND_AS_ATTACHMENT
Triggered when a user sends a sheet as email attachment to user(s) or user group(s). An individual SHEET - SEND_AS_ATTACHMENT event is issued for each user or user group listed as recipient.
additionalDetails
:recipientEmail
: Single email address either of a user explicitly included in the recipient list or of the sender (when CC sender is requested), e.g. “[email protected]”. (This property is included only if the recipientGroupId property below isn’t included)recipientGroupId
: Single ID of a user group explicitly included in the recipient list, e.g."345987624123"
. (This property is included only if therecipientEmail
property above isn’t included)formatType
: The format in which the sheet was sent: “excel”, “pdf”, “pdf_gantt”, or “pdf_calendar”.
SHEET - SEND_ROW
Triggered when a user sends selected sheet row(s) by email to user(s) or user group(s). An individual SHEET - SEND_ROW event is issued for each user or user group listed as recipient.
additionalDetails
:recipientEmail
: Single email address either of a user explicitly included in the recipient list or of the sender (when CC sender is requested), e.g. “[email protected]”. (This property is included only if the recipientGroupId property below isn’t included)recipientGroupId
: Single ID of a user group explicitly included in the recipient list, e.g."345987624123"
. (This property is included only if therecipientEmail
property above isn’t included)rowCount
: Number of rows sent, e.g."2"
.includeAttachments
: Indicates whether the row(s) were sent with their respective attachments:"true"
or"false"
.includeDiscussions
: Indicates whether the row(s) were sent with their respective discussion comments:"true"
or"false"
.
SHEET - MOVE_ROW
Triggered when row(s) are moved from one sheet to another.
additionalDetails
:includeAttachments
: Indicates whether the row(s) moved with their respective attachments:"true"
or"false"
.includeDiscussions
: Indicates whether the row(s) moved with their respective discussion comments:"true"
or"false"
.sourceSheetId
: Id of sheet from where the rows moved. (Only included when theobjectId
property contains the Id of the destination sheet)destinationSheetId
: Id of sheet to where the rows moved. (Only included when theobjectId
property contains the Id of the source sheet)rowsMoved
: Number of rows moved, e.g."2"
.
SHEET - COPY_ROW
Triggered when row(s) are copied from one sheet to another.
additionalDetails
:includeAttachments
: Indicates whether the row(s) were copied with their respective attachments:"true"
or"false"
.includeDiscussions
: Indicates whether the row(s) were copied with their respective discussion comments:"true"
or"false"
.sourceSheetId
: Id of sheet from where the rows were copied. (Only included when theobjectId
property contains the Id of the destination sheet)destinationSheetId
: Id of sheet to where the rows were copied. (Only included when theobjectId
property contains the Id of the source sheet)rowsCopied
: Number of rows copied, e.g."2"
.
SHEET - CREATE_CELL_LINK
Triggered when a link to another sheet cell is created in a sheet cell.
additionalDetails
:cellLinkSourceSheetId
: Id of sheet referenced by the cell link.
SHEET - MOVE
Triggered when a sheet is moved between workspaces and/or folders.
additionalDetails
:newParentContainerId
: Id of the destination folder for the move event. (Specific to actions where the sheet was moved to a different folder).parentContainerId
: Id of the parent container of the sheet. (Specific to move events where a folder containing the sheet is moved to a folder in a different workspace, indicates that the sheet has moved to a new workspace but is still within the same folder)folderName
: name of the destination folder for the move event. (Specific to actions where the sheet was moved to a different folder).workspaceId
: Id of the workspace the sheet is currently in. If the move was between two workspaces theworkspaceId
will be the Id of the destination workspace.
SHEET - EXPORT
Triggered when a user exports or prints the sheet. Printing a sheet is a PDF export, then browser print, thus is reported as PDF export
additionalDetails
:formatType
: The format that the report was exported in “png_gantt” (gantt image), “mspdi” (Microsoft Project), “excel”, or “pdf”
SHEET - REQUEST_BACKUP
Triggered when a user requests a backup for a sheet.
additionalDetails
:includeAttachments
: Indicates whether attachments should be included in the recurring backup:"true"
or"false"
.sendCompletionEmail
: Indicates whether an email should be sent to the workspace’s owner every time a recurring backup completes:"true"
or"false"
.
Report
REPORT - CREATE
Triggered when a report is created (inserted).
additionalDetails
:reportName
: Name of the new reportsourceObjectId
: Id of report that was copied to create the new report. (Only included if the report was created as a result of a copy or save as new)sourceGlobalTemplateId
: Id of the global template that was used to create the new report (Only included if the report was created using a global template. “New Blank Report” is a global template)sourceType
: Type of object used to create the new sheet. Either “report” or “globale_template”.
REPORT - UPDATE
Triggered when an existing report is updated.
additionalDetails
: (none)
REPORT - LOAD
Triggered when a report is viewed in the UI or loaded through the API.
additionalDetails
: (none)
REPORT - RENAME
Triggered when an existing report is renamed.
additionalDetails
:newName
: New name of the reportoldName
: Previous name of the report
REPORT - DELETE
Triggered when a report is deleted.
additionalDetails
: (none)
REPORT - PURGE
Triggered when a report is deleted (“Delete Forever”) from the deleted items bin.
additionalDetails
: (none)
REPORT - RESTORE
Triggered when a report is in the deleted items bin and is restored (Undelete
).
additionalDetails
: (none)
REPORT - ADD_SHARE
Triggered when a group or user is added to the report’s sharing list, or when a group or user’s share permissions are changed.
additionalDetails
:accessLevel
: Indicates the access level granted to the group or user:"VIEWER"
,"EDITOR"
,"EDITOR_SHARE"
, or"ADMIN"
. Note that this access level represents the access level granted by this specific sharing action; it is not the group or user’s effective access level for the report.userId
: Id of the user that was added to the report’s sharing list. (Specific to share to user actions)groupId
: Id of the group that was added to the report’s sharing list. (Specific to share to group actions)
</details>
REPORT - REMOVE_SHARE
Triggered when a group or user is removed from a report’s sharing list.
additionalDetails
:userId
: Id of the user that was removed from the report’s sharing list. (Specific to remove share from user actions)groupId
: Id of the group that was removed from the report’s sharing list. (Specific to remove share from group actions)
REPORT - ADD_SHARE_MEMBER
Triggered when a user is added to a group that a report has been shared to via the report’s sharing list, or via a workspace’s sharing list. If a report has been shared to a group directly via the report’s sharing list, and via a workspace’s sharing list, then an event will be generated for each of these shares.
additionalDetails
:accessLevel
: Indicates the access level granted to the user:"VIEWER"
,"EDITOR"
,"EDITOR_SHARE"
, or"ADMIN"
. Note that this access level represents the access level that has been granted to the user via group membership; it is not the user’s effective access level for the report.groupId
: Id of the group the user was added to.userId
: Id of the user that was added to the group.workspaceId
: Id of the workspace that the group is shared to. (Specific to cases where the report is shared to the group via a workspace’s sharing list)
REPORT - REMOVE_SHARE_MEMBER
Triggered when a user is removed from a group that a report has been shared to via the report’s sharing list, or via a workspace’s sharing list. If a report has been shared to a group directly via the report’s sharing list, and via a workspace’s sharing list, then an event will be generated for each of these shares.
additionalDetails
:groupId
: Id of the group that the user was removed from.userId
: Id of user that was removed from the group.workspaceId
: Id of the workspace that the group is shared to. (Specific to cases where the report is shared to the group via a workspace’s sharing list)
REPORT - ADD_WORKSPACE_SHARE
Triggered when a group or user is added to a workspace’s sharing list. Note that this event will appear for each report that is in the workspace. If a group or user is added to a workspace’s sharing list and the workspace is empty, then no events will be recorded.
additionalDetails
:accessLevel
: Indicates the access level granted to the group or user:"VIEWER"
,"EDITOR"
,"EDITOR_SHARE"
, or"ADMIN"
. Note that this access level represents the access level granted by this specific sharing action; it is not the group or user’s effective access level for the report.userId
: Id of the user that the workspace was shared to. (Specific to share to user actions)groupId
: Id of the group that the workspace was shared to. (Specific to share to group actions)workspaceId
: Id of the workspace that was shared to the group or user.
REPORT - REMOVE_WORKSPACE_SHARE
Triggered when a group or user is removed from a workspace’s sharing list. Note that this event will appear for each report that is in the workspace. If a group or user is removed from a workspace’s sharing list and the workspace is empty, then no events will be recorded.
additionalDetails
:userId
: Id of the user that was removed from the workspace. (Specific to remove share from user actions)groupId
: Id of the group that was removed from the workspace. (Specific to remove share from group actions)workspaceId
: Id of the workspace the group or user was removed from.
REPORT - TRANSFER_OWNERSHIP
Triggered when the ownership of a report is transferred.
additionalDetails
:oldUserId
: Id of the former report owner.oldAccessLevel
: New access level of the former owner:"ADMIN"
.newUserId
: Id of the new report owner.newAccessLevel
: New access level of the new owner:"OWNER"
.
REPORT - MOVE
Triggered when a report is moved between workspaces and/or folders.
additionalDetails
:newParentContainerId
: Id of the destination folder for the move event. (Specific to actions where the report was moved to a different folder).parentContainerId
: Id of the parent container of the report. (Specific to move events where a folder containing the report is moved to a folder in a different workspace, indicates that the report has moved to a new workspace but is still within the same folder)folderName
: name of the destination folder for the move event. (Specific to actions where the report was moved to a different folder).workspaceId
: Id of the workspace the report is currently in. If the move was between two workspaces theworkspaceId
will be the Id of the destination workspace.
REPORT - SAVE_AS_NEW
Triggered when a user saves a copy of a report by using the Save As New
option. This event is recorded for the original report.
If the original reports belongs to a different organization, then an event will be generated for organization with original report and for the organization with copied report.
For copied report, Save As New
event is paired with a REPORT - CREATE
event.
additionalDetails
: (none)
REPORT - SEND_AS_ATTACHMENT
Triggered when a user sends a report as email attachment to user(s) or user group(s). An individual REPORT - SEND_AS_ATTACHMENT event is issued for each user or user group listed as recipient.
additionalDetails
:recipientEmail
: Single email address either of a user explicitly included in the recipient list or of the sender (when CC sender is requested), e.g. “[email protected]”. (This property is included only if the recipientGroupId property below isn’t included)recipientGroupId
: Single ID of a user group explicitly included in the recipient list, e.g."345987624123"
. (This property is included only if therecipientEmail
property above isn’t included)formatType
: The format in which the report was sent: “excel”, “pdf”, “pdf_gantt”, or “pdf_calendar”.
REPORT - EXPORT
Triggered when a user exports or prints the report. Printing a report is a PDF export, then browser print, thus is reported as PDF export
additionalDetails
:formatType
: The format that the report was exported in “png_gantt” (gantt image), “mspdi” (Microsoft Project), “excel”, or “pdf”
Update Request
UPDATE_REQUEST - CREATE
Triggered when a user creates a sheet update request. Notice that an update request is created whenever the user sends a new update request via the UI. Also, notice that even though update requests can be sent from a report, it is in fact an update request on the sheet that owns the rows sent in the update request.
additionalDetails
:sheetId
: Id of the sheet that owns the rows sent in the update request.rowCount
: Number of rows sent, e.g."2"
.includeAttachments
: Indicates whether the row(s) were sent with their respective attachments:"true"
or"false"
.includeDiscussions
: Indicates whether the row(s) were sent with their respective discussion comments:"true"
or"false"
.
User
USER - ADD_TO_ACCOUNT
Triggered when a user is added to an auto-provisioned organization account by an admin or when the user logs in with email associated with an auto-provisioned domain.
additionalDetails
:userTypes
: Comma-delimited list of user types, e.g.SYSTEM_ADMIN
,LICENSED_USER
,GROUP_ADMIN
,RESOURCE_VIEWER
,JIRA_ADMIN
,JIRA_USER
,SALESFORCE_ADMIN
,SALESFORCE_USER
. The full list of available user types can be seen here. Please notice that user types Unlicensed User and Free Collaborator are not applicable for this event.emailAddress
: Single email address of the user added to account, e.g. “[email protected]”.
USER - ACCEPT_INVITE
Triggered when a user accepts an invitation to join an organization account through email.
additionalDetails
:emailAddress
: Single email address of the user accepting invitation to join the account, e.g. “[email protected]”.
USER - DECLINE_INVITE
Triggered when a user declines an invitation to join an organization account through email.
additionalDetails
:emailAddress
: Single email address of the user accepting invitation to join the account, e.g. “[email protected]”.declineReason
: Decline reason for the invitation: “ACCEPT_FAILED_REMOVED_FROM_ORG”, “ACCEPT_FAILED_IN_OTHER_ORG”, “ACCEPT_FAILED_IS_PAID_USER”, “ACCEPT_FAILED_NEEDS_LICENSE”, “ACCEPT_FAILED_INSUFFICIENT_LICENSES”, “ACCEPT_FAILED_NOT_ELIGIBLE_FOR_TRIAL”, “ACCEPT_FAILED”, “ACCEPT_FAILED_NEEDS_GROUP_ADMIN_ROLE”, “ACCEPT_FAILED_UAP_VIOLATION”, or “DECLINE_SUCCESS”.
USER - SEND_INVITE
Triggered when an admin sends/resends an invitation link to the user. This can be done through User Management
console on UI or via the API (Add User).
additionalDetails
:userTypes
: Comma-delimited list of user types:SYSTEM_ADMIN
,LICENSED_USER
,GROUP_ADMIN
,RESOURCE_VIEWER
,JIRA_ADMIN
,JIRA_USER
,SALESFORCE_ADMIN
,SALESFORCE_USER
. The full list of available user types can be seen here. Please notice that user types Unlicensed User and Free Collaborator are not applicable for this event.emailAddress
: Single email address of the user added to the organization account, e.g. “[email protected]”.
USER - DOWNLOAD_SHEET_ACCESS_REPORT
Triggered when an admin downloads sheet access report for a user. This can be done through User Management
console on UI.
additionalDetails
: (none)
USER - REMOVE_FROM_GROUPS
Triggered when an admin removes an user from all groups owned by users on the organization account. This can be done through User Management
on UI.
additionalDetails
: (none)
USER - REMOVE_SHARES
Triggered when an admin removes the user from all groups and from sharing for all sheets, workspaces, and dashboards owned by users on the organization account. This can be done through User Management
on UI.
additionalDetails
: (none)
USER - REMOVE_FROM_ACCOUNT
Triggered when a user is removed from the organization account. This can be done through User Management
on UI or via the API (Remove User).
additionalDetails
:emailAddress
: Single email address of the user removed from the organization account, e.g. “[email protected]”.
USER - SEND_PASSWORD_RESET
Triggered when an admin sends a password reset email. This can be done through User Management
on UI.
additionalDetails
: (none)
USER - TRANSFER_OWNED_ITEMS
Triggered when an admin transfers ownership of all items (sheets/reports/dashboards/workspaces) owned by a user to another user. This can be done through User Management
on UI.
additionalDetails
:oldOwnerUserId
: Id of the former owner.oldOwnerUserId
property is the same asobjectId
property in this case.newOwnerUserId
: Id of the new owner.
USER - TRANSFER_OWNED_GROUPS
Triggered when an admin transfers ownership of all groups owned by a user to another user. This can be done through User Management
on UI.
additionalDetails
:oldOwnerUserId
: Id of the former owner.oldOwnerUserId
property is the same asobjectId
property in this case.newOwnerUserId
: Id of the new owner.
USER - UPDATE_USER
Triggered when the user account is updated. This can be done through User Management
on UI or via the API.
additionalDetails
: (none)
Workspace
WORKSPACE - CREATE
Triggered when a workspace is created. Workspaces can be created in the UI with the Create New
button, by selecting the Save As New
option on an existing workspace, or through the API.
additionalDetails
:workspaceName
: Name of the workspace.sourceWorkspaceId
: Id of workspace that was copied to create the new workspace. (Only included if the workspace was created as a result of a save as new or copy)
WORKSPACE - RENAME
Triggered when a workspace is renamed in the UI or via the API (update).
additionalDetails
:oldName
: Old name of the workspace.newName
: New name of the workspace.
WORKSPACE - SAVE_AS_NEW
Triggered when a user saves a copy of a workspace by using the Save As New
option via UI or Copy Workspace
via API. This event is recorded for the original workspace. Each Save As New
event is paired with a WORKSPACE - CREATE
event that is recorded for the copy of the workspace.
additionalDetails
: (none)
WORKSPACE - DELETE
Triggered when a workspace is deleted.
additionalDetails
: (none)
WORKSPACE - ADD_SHARE
Triggered when a group or user is added to the workspace’s sharing list, or when a group or user’s share permissions are changed.
additionalDetails
:accessLevel
: Indicates the access level granted to the group or user:"VIEWER"
,"EDITOR"
,"EDITOR_SHARE"
, or"ADMIN"
. Note that this access level represents the access level granted by this specific sharing action; it is not the group or user’s effective access level for the workspace.userId
: Id of the user that was added to the workspace’s sharing list. (Specific to share to user actions)groupId
: Id of the group that was added to the workspace’s sharing list. (Specific to share to group actions)
WORKSPACE - REMOVE_SHARE
Triggered when a group or user is removed from a workspace’s sharing list.
additionalDetails
:userId
: Id of the user that was removed from the workspace’s sharing list. (Specific to remove share from user actions)groupId
: Id of the group that was removed from the workspace’s sharing list. (Specific to remove share from group actions)
WORKSPACE - ADD_SHARE_MEMBER
Triggered when a user is added to a group that a workspace has been shared to via the workspace’s sharing list, or via a workspace’s sharing list. If a workspace has been shared to a group directly via the workspace’s sharing list, and via a workspace’s sharing list, then an event will be generated for each of these shares.
additionalDetails
:accessLevel
: Indicates the access level granted to the user:"VIEWER"
,"EDITOR"
,"EDITOR_SHARE"
, or"ADMIN"
. Note that this access level represents the access level that has been granted to the user via group membership; it is not the user’s effective access level for the workspace.groupId
: Id of the group the user was added to.userId
: Id of the user that was added to the group.
WORKSPACE - REMOVE_SHARE_MEMBER
Triggered when a user is removed from a group that a workspace has been shared to via the workspace’s sharing list, or via a workspace’s sharing list. If a workspace has been shared to a group directly via the workspace’s sharing list, and via a workspace’s sharing list, then an event will be generated for each of these shares.
additionalDetails
:groupId
: Id of the group that the user was removed from.userId
: Id of user that was removed from the group.
WORKSPACE - TRANSFER_OWNERSHIP
Triggered when a workspace ownership is transferred.
additionalDetails
:oldOwnerUserId
: Id of the former workspace owner.newOwnerUserId
: Id of the new workspace owner.
WORKSPACE - CREATE_RECURRING_BACKUP
Triggered when a user schedules a recurring backup for a workspace.
additionalDetails
:includeAttachments
: Indicates whether attachments should be included in the recurring backup:"true"
or"false"
.sendCompletionEmail
: Indicates whether an email should be sent to the workspace’s owner every time a recurring backup completes:"true"
or"false"
.
WORKSPACE - UPDATE_RECURRING_BACKUP
Triggered when a user updates the options (listed below in additionalDetails
) in a recurring backup schedule for a workspace.
additionalDetails
:includeAttachments
: Indicates whether attachments should be included in the recurring backup:"true"
or"false"
.sendCompletionEmail
: Indicates whether an email should be sent to the workspace’s owner every time a recurring backup completes:"true"
or"false"
.
WORKSPACE - DELETE_RECURRING_BACKUP
Triggered when a user deletes a recurring backup schedule for a workspace.
additionalDetails
: (none)
WORKSPACE - REQUEST_BACKUP
Triggered when a user requests a backup for a workspace.
additionalDetails
:includeAttachments
: Indicates whether attachments should be included in the recurring backup:"true"
or"false"
.sendCompletionEmail
: Indicates whether an email should be sent to the workspace’s owner every time a recurring backup completes:"true"
or"false"
.
WORKSPACE - EXPORT
Triggered when a user exports the workspace.
additionalDetails
:formatType
: The format that the workspace was exported (“excel” or “pdf”). Notice that the same value “excel” is displayed either when exporting to Microsoft Excel or when exporting to Google Sheets.