Reference - Global system events

Insert

Before
After
Failure

ObjectEventArgs

Properties

• Object (BaseInfo)

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

ObjectEventArgs

Properties

• Object (BaseInfo)

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

ObjectEventArgs

Properties

• Object (BaseInfo)

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.

BulkInsert

Before
After
Failure

BulkInsertEventArgs

Properties

• InsertedObjects (IEnumerable<IInfo>)
• TypeInfo (ObjectTypeInfo)

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.

BulkUpdate

Before
After
Failure

BulkUpdateEventArgs

Properties

• ChangedColumns (IEnumerable<string>)
• TypeInfo (ObjectTypeInfo)
• WhereCondition (IWhereCondition)

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.

BulkDelete

Before
After
Failure

BulkDeleteEventArgs

Properties

• TypeInfo (ObjectTypeInfo)
• WhereCondition (IWhereCondition)

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

ObjectEventArgs

Properties

• Content (string)
• Object (BaseInfo)

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

LogObjectChangeEventArgs

Properties

• Settings (LogObjectChangeSettings)

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

CheckPermissions

Before
After
Failure

ObjectSecurityEventArgs

Properties

• Object (BaseInfo)
• Permission (PermissionsEnum)
• User (UserInfo)
• SiteName (string)
• Result (AuthorizationResultEnum)

Occurs when the system checks permissions for objects of the given type.

Sort

Before
After
Failure

ObjectSortEventArgs

Properties

• Object (BaseInfo)
• Ascending (bool)
• OrderColumn (string)
• NameColumn (string)

Occurs when sorting of objects is requested.

ChangeOrder

Before
After
Failure

ObjectChangeOrderEventArgs

Properties

• Object (BaseInfo)
• NewOrder (int)
• RelativeOrder (int)
• OrderColumn (string)

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

GetData

Before
After
Failure

ObjectDataEventArgs

Properties

• Data (DataSet)
• Query (IObjectQuery)
• TotalRecords (int)

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

DocumentEventArgs

Properties

• TargetParentNodeID (int)
• Node (TreeNode)
• TreeProvider (TreeProvider)

Occurs when a new page is created.

InsertNewCulture

Before
After
Failure

DocumentEventArgs

Properties

• Node (TreeNode)
• TreeProvider (TreeProvider)

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

InsertLink

Before
After
Failure

DocumentEventArgs

Properties

• TargetParentNodeID (int)
• Node (TreeNode)
• TreeProvider (TreeProvider)

Occurs when creating new linked pages.

Update

Before
After
Failure

DocumentEventArgs

Properties

• Node (TreeNode)
• TreeProvider (TreeProvider)

Occurs when an existing page is updated.

Move

Before
After
Failure

DocumentEventArgs

Properties

• TargetParentNodeID (int)
• Node (TreeNode)
• TreeProvider (TreeProvider)

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

Copy

Before
After
Failure

DocumentEventArgs

Properties

• TargetParentNodeID (int)
• IncludeChildren (bool)
• Node (TreeNode)
• TreeProvider (TreeProvider)

Occurs when a new copy of a page is created.

Delete

Before
After
Failure

DocumentEventArgs

Properties

• Node (TreeNode)
• TreeProvider (TreeProvider)

Occurs when a page is deleted.

LogChange

Before
After
Failure

LogDocumentChangeEventArgs

Properties

• Settings (LogDocumentChangeSettings)

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

CheckPermissions

Before
After
Failure

DocumentSecurityEventArgs

Properties

• Node (TreeNode)
• Permission (PermissionsEnum)
• User (UserInfo)
• SiteName (string)
• Result (AuthorizationResultEnum)

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 AuthorizeDocumentevent. 

Sort

Before
After
Failure

DocumentSortEventArgs

Properties

• ParentNodeId (int)
• Ascending (bool)
• SortType (DocumentSortEnum)

Occurs when sorting of pages is requested.

ChangeOrder

Before
After
Failure

DocumentChangeOrderEventArgs

Properties

• Node (TreeNode)
• NewOrder (int?)
• RelativeOrder (bool)
• OrderType (DocumentOrderEnum)

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

GetData

Before
After
Failure

DocumentDataEventArgs

Properties

• Data (DataSet)
• Query (IDocumentQuery)
• TotalRecords (int)

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.

CreateSearchFields

Execute

CreateSearchFieldsEventArgs

Properties

• Fields (IList<ISearchField>)
• IndexInfo (ISearchIndexInfo)
• IndexDataSource (SearchIndexDataSourceEnum)
• SearchFields (IEnumerable<ISearchField>)

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

CreateSearchFieldsForPage

Execute

CreateSearchFieldsForPageEventArgs

Properties

• Fields (IList<ISearchField>)
• IndexInfo (ISearchIndexInfo)
• IndexDataSource (SearchIndexDataSourceEnum)
• Page (TreeNode)
• SearchFields (IEnumerable<ISearchField>)

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

GetContent

Execute

DocumentSearchEventArgs

Properties

• Content (string)
• Node (TreeNode)
• Settings (SearchIndexSettingsInfo)
• IndexInfo (ISearchIndexInfo)
• SearchDocument (ISearchDocument)
• IsCrawler (bool)

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

DocumentEventArgs

Properties

• Attachment (DocumentAttachment)
• Node (TreeNode)
• TreeProvider (TreeProvider)

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

DeleteAttachment

Before
After
Failure

DocumentEventArgs

Properties

• Attachment (DocumentAttachment)
• Node (TreeNode)
• TreeProvider (TreeProvider)

Occurs when a file attachment is removed from a page.

AuthorizeDocument

Execute

DocumentAuthorizationEventArgs

Properties

• User (UserInfo)
• Document (TreeNode)
• PermissionName (string)
• AuthorizationResult (AuthorizationResultEnum)

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

DocumentAuthorizationEventArgs

Properties

• User (UserInfo)
• Data (DataSet)
• PermissionName (string)

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.

Approve

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• PreviousStep (WorkflowStepInfo) - only in the After event
• TreeProvider (TreeProvider)

Occurs when a page is approved to the next step.

Reject

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• PreviousStep (WorkflowStepInfo) - only in the After event
• TreeProvider (TreeProvider)

Occurs when a page is rejected back to a previous step

Publish

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• PublishedDocument(TreeNode) - only in the After event
• PreviousStep (WorkflowStepInfo) - only in the After event
• TreeProvider (TreeProvider)

Occurs when a page reaches the published step.

Archive

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• PreviousStep (WorkflowStepInfo) - only in the After event
• TreeProvider (TreeProvider)

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.

SaveVersion

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• VersionHistory (VersionHistoryInfo)
• VersionNumber (string)
• VersionComment (string)
• TreeProvider (TreeProvider)

Occurs when the edited version of a page is updated.

SaveAttachmentVersion

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• Attachment (DocumentAttachment)
• TreeProvider (TreeProvider)

Occurs when an attachment is updated or inserted for the edited version of a page.

RemoveAttachmentVersion

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• Attachment (DocumentAttachment)
• TreeProvider (TreeProvider)

Occurs when an attachment is removed for the edited version of a page.

CheckOut

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• TreeProvider (TreeProvider)

Occurs when a page is checked-out.

CheckIn

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• TreeProvider (TreeProvider)

Occurs when a page is checked-in.

UndoCheckOut

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• TreeProvider (TreeProvider)

Occurs when a user performs the undo check-out action.

Authenticate

Execute

AuthenticationEventArgs

Properties

• User (UserInfo)
• UserName (string)
• Password (string)
• SiteName (string)

Occurs when authenticating users into the administration interface.

See also: Handling custom administration authentication

AuthenticationRequested

Execute

AuthenticationRequestEventArgs

Properties

• RequestedUrl (string)

Occurs when a user accesses a restricted section of Xperience and the user’s authentication is required.

MultiFactorAuthenticate

Execute

AuthenticationEventArgs

Properties

• User (UserInfo)
• Passcode (string)
• UserName (string)

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

See also: Handling custom multi-factor authentication

AuthorizeResource

Execute

AuthorizationEventArgs

Properties

• User (UserInfo)
• ResourceName (string)
• PermissionName (string)
• Authorized (bool)

Occurs when checking permissions for modules.

AuthorizeClass

Execute

AuthorizationEventArgs

Properties

• User (UserInfo)
• ClassName (string)
• PermissionName (string)
• Authorized (bool)

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

AuthorizeUIElement

Execute

AuthorizationEventArgs

Properties

• User (UserInfo)
• ElementName (string)
• PermissionName (string)
• Authorized (bool)

Occurs when checking permissions for UI elements.

SignOut

Before
After
Failure

SignOutEventArgs

Properties

• User (UserInfo)
• SignOutUrl (string)

Occurs when a user signs out from the administration interface.

RevokeConsentAgreement

Execute

RevokeConsentAgreementEventArgs

Properties

• ConsentAgreement (ConsentAgreementInfo)
• Consent (ConsentInfo)
• Contact (ContactInfo)

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

LogEventArgs

Properties

• Event (EventLogInfo)

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

GetChildProcessingType

Execute

StagingChildProcessingTypeEventArgs

Properties

• ObjectType (string)
• ParentObjectType (string)
• ProcessingType (IncludeToParentEnum)

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.

LogTask

Before
After
Failure

StagingLogTaskEventArgs

Properties

• Object (BaseInfo)
• Task (StagingTaskInfo)

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

StagingTaskEventArgs

Properties

• Task (StagingTaskInfo)

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

ProcessTask

Before
After
Failure

StagingSynchronizationEventArgs

Properties

• TaskType (TaskTypeEnum)
• ObjectType (string)
• TaskData (DataSet)
• TaskBinaryData (DataSet)
• TaskHandled (bool)
• SyncManager (ISyncManager)

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.).

LogInternalTask

Before
After
Failure

IntegrationTaskEventArgs

Properties

• Task (IntegrationTaskInfo)
• Object (BaseInfo)

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

LogExternalTask

Before
After
Failure

IntegrationTaskEventArgs

Properties

• Task (IntegrationTaskInfo)
• Object (BaseInfo)

Occurs when the system creates incoming tasks provided by an integration connector.

Import

Before
After
Failure

ImportBaseEventArgs

Properties

• Settings (SiteImportSettings)

Occurs at the start of the import process.

ImportObject

Before
After
Failure

ImportEventArgs

Properties

• Settings (SiteImportSettings)
• Object (BaseInfo)
• ParentObject (BaseInfo)
• Parameters (ImportParameters)

Occurs once for every imported object.

ImportObjects

Before
After
Failure

ImportDataEventArgs

Properties

• Settings (SiteImportSettings)
• Data (DataSet)
• ObjectType (string)
• SiteObjects (bool)
• ParentImported (bool)

Occurs when importing sets of objects.

ImportBinding

Before
After
Failure

ImportEventArgs

Properties

• Settings (SiteImportSettings)
• Object (BaseInfo)
• ParentObject (BaseInfo)
• Parameters (ImportParameters)

Occurs once for every imported binding object.

ImportBindings

Before
After
Failure

ImportEventArgs

Properties

• Settings (SiteImportSettings)
• Object (BaseInfo)
• ParentObject (BaseInfo)
• Parameters (ImportParameters)

Occurs when importing binding objects.

ImportChild

Before
After
Failure

ImportEventArgs

Properties

• Settings (SiteImportSettings)
• Object (BaseInfo)
• ParentObject (BaseInfo)
• Parameters (ImportParameters)

Occurs once for every imported child object.

ImportChildren

Before
After
Failure

ImportEventArgs

Properties

• Settings (SiteImportSettings)
• Object (BaseInfo)
• ParentObject (BaseInfo)
• Parameters (ImportParameters)

Occurs when importing child objects.

GetImportData

Before
After
Failure

ImportGetDataEventArgs

Properties

• Settings (SiteImportSettings)
• Data (DataSet)
• Object (BaseInfo)
• ObjectType (string)
• SiteObjects (bool)
• SelectionOnly (bool)

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.

ProcessFileOperation

Before
After
Failure

ImportProcessFileOperationEventArgs

Properties

• Operation (FileOperation)
• Settings (SiteImportSettings)

Occurs when processing file/folder operations in the import package.

ImportCanceled

Execute

ImportBaseEventArgs

Properties

• Settings (SiteImportSettings)

Occurs when a user cancels the import process.

ImportError

Execute

ImportErrorEventArgs

Properties

• Exception (Exception)
• Settings (SiteImportSettings)

Fires when an error occurs during the import process.

Export

Before
After
Finished
Failure

ExportEventArgs

Properties

• Settings (SiteExportSettings)
• SiteObjects (bool)

Occurs at the start of the export process.

ExportObjects

Before
After
Failure

ExportEventArgs

Properties

• Settings (SiteExportSettings)
• Data (DataSet)
• ObjectType (string)
• SiteObjects (bool)

Occurs when exporting objects.

GetExportData

Before
After
Failure

ExportGetDataEventArgs

Properties

• Settings (SiteExportSettings)
• Data (DataSet)
• ObjectType (string)
• WhereCondition (string)
• ChildData (bool)
• SelectionOnly (bool)
• Parameters(QueryDataParameters)

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.

SingleExportSelection

Execute

SingleExportSelectionEventArgs

Properties

• Settings (SiteExportSettings)
• InfoObject (BaseInfo)
• SelectedObject (List<string>)

Occurs when selecting related objects during single object export. Allows you to attach related objects to the export package.

ExportCanceled

Execute

ExportBaseEventArgs

Properties

• Settings (SiteExportSettings)

Occurs when a user cancels the export process.

ExportError

Execute

ExportErrorEventArgs

Properties

• Exception (Exception)
• Settings (SiteExportSettings)

Fires when an error occurs during the export process.

ExportDocuments

Before
After
Failure

DocumentsExportEventArgs

Properties

• Settings (SiteExportSettings)
• Data (DataSet)
• ObjectType (string)
• SiteObjects (bool)

Occurs when exporting pages.

ImportDocument

Before
After
Failure

DocumentImportEventArgs

Properties

• Document (TreeNode)
• Settings (SiteImportSettings)

Occurs once for every imported page.

ImportDocuments

Before
After
Failure

DocumentImportEventArgs

Properties

• Document (TreeNode)
• Settings (SiteImportSettings)

Occurs when importing pages.

RegisterRecords

Execute

ColumnsTranslationEventArgs

Properties

• ObjectType (string)
• Data (IDataContainer)
• TranslationHelper (TranslationHelper)

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

TranslateColumns

Execute

ColumnsTranslationEventArgs

Properties

• ObjectType (string)
• Data (IDataContainer)
• TranslationHelper (TranslationHelper)

Occurs when importing objects. Allows you to translate the values of custom ID fields using the provided information.

BuildNuSpecManifest

Before
After
Failure

BuildNuSpecManifestEventArgs

Properties

• Manifest (NuGet.Manifest)
• NuSpecBuilder (CMS.Modules.NuSpecBuilder)
• ResourceName (string)

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.

Insert

Before
After
Failure

BizFormItemEventArgs

Properties

• Item (BizFormItem)

Occurs when inserting new form items (data records of on-line forms).

Update

Before
After
Failure

BizFormItemEventArgs

Properties

• Item (BizFormItem)

Occurs when updating form data records.

Delete

Before
After
Failure

BizFormItemEventArgs

Properties

• Item (BizFormItem)

Occurs when deleting data records from forms.

Insert

Before
After
Failure

CustomTableItemEventArgs

Properties

• Item (CustomTableItem)

Occurs when inserting new custom table items (data records stored in a custom table).

Update

Before
After
Failure

CustomTableItemEventArgs

Properties

• Item (CustomTableItem)

Occurs when updating custom table items.

Delete

Before
After
Failure

CustomTableItemEventArgs

Properties

• Item (CustomTableItem)

Occurs when deleting custom table items.

NewOrderCreated

Execute

NewOrderCreatedEventArgs

Properties

• NewOrder (OrderInfo)

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

OrderPaidEventArgs

Properties

• Order (OrderInfo)

Fires when an order becomes paid.

ProductAddedToShoppingCart

Execute

ProductAddedToCartEventArgs

Properties

• AddedShoppingCartItem (ShoppingCartItemInfo)

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).

ResolveMacros

Before
After
Failure 

ResolveMacrosEventArgs

Properties

• MacroResolver (MacroResolver)
• TextToResolve (string)
• Newsletter (NewsletterInfo)
• IssueInfo (IssueInfo)

Occurs when all email feed text macros are resolved.

GenerateQueueItems

Before
After
Failure 

GenerateQueueItemsEventArgs

Properties

• Subscriber (SubscriberInfo)
• Issue (IssueInfo)
• EmailAddressBlocker (IEmailAddressBlocker)
• GeneratedEmails (HashSet<string>)

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.

GeneratePreview

Before
After
Failure 

GeneratePreviewEventArgs

Properties

• Subscriber (SubscriberInfo)
• Issue (IssueInfo)
• PreviewHtml (string)

Occurs when an email preview is generated for a recipient.

SubscriberUnsubscribes

Execute

UnsubscriptionEventArgs

Properties

• Newsletter (NewsletterInfo)
• Email (string)
• IssueID (int?)

Occurs when a recipient unsubscribes from an email feed.

SubscriberOpensEmail

Execute

LinksEventArgs

Properties

• IssueInfo (IssueInfo)
• NewsletterInfo (NewsletterInfo)
• AdditionalParameters (NameValueCollection)

Occurs when a recipient opens an email and the open email tracking feature is enabled.

SubscriberClicksTrackedLink

Execute

LinksEventArgs

Properties

• IssueInfo (IssueInfo)
• NewsletterInfo (NewsletterInfo)
• AdditionalParameters (NameValueCollection)

Occurs when a recipient clicks an email link and the email link tracking feature is enabled.

CheckAnalyticsConsent

Execute

CheckAnalyticsConsentEventArgs

Properties

• ContactId (int)
• HasConsent (bool)

Occurs before the system logs any web analytics for visitors (before any processing of the visitor’s personal data).

Allows you to disable logging of web analytics based on consent. Assign a handler to the event, create a condition according to your website’s consent requirements, and set the HasConsent property of the handler’s CheckAnalyticsConsentEventArgs parameter based on the result.

Example: Logging web analytics based on consent

CampaignLaunched

Execute

CMSEventArgs<CampaignInfo>

Occurs when a campaign is launched (whether it was originally scheduled or launched directly).

CampaignUTMChanged

Execute

CMSEventArgs<CampaignUTMChangedEventArgs>

Occurs when the UTM parameter is changed for a campaign.

ContactInfosDeleted 

Execute

ContactinfosDeletedHandlerEventArgs

Properties

• DeletedContactsIds (IEnumerable<int>)
• DeletedContactsGUIDs (IEnumberable<Guid>)

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.

ActivityBulkInsertPerformed

Before
After
Failure

CMSEventArgs<IList<IActivityInfo>>

Fires when the system processes on-line marketing activities that are logged in memory, and bulk inserts them to the database.

ActivityProcessedInLogService

Execute

CMSEventArgs<IActivityInfo>

Fires when an on-line marketing activity is logged and processed. At this point, the activity is only stored in the application memory (activities are regularly processed and saved in bulk to the database – see the ActivityBulkInsertPerformed event).

MoveToNextStep

Before
After
Failure

AutomationEventArgs

Properties

• InfoObject (BaseInfo)
• StateObject (AutomationStateInfo)
• PreviousStep (WorkflowStepInfo)

Occurs when a contact in an automation process moves to the next step.

MoveToPreviousStep

Before
After
Failure

AutomationEventArgs

Properties

• InfoObject (BaseInfo)
• StateObject (AutomationStateInfo)
• PreviousStep (WorkflowStepInfo)

Occurs when a contact in an automation process moves back to the previous step.

Action

Before
After
Failure

WorkflowActionEventArgs<BaseInfo, AutomationStateInfo, AutomationActionEnum>

Requires references to:

• CMS.WorkflowEngine
• CMS.DataEngine

Occurs when the system executes a marketing automation action step.

ProcessTrigger

Before
After
Failure

AutomationProcessTriggerEventArgs

Properties

• Options (IEnumerable<TriggerOptions>)
• TriggerInfo (ObjectWorkflowTriggerInfo)

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.

Exception

Execute

SystemEventArgs

Properties

• Exception (Exception)
• LogException (bool)

Fires when an unhandled exception occurs in the system.

Delete

Before
After
Failure

SiteDeletionEventArgs

Properties

• User (UserInfo)
• Context (CMSActionContext)
• Info (DeletionInfo)

Occurs when a site is deleted from the system.

BulkInsert

Before
After
Failure

BulkInsertDataEventArgs

Properties

• Connection (IDataConnection)
• InsertSettings (BulkInsertSettings)
• SourceData (DataTable)
• TargetTable (string)

Occurs when the system creates objects by directly inserting data into a database table (for example when importing contacts from CSV files).

ExecuteQuery

Before
After
Failure

ExecuteQueryEventArgs<DataSet>

Properties

• Connection (IDataConnection)
• Query (QueryParameters)
• Result (DataSet)

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

ExecuteNonQuery

Before
After
Failure

ExecuteQueryEventArgs<int>

Properties

• Connection (IDataConnection)
• Result (DataSet)

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

ExecuteScalar

Before
After
Failure

ExecuteQueryEventArgs<object>

Properties

• Connection (IDataConnection)
• Query (QueryParameters)
• Result (DataSet)

Occurs when the system executes a scalar query.

ExecuteReader

Before
After
Failure

ExecuteQueryEventArgs<DbDataReader>

Properties

• Connection (IDataConnection)
• Result (DataSet)

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.

PreInitialized

Execute

EventArgs

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.

Initialized

Execute

EventArgs

Occurs when the application finishes initialization and starts (including all modules and the database connection). Handle this event to perform standard application start events.

PostStart

Execute

EventArgs

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.

End

Execute

EventArgs

Occurs when the application ends.

Error

Execute

EventArgs

Fires when an error occurs in the application.

SessionStart

Execute

EventArgs

Occurs when an HTTP session starts for a client.

SessionEnd

Execute

EventArgs

Occurs when an HTTP session ends for a client. May not be raised if the application is configured to use a session state mode different than InProc.

Prepare

Execute

EventArgs

Occurs before the request processing begins.

Begin

Execute

EventArgs

Occurs when the request processing starts.

Authenticate

Execute

EventArgs

Occurs when authenticating requests.

Authorize

Execute

EventArgs

Occurs when authorizing requests.

PostAuthorize

Execute

EventArgs

Occurs after the request’s user is authorized.

PostResolveRequestCache

Execute

EventArgs

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

MapRequestHandler

Execute

EventArgs

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

PostMapRequestHandler

Execute

EventArgs

Occurs after the application has mapped the request to the appropriate event handler.

AcquireRequestState

Execute

EventArgs

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

PostAcquireRequestState

Execute

EventArgs

Occurs after the request state (for example session state) that is associated with the current request has been obtained.

End

Execute

EventArgs

Occurs at the end of the request processing.

PreSendRequestHeaders

Execute

EventArgs

Occurs just before ASP.NET sends HTTP headers to the client.

RunEndRequestTasks

Execute

EventArgs

Allows you to execute background tasks at the end of the request processing. Running long tasks in this event’s handlers can negatively affect the response time of requests.

Finalize

Execute

EventArgs

Occurs when the request is finalized. Use to cleanup and release any resources used by the request. Running long tasks in this event’s handlers can negatively affect the response time of requests.