Reference - Global system events

Insert
_______________________

Before
After
Failure

Occurs when a new object is created.

To reliably handle all possible object creation events, you may also need to assign a matching handler to the BulkInsert event. The system triggers the BulkInsert event instead of Insert in certain cases, particularly for operations that can affect multiple objects.

Update

Before
After
Failure

Occurs when the data of an existing object is updated.

To reliably handle all possible object update events, you may also need to assign a matching handler to the BulkUpdate event. The system triggers the BulkUpdate event instead of Update in certain cases, particularly for operations that can affect multiple objects.

Delete

Before
After
Failure

Occurs when an object is deleted.

To reliably handle all possible object deletion events, you may also need to assign a matching handler to the BulkDelete event. The system triggers the BulkDelete event instead of Delete in certain cases, particularly for operations that can affect multiple objects.

Occurs when the system performs object creation operations that can affect multiple objects. To reliably handle all possible object creation events, assign matching handlers to both the BulkInsert and Insert events.

In certain cases, the system creates objects by directly inserting data into a database table (for example when importing contacts from CSV files). To cover these scenarios, you also need to assign an appropriate handler to the SqlEvents.BulkInsert event.

Occurs when the system performs object update operations that can affect multiple objects. To reliably handle all possible object update events, assign matching handlers to both the BulkUpdate and Update events.

Before
After
Failure

Occurs when the system performs object deletion operations that can affect multiple objects. To reliably handle all possible object deletion events, assign matching handlers to both the BulkDelete and Delete events.

GetContent

Execute
___________

Occurs before the system writes an object's data into smart search indexes (when building or updating indexes).

Allows you to determine exactly how search indexes store object content.

Example: Customizing the content of search indexes

LogChange

Before
After
Failure

Occurs when the system logs object changes for the purposes of staging and integration. For example, allows you to exclude specific objects from staging.

Example: Excluding content from staging and integration

Before
After
Failure

Before
After
Failure

Occurs when sorting of objects is requested.

 Occurs when a change in the order of objects is requested.

Before
After
Failure

Occurs when the system retrieves object data using the ObjectQuery API.

The Before event type is suitable, for example, when you want to retrieve data from an external source. Assign the external data into the Data property of the handler's ObjectDataEventArgs parameter, which is empty by default in the Before event.

Use the After event type if you need to edit the data retrieved from Xperience in the Data property.

The TotalRecords property provides a number of total records in case paging is used. Use -1 to use the rows count of the Data property.

Insert
_______________________

Before
After
Failure

Occurs when a new page is created.

InsertNewCulture

Before
After
Failure

Occurs when a new culture version is created for a page.

InsertLink

Before
After
Failure

Occurs when creating new linked pages.

Update

Before
After
Failure

Occurs when an existing page is updated.

Move

Before
After
Failure

Occurs when a page is moved to a different position in the site's content tree.

Copy

Before
After
Failure

Occurs when a new copy of a page is created.

Delete

Before
After
Failure

Occurs when a page is deleted.

LogChange

Before
After
Failure

Occurs when the system logs page changes for the purposes of staging and integration. For example, allows you to exclude specific pages from staging.

Example: Excluding content from staging and integration

Before
After
Failure

Occurs when the system checks permissions for pages.

Note: This event does not occur on the live site. For checking permissions on the live site, see the AuthorizeDocument event. 

Occurs when the system retrieves page data using the DocumentQuery API.

The Before event type is suitable, for example, when you want to retrieve data from an external source. Assign the external data into the Data property of the handler's DocumentDataEventArgs parameter, which is empty by default in the Before event.

Use the After event type, when you want to edit the data retrieved from Xperience in the Data property.

The TotalRecords property provides a number of total records in case paging is used. Use -1 to use rows count of the Data property.

Occurs while (re)building a locally stored search index of the Pages type when the system prepares the collection of search fields.

Allows developers to add custom search fields to indexes. Such fields must be added via the Fields property of the handler's CreateSearchFieldsEventArgs parameter.

Values for the custom fields can be assigned for individual pages by handling the CreateSearchFieldsForPage event.

Example: Customizing the content of search indexes

Occurs when the system indexes or updates a page for a locally stored search index of the Pages type. The event triggers separately for each indexed page.

Allows developers to add custom search fields to indexes and set their value for individual pages. Such fields must be added via the Fields property of the handler's CreateSearchFieldsForPageEventArgs parameter. Set field values using the Value property of the added ISearchField object.

Important: Any custom fields must first be registered into your indexes by handling the CreateSearchFields event.

Example: Customizing the content of search indexes

Occurs before the system writes a page's data into a search index (when building or updating indexes).

Allows you to determine exactly how search indexes store page content.

Examples: Customizing the content of search indexes

SaveAttachment

Before
After
Failure

Occurs when a file attachment is added to a page or updated.

DeleteAttachment

Before
After
Failure

Occurs when a file attachment is removed from a page.

Execute

Occurs when the system performs a security check for the permissions of a specific page.

You can modify the result of the security check by adding your own conditions and setting the AuthorizationResult property of the handler's DocumentAuthorizationEventArgs parameter.

FilterDataSetByPermissions

Execute

Occurs when the system filters a set of pages according to the page permissions of a user.

You can modify the filtering by adding your own conditions and modifying the page data in the Data property of the handler's DocumentAuthorizationEventArgs parameter.

Before
After
Failure

Occurs when a page is approved to the next step.

Reject

Before
After
Failure

Occurs when a page is rejected back to a previous step

Publish

Before
After
Failure

Occurs when a page reaches the published step.

Archive

Before
After
Failure

Occurs when a page is archived.

Action

Before
After
Failure
___________

WorkflowActionEventArgs<TreeNode, BaseInfo, WorkflowActionEnum>

Requires references to:

• CMS.WorkflowEngine
• CMS.DataEngine

Occurs when executing advanced workflow action steps.

Before
After
Failure

Before
After
Failure

Before
After
Failure

Before
After
Failure

Before
After
Failure

Before
After
Failure

Occurs when authenticating users into the administration interface.

See also: Handling custom administration authentication

MultiFactorAuthenticate

Occurs when a user tries to sign in to Xperience with multi-factor authentication enabled.

See also: Handling custom multi-factor authentication

AuthorizeResource

Occurs when checking permissions for modules.

AuthorizeClass

Occurs when performing security checks for object type or page type permissions.

Occurs when checking permissions for UI elements.

Before
After
Failure

Occurs when a consent agreement is revoked. When a contact's consent agreement is revoked, this event can be used to perform custom actions, such as terminating tracking of the contact or deleting personal data related to the contact.

See also: Creating consents, Working with consents

LogEvent
_______________________

Before
After
Failure
___________

Occurs when the system logs a record into the event log. You can use the Before event to customizing the data logged for events or cancel logging for certain types of events. The After event allows you to perform custom actions after events are successfully logged, for example duplicate certain types of events into a custom log.

See also: Customizing event logging

Occurs on the target server when processing create or update staging tasks that include the data of child or binding objects (once for each child or binding type).

For example, staging tasks for roles include the data of binding objects, such as user-role and role-permission relationships. When processing a create or update staging task for a role, the GetChildProcessingType event triggers separately for each binding type included in the role data.

You can use the event to customize how the system handles child and binding object data during staging. For more information, see Customizing staging of child and binding objects.

Before
After
Failure

Occurs when creating staging tasks on the source server after a page or object is changed in the system.

See also:

• Excluding content from staging and integration
• Automatically synchronizing staging and integration tasks

Synchronize

Before
After
Failure

CMSEventArgs

Occurs on the source server when synchronizing staging tasks – once per synchronize action, even when processing multiple tasks.

SynchronizeTask

Before
After
Failure

Occurs on the source server when synchronizing staging tasks – separately for every processed task.

Before
After
Failure
___________

Occurs on the target server when processing incoming staging tasks.

The processing of the staging tasks then also triggers the corresponding DocumentEvents or ObjectEvents (Insert, Update, Delete, etc.).

Before
After
Failure

Occurs when creating outgoing integration tasks after a page or object in the system is changed.

Before
After
Failure
___________

Before
After
Failure

Before
After
Failure

Before
After
Failure

Before
After
Failure

Before
After
Failure

Before
After
Failure

Before
After
Failure

Before
After
Failure

Occurs when importing data. Allows you to work with the data set in the import package created for a specific object types.

• Use the Before event type to modify the data in the import package (for example add data from an external source).
• Use the After event type to modify the data after the import package has been loaded.

Before
After
Failure

Before
After
Finished
Failure

Before
After
Failure

Before
After
Failure

Occurs when exporting data. Allows you to work with the data set in the export package created for specific object types.

• Use the Before event type to extract data from the export package.
• Use the After event type to modify the data in the export package.

Before
After
Failure

Occurs when exporting pages.

Before
After
Failure

Before
After
Failure

Execute

Occurs when exporting objects. Allows you to provide additional information for the translation of custom ID fields.

Execute
___________

BuildNuSpecManifest
_______________________

Before
After
Failure
___________

Occurs when the system creates the .nuspec file for module NuGet packages. The file is an XML manifest containing package metadata. See the .nuspec reference for more information.

The event allows you to customize the package metadata for your modules:

• The Before event type allows you to adjust the default nuspec content via the Xperience API – use the members of the NuSpecBuilder instance provided by the corresponding property of the handler's BuildNuSpecManifestEventArgs parameter.
• Use the After event type if you wish to modify or completely replace the resulting nuspec manifest, which is accessible as an instance of the NuGet.Manifest class via the corresponding property of the handler's BuildNuSpecManifestEventArgs parameter.

The ResourceName property of the handler's BuildNuSpecManifestEventArgs parameter contains the code name of the module for which the package is being created.

Before
After
Failure

Before
After
Failure

Before
After
Failure
___________

Before
After
Failure

Before
After
Failure

Before
After
Failure
___________

NewOrderCreated

Execute

Fires when a new order is created.

The event triggers only when the order is created based on an existing shopping cart. For example, the event does not trigger if an order is created within code using the OrderInfoProvider API.

OrderPaid

_______________________

Execute 

___________

Fires when a customer adds a product to their shopping cart.

The event occurs only once when multiple units of the same product are added to the cart within a single action (the ShoppingCartItem object available in the event's ProductAddedToCartEventArgs parameter can represent any number of product units).

Occurs when an email feed is sent to one or more recipients. You can use this event to manually add emails to the queue for custom recipients.

Note: The GeneratedEmails property is used only with Newsletter email feeds and its primary purpose is to check duplicates in the newsletter recipients.

Occurs when two or more selected contacts are deleted.

When a single contact is deleted, the TypeInfoEvents.Delete event can be used on ContactInfo.TYPEINFO.

Before
After
Failure

CMSEventArgs<IList<IActivityInfo>>

CMSEventArgs<IActivityInfo>

Before
After
Failure

Before
After
Failure

Before
After
Failure
___________

WorkflowActionEventArgs<BaseInfo, AutomationStateInfo, AutomationActionEnum>

Requires references to:

• CMS.WorkflowEngine
• CMS.DataEngine

Before
After
Failure

Occurs when processing triggers for automation processes. The system evaluates triggers periodically in bulk for a certain number of related contacts (represented by the collection in the Options property of the AutomationProcessTriggerEventArgs parameter).

Evaluates the trigger condition and allows you to, for example, insert data into the condition.

Execute
___________

Before
After
Failure
___________

Occurs when a site is deleted from the system.

Before
After
Failure
___________

Occurs when the system executes a database query.

Note: The ExecuteQuery event does NOT trigger when the system (or custom code) enumerates through the results of an ObjectQuery call. The ExecuteReader event is triggered instead.

See also: Working with database queries in the API

Before
After
Failure

Occurs when the system executes a non-query database operation.

Before
After
Failure

Before
After
Failure

Occurs when the system runs a database DataReader.

Note: This event is triggered when the system (or custom code) materializes an ObjectQuery call, typically by enumerating through the results. However, this is not the case for DocumentQuery calls, which trigger the ExecuteQuery event instead.

Occurs when the application finishes pre-initialization (preparation of things unrelated to the database).

Handlers need to be assigned in the PreInit method of custom modules.

Occurs at the end of the first application request. Allows you to perform asynchronous tasks needed for application startup.

Running long operations within this event's handlers can negatively affect the response time of the first request when starting the application.

Execute

EventArgs

Execute

EventArgs

EventArgs

Occurs when the request processing starts.

Occurs when ASP.NET bypasses execution of the current handler and allows a caching module to serve the request from the cache.

Occurs when a handler is selected to respond to the request.

Execute

Occurs when acquiring the state (for example session state) that is associated with the current request.

PreSendRequestHeaders

Before
After
Failure

UpdateSessionData

_______________________

Execute
___________