List of trigger definitions
Introduction
This page contains a comprehensive list of the objects, their associated properties, and the different types of events that can be used to build triggers.
Objects and properties
There are three different types of objects:
- The Session object is created whenever a Session is created.
- It stores session-specific information such as the GUID, number of currently connected hosts, and the session's custom properties.
- The Connection object is created whenever a connection is initiated by either a host or a guest.
- Information such as the name of who initiated the connection and when it was initiated.
- The Event object is created whenever an Event is executed or queued.
- Events can include a Reinstall command being issued from the Host page or a session being created.
- The Event object stores information such as who initiated the event, which event took place, and at what time the event occurred.
To call an object's property, the syntax would like Object.Property. For example:
Event.EventType
Session object properties
| Property | Definition |
|---|---|
| Code | The access code for the session, if defined |
| CustomPropertyN | The value of custom property N; N is 1-8 (CustomProperty1 is "Company" OOTB) |
| GuestClientVersion | The version of client software on the guest machine, in N.N.N.N notation |
| GuestConnectedCount | The number of guests connected to the session |
| GuestLastActivityTime | The time of last activity on the guest machine |
| GuestLoggedOnUserDomain | The domain of the user logged onto the guest machine |
| GuestLoggedOnUserName | The name of the user logged onto the guest machine |
| GuestMachineDomain | The domain or workgroup of the guest machine |
| GuestMachineName | The name of the guest machine |
| GuestOperatingSystemName | The name of the operating system of the guest machine |
| GuestOperatingSystemVersion | The version of the guest operating system, in N.N.N.N notation |
| GuestProcessorName | The name of the processor on the guest machine |
| GuestProcessorVirtualCount | The number of virtual processors on the guest machine |
| GuestSystemMemoryAvailableMegabytes | The available system memory on the guest machine, in megabytes |
| GuestSystemMemoryTotalMegabytes | The total system memory on the guest machine, in megabytes |
| Host | The user name of the host of the session |
| HostConnectedCount | The number of hosts connected to the session |
| IsPublic | A flag indicating whether the session is public |
| Name | The name of the session |
| Notes | A semicolon-delimited list of all notes added to the session |
| SessionID | The unique ID of the session in GUID (Globally Unique Identifier) format |
| SessionType | The type of session (Support, Meeting, Access) |
Connection object properties
| Property | Definition |
|---|---|
| Attributes | The attributes of the connection, currently unused |
| ClientType | The client type ('Unknown', 'DotNetWinForms', 'JavaSwing', 'JavaAndroid', 'MonoTouchIos') of the connection as a string |
| ClientVersion | The client version of the connection |
| ConnectedTime | The date/time connected of the connection |
| ConnectionID | The unique ID of the connection in GUID (Globally Unique Identifier) format |
| GuestNetworkAddress | The network address of the guest machine, usually in N.N.N.N IPv4 notation |
| NetworkAddress | The network address of the connection, usually in N.N.N.N IPv4 notation |
| ParticipantName | The participant name of the connection |
| ProcessType | The process type ('Unknown', 'Guest', 'Host') of the connection as a string |
Event object properties
| Property | Definition |
|---|---|
| Data | Data that describes the event |
| EventID | The unique ID of the event in GUID (Globally Unique Identifier) format |
| EventType | The type of the event as a string; values are listed below |
| Host | The host that performed the event, if it was performed outside of a connection |
| Time | The date/time of the event |
| SessionEventAttributes |
Available for version 6.0+. SessionEventAttribute replaces the Processed[Event] Events. SessionEventAttributes has the following attributes:
Note: Triggers will not re-fire if there is a change to the state of a SessionEventAttributes property. |
Session events
Tip: See our session events page for more information on deprecated session events.
|
Event type |
Example actions that caused the event |
|---|---|
| AcknowledgedEvent | Viewing a notification such a chat message or an elevation request |
|
AddedNote |
|
| AnnotatedEvent | Used to attach additional information to events, e.g. how Access Management attaches VirusTotal information to EncounteredElevationPrompt events |
| ApprovedRequest | The user's request, such as RequestedElevation or RequestedAdministrativeLogon, was approved. Used for ConnectWise Access Management. |
| CanceledRequest | The user's request, such as RequestedElevation or RequestedAdministrativeLogon, was canceled. Used for ConnectWise Access Management. |
|
Connected |
A guest, host, or remote machine connecting to the server |
|
CopiedFiles |
Transferring a file from a session using copy and paste |
|
CopiedText |
Currently not in use |
|
CreatedSession |
Creating a new session |
| DeletedEvent | Marks the correlated event as user-deleted, e.g. SentMessage, QueuedCommand, etc. |
|
DeletedSession |
|
| DeniedRequest | The user's request, such as RequestedElevation or RequestedAdministrativeLogon, was denied. Used for ConnectWise Access Management. |
|
Disconnected |
A guest, host, or remote machine disconnecting from the server |
|
DraggedFiles |
Transferring a file from a session using drag-and-drop |
| EncounteredElevationPrompt | An end user encountered a Windows UAC elevation prompt. |
| EncounteredLogonScreen | The administrative logon is appearing on the login screen. Used for ConnectWise Access Management. |
|
InitiatedJoin |
A guest attempting to join the session |
|
InvitedGuest |
Sending an email invitation to a guest |
|
ModifiedCode |
Editing the session join code for a support or meeting session |
|
ModifiedCustomProperty |
Editing a session’s custom property field |
| ModifiedGuestInfo | Fires when a guest client reports new guest info. This event is not persisted to the database. |
|
ModifiedHost |
Transferring a session to another host |
|
ModifiedIsPublic |
Changing whether the session is publicly displayed on the Guest page |
|
ModifiedName |
Editing the name of a session |
|
QueuedCommand |
Sending a command to a remote machine |
|
QueuedElevatedTool |
Running a tool with elevated privileges |
|
QueuedForceDisconnect |
Disconnecting a host or a guest from a session |
|
QueuedGuestInfoUpdate |
Clicking Update Guest Info to refresh a session screenshot and machine information |
|
QueuedInstallAccess |
Turning a support session into an access session |
|
QueuedInvalidateLicense |
Session Manager checking if an active session is valid according to licensing terms |
|
QueuedLogonSessionLock |
Lock a guest machine when the host disconnects |
|
QueuedLogonSessionLogoff |
Logoff a user when the host disconnects |
|
QueuedMessage |
Sending a chat message to a machine that is offline |
| QueuedProceedAdministrativeLogon | For Access Management. Automatically logging in with an ephemeral administrator account. |
| QueuedProceedElevation | For Access Management. Automatically elevating a user past UAC prompts. |
|
QueuedReinstall |
Reinstalling or upgrading an access agent from the Host page |
|
QueuedTool |
Running a tool from the toolbox |
|
QueuedUninstall |
Uninstalling an access agent from the Host page |
|
QueuedUninstallAndDelete |
Uninstalling an access agent and deleting the session |
|
QueuedWake |
Issuing a wake-on-LAN command to an access agent |
|
RanAutoReinstall |
Run an auto reinstall on a machine |
|
RanCommand |
Receiving output from running a command from the Host page |
|
RanFiles |
Run a file on a remote session |
|
ReceivedPrintJob |
Receiving a print job from a remote machine using remote printing |
| RequestedAdministrativeLogon | A user requested a temporary administrative logon. Used for ConnectWise Access Management. |
| RequestedElevation | An end user requested the elevation of a Windows UAC elevation prompt. Used for ConnectWise Access Management. |
| ResetRegisteredGuestClient | Used by the Reset Registered Guests extension |
|
SentFiles |
Sending a file via the host client |
|
SentMessage |
Sending a chat message |
|
SentPrintJob |
Sending a print job to a printer using remote printing |
| SwitchedLogonSession | Switching to a different logon session or switching to Backstage |
ModifiedGuestInfo
The session event ModifiedGuestInfo keeps track of the state of a session both before and after the trigger fires.
After invoking ModifiedGuestInfo, use OldSession to retrieve the state of a session before the trigger fires, and use Session to retrieve the state of a session after the trigger has fired.
For example, this filter will execute an action when the guest machine's available memory is above 90% both before and after the trigger fires.
Event.EventType = 'ModifiedGuestInfo' AND OldSession.GuestSystemMemoryAvailableMegabytes/OldSession.GuestSystemMemoryTotalMegabytes > .9 AND Session.GuestSystemMemoryAvailableMegabytes/Session.GuestSystemMemoryTotalMegabytes > .9