PlanBusiness admin users have access to the last 30 days of audit logs for their account.
Access the audit logs in Settings. Only admin users have access to the audit log. You can view the most recent 500 log results on the audit log page, or download all the results as a CSV.
The system logs a variety of user actions as audit logs. These logs are in the format:
timestamp | userName | userEmail | userRole | userStatus | action | metadata | ipAddress | userAgent
where metadata is an object containing (where relevant) the workspaceId , nodeId, path, and type (for node actions - see below for metadata for other actions). Actions follow the naming convention: TYPE - ACTION where TYPE could be NODE, USER, ACCOUNT, etc, and ACTION is a descriptive single word such as VIEWED, OPENED, CREATED, or DELETED
| Identifier | What information it contains |
|---|
| timestamp | Date.now object with the date/time of the action |
| userName | First and last name of the user, as provided in initial account creation |
| userEmail | User's email address, used to log into Parcel |
| userRole | The user's role in Parcel. Only admins can access the log. |
| userStatus | The user's current status - 'ACTIVE' for current users, 'TERMINATED' for removed users |
| action | The action done |
| metadata | Object containing additional information about the file that the action is taken upon. |
| ipAddress | The IP address of the user when the action was done |
| userAgent | The user's user agent, which contains identifying information about their browser and OS |
The metadata object contains the following information for every logged NODE action. Each metadata value is a string.
| Key | What it is |
|---|
| workspaceId | Unique identifier for the workspace, which is account specific |
| nodeId | Unique identifier for the node (file, folder) |
| type | File type that the node is ('ROOT', 'EMAIL', 'COMPONENT', 'ASSET', 'FOLDER') |
| path | The file path to (and including) the node |
| Action | When It's Triggered |
|---|
| NODE - CREATED | Whenever a user creates a new file/node in the workspace |
| NODE - VIEWED | Whenever a user opens a file in the workspace (including after file creation) |
| NODE - DELETED | Whenever a user deletes a file from the workspace |
| Action | When It's Triggered | Metadata |
|---|
| EMAIL - EXPORTED | Whenever a user exports an email as a zip, copied HTML, or PDF | {emailId, type, workspaceId, path, options} |
| EMAIL - IMPORTED | Whenever an email is imported into Parcel by inbound email | {subject, toAddress, fromAddress, nodeId, path} |
where type is either 'zip', 'copied', or 'pdf', depending on the export. options is only included with PDF export and includes the selected PDF options.
| Action | When It's Triggered | Metadata |
|---|
| VERSION - SAVED | Whenever an email version is saved | {versionId} |
| Action | When It's Triggered | Metadata |
|---|
| SNIPPET - CREATED | Whenever a user creates a new snippet | {snippetId, name, trigger } |
| SNIPPET - VIEWED | Whenever a snippet is viewed | {snippetId} |
| SNIPPET - DELETED | Whenever a user deletes a snippet | {snippetId, name, trigger } |
| Action | When It's Triggered | Metadata |
|---|
| ACCOUNT - UPDATED | Whenever a change is made to an account | {update} |
| ACCOUNT - CREATED | When an account is first created | {accountName} |
| SUBSCRIPTION - CREATED | When an account subscription (paid plan) is started | {plan, interval} |
| SUBSCRIPTION - UPDATED | When an account is up or downgraded between paid plans | {oldPlan, newPlan} |
| SUBSCRIPTION - CANCELED | When a subscription (paid plan) is canceled | |
| SUBSCRIPTION - RENEWED | When a canceled subscription is un-canceled | |
| SUBSCRIPTION - ADDON ADDED | When an addon is added to the account | {addonId} |
| SUBSCRIPTION - ADDON REMOVED | When an addon is removed from the account | {addonId} |
| BILLING - UPDATED | When billing information (credit card) is changed | |
| Action | When It's Triggered | Metadata |
|---|
| USER - INVITED | Whenever a new user is invited to your account | {email, role} |
| USER - CREATED | Whenever a user account is created, including from an email invite | {email, name, invited} |
| USER - UPDATED | Whenever a user changes any settings/preferences related to their account | {userId, update} |
| USER - DELETED | Whenever a user is removed from your account or closes their own account | {userId, email} |
| Action | When It's Triggered | Metadata |
|---|
| WORKSPACE - CREATED | Whenever a new workspace is created on your account | {workspaceId, workspaceName} |
| WORKSPACE - UPDATED | Whenever a change is made to workspace level settings | {workspaceId, name, settings} |
| WORKSPACE - DELETED | Whenever a workspace on your account is deleted | {workspaceId, workspaceName} |
| WORKSPACE - EXPORTED | Whenever a workspace is exported as a zip | {workspaceId, workspaceName} |
| Action | When It's Triggered | Metadata |
|---|
| COMMENT - ADDED | Whenever a user adds a new comment on a file | |
| COMMENT - DELETED | Whenever a user deletes a comment on a file | |
| REPLY - ADDED | Whenever a user replies to a comment | |
| REPLY - DELETED | Whenever a user deletes a reply | |