Platform Events Overview

With the sFiles Spring '24 release (v. 1.50.1), transactions in sFiles publish platform events, which can be used to trigger custom apex code.

Apr 15, 2025
Knowledge

Title

URL Name

Platform-Events-Overview

Article Body

Prerequisites

sFiles version 1.50.1 or later installed.
1. Visit sFiles on the AppExchange and click "Get it Now" to update to the latest version.

Overview

With the sFiles Spring '24 release (v. 1.50.1), transactions in sFiles publish platform events, which can be used to trigger custom apex code. See below for an overview of this functionality and view the specific articles for each event in the links at the bottom of the article.

Types of Platform Events in sFiles

sFiles utilizes two types of platform events:

Internal_Event__e - This platform event is used for all actions in the internal sFiles LWC and Aura components:
- sFiles Enterprise Component
- sFiles Standard Component
Community_Event__e - This platform event is used for all actions in the Uploader and List View Components in Experience Cloud.
- sFiles Uploader Component
- sFiles List View Component

Fields on the sFiles Platform Events

Both of the Internal_Event__e and Community_Event__e platform events use nearly all the same fields (Source__c is the only field that is unique to the Internal_Event__e platform event). See an overview of the fields on these events below:

FIELD	DESCRIPTION
User_Id__c	The Salesforce User Id that caused the event.
Type__c	The technical name of the event
Site__c	The SharePoint site Id associated with the action.
Document_Library__c	The SharePoint document library associated with the action.
Record_Id__c	The Salesforce record associated with the action.
Item_Name__c	The name of the associated SharePoint file. NOTE: This field is not used for the email event
Item_Id__c	The SharePoint Id of the associated file. NOTE: This field is not used for the email event
Event_Content__c	JSON serialized data of files related to the specific action. This data can be serialized as an apex class with file information related to the action. See below for what each action return: The following actions return a JSON serialized fileforcem1.SharepointFileInfo Upload Download OpenFolder OpenFile CreateFolder Delete The following actions return a JSON serialized fileforcem1.SharePointFileInfoHistory ColumnUpdate Rename The following actions return a JSON serialized fileforcem1.MoveCopyOutput Move Copy The following action returns a JSON serialized fileforcem1.GenerateLinkItem GenerateLink The following action returns a JSON serialized fileforcem1.EmailEventResponse Email
Source__c	The API name of the sFiles component (This field only exists on the Internal_Event__e platform event): fileforcem1-browser-enterprise = sFiles Enterprise Component fileforcem1-browser-standard = sFiles Standard Component fileforcem1-browser-community = sFiles Full Feature [Per-User Only] Component

Currently Supported Platform Events

Please see a list below of the currently supported platform events. For more detail about each platform event and examples of triggering code, visit the specific link for each event shown below.

Internal_Event__e Supported Events
ColumnUpdate	When the SharePoint columns of a file or folder is updated
CreateFolder	When a folder is created
Delete	When a file or folder is deleted
Download	When a file is downloaded
OpenFile	When a file is opened in SharePoint
OpenFolder	When a folder is opened
Upload	When a file is uploaded
Rename	When a file or folder is renamed
Move	When a file or folder is moved
Copy	When a file or folder is copied
GenerateLink	When a link is generated for a file or folder
Email	When a file or files are sent as an attachment via an email
Community_Event__e Supported Events
Download	When a file is downloaded
OpenFolder	When a folder is opened
Upload	When a file is uploaded