Events
Lists shop-wide events for auditing and troubleshooting.
View-Specific Information
Select
The server processes all filters client-side within the server. The following query is the only one processed server-side:
SELECT * FROM Events
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The globally unique identifier of the event. | |
| AppTitle | String | The name of the app that generated the event. | |
| AttributeToApp | Bool | Indicates whether the event was created by an app. | |
| AttributeToUser | Bool | Indicates whether the event was triggered by an admin user. | |
| CreatedAt | Datetime | The date and time when the event was created. | |
| CriticalAlert | Bool | Indicates whether the event is flagged as critical. | |
| Action | String | The specific action that occurred in the event. | |
| Message | String | Human-readable text describing the event. | |
| BasicEventSubjectId | String | The identifier of the resource that generated the event. | |
| BasicEventSubjectType | String | The type of resource that generated the event. | |
| BasicEventHasAdditionalContent | Bool | Indicates whether the event includes additional content. | |
| BasicEventAdditionalContent | String | Supplementary content for collapsible timeline events. | |
| BasicEventAdditionalData | String | Additional structured data provided for event consumers. | |
| BasicEventSecondaryMessage | String | Supporting human-readable text that complements the main event message. | |
| BasicEventArguments | String | Arguments or references tied to the event and its related resources. | |
| CommentEventAuthorId | String | The identifier of the staff member who authored the comment event. | |
| CommentEventCanDelete | Bool | Indicates whether the comment event can be deleted. | |
| CommentEventCanEdit | Bool | Indicates whether the comment event can be edited. | |
| CommentEventEdited | Bool | Indicates whether the comment event has been edited. | |
| CommentEventRawMessage | String | The unformatted body text of the comment event. | |
| CommentEventSubjectId | String | The identifier of the parent subject associated with the comment event. | |
| CommentEventSubjectHasTimelineComment | Bool | Indicates whether the timeline subject includes a timeline comment. | |
| CommentEventEmbedCustomerId | String | The identifier of the customer object referenced in the comment event. | |
| CommentEventEmbedDraftOrderId | String | The identifier of the draft order object referenced in the comment event. | |
| CommentEventEmbedOrderId | String | The identifier of the order object referenced in the comment event. | |
| CommentEventEmbedProductId | String | The identifier of the product object referenced in the comment event. | |
| CommentEventEmbedProductVariantId | String | The identifier of the product variant object referenced in the comment event. |