Using Notifications

Get started with Notifications.

Umbraco uses Notifications (similar to the Observer pattern) to allow you to hook into the workflow process for the backoffice. For example, notifications allow you to execute some code every time a page is published.

Notifications

All notifications reside in the Umbraco.Cms.Core.Notifications namespace and are postfixed with Notification.

Available notifications typically exist in pairs, with "before" and "after" notifications. For example, the ContentService class has the concept of publishing and published notifications. So, there is both a ContentPublishingNotification and a ContentPublishedNotification notification.

The notification to use depends on what you want to achieve. If you want to be able to cancel the action, you would use the CancelOperation method on the "before" notification. See the sample in ContentService Notifications. If you want to execute some code after the publishing has succeeded, then you would use the "after" notification.

Registering Notifications

Check the Notification Handler article to learn more about notification handlers lifetime, async notification handler and how to register the notification handlers.

List of Notifications

Below you can find a list of most used object notifications.

You can find a list of all supported notifications in the API Documentation.

Content, Media, and Member notifications

ContentService Notifications

The ContentService class is the most commonly used type when extending Umbraco using notifications. ContentService implements IContentService. It provides access to operations involving IContent.

Below you can find a list of the most common ContentService object notifications.

• ContentSavingNotification

• ContentSavedNotification

• ContentPublishingNotification

• ContentPublishedNotification

• ContentUnpublishingNotification

• ContentUnpublishedNotification

• ContentCopyingNotification

• ContentCopiedNotification

• ContentMovingNotification

• ContentMovedNotification

• ContentMovingToRecycleBinNotification

• ContentMovedToRecycleBinNotification

• ContentDeletingNotification

• ContentDeletedNotification

• ContentDeletingVersionsNotification

• ContentDeletedVersionsNotification

• ContentRollingBackNotification

• ContentRolledBackNotification

• ContentSendingToPublishNotification

• ContentSentToPublishNotification

• ContentEmptyingRecycleBinNotification

• ContentEmptiedRecycleBinNotification

• ContentSavedBlueprintNotification

• ContentDeletedBlueprintNotification

MediaServiceNotifications

Below you can find a list of the most common MediaService object notifications.

• MediaSavingNotification

• MediaSavedNotification

• MediaMovingNotification

• MediaMovedNotification

• MediaMovingToRecycleBinNotification

• MediaMovedToRecycleBinNotification

• MediaDeletingNotification

• MediaDeletedNotification

• MediaDeletingVersionsNotification

• MediaDeletedVersionsNotification

MemberService Notifications

The MemberService implements IMemberService and provides access to operations involving IMember.

Below you can find a list of the most common MemberService object notifications.

• MemberSavingNotification

• MemberSavedNotification

• MemberDeletingNotification

• MemberDeletedNotification

• AssignedMemberRolesNotification

• RemovedMemberRolesNotification

Other notifications

ContentTypeService Notifications

The ContentTypeService class implements IContentTypeService. It provides access to operations involving IContentType.

Below you can find a list of the most common ContentTypeService object notifications.

• ContentTypeSavingNotification

• ContentTypeSavedNotification

• ContentTypeDeletingNotification

• ContentTypeDeletedNotification

• ContentTypeMovingNotification

• ContentTypeMovedNotification

• ContentTypeChangedNotification

MediaTypeService Notifications - object list

The MediaTypeService class implements IMediaTypeService. It provides access to operations involving IMediaType.

Below you can find a list of the most common MediaTypeService object notifications.

• MediaTypeSavingNotification

• MediaTypeSavedNotification

• MediaTypeDeletingNotification

• MediaTypeDeletedNotification

• MediaTypeMovingNotification

• MediaTypeMovedNotification

• MediaTypeChangedNotification

MemberTypeService Notifications

The MemberTypeService class implements IMemberTypeService. It provides access to operations involving IMemberType

Below you can find a list of the most common MemberTypeService object notifications.

• MemberTypeSavingNotification

• MemberTypeSavedNotification

• MemberTypeDeletingNotification

• MemberTypeDeletedNotification

• MemberTypeMovingNotification

• MemberTypeMovedNotification

• MemberTypeChangedNotification

DataTypeService Notifications

The DataTypeService class implements IDataTypeService. It provides access to operations involving IDataType.

Below you can find a list of the most common DataTypeService object notifications.

• DataTypeSavingNotification

• DataTypeSavedNotification

• DataTypeDeletingNotification

• DataTypeDeletedNotification

• DataTypeMovingNotification

• DataTypeMovedNotification

FileService Notifications

The FileService class implements IFileService. It provides access to operations involving IFile objects like scripts, stylesheets and templates.

Below you can find a list of the most common FileService object notifications.

• TemplateSavingNotification

• TemplateSavedNotification

• ScriptSavingNotification

• ScriptSavedNotification

• StylesheetSavingNotification

• StylesheetSavedNotification

• TemplateDeletingNotification

• TemplateDeletedNotification

• ScriptDeletingNotification

• ScriptDeletedNotification

• StylesheetDeletingNotification

• StylesheetDeletedNotification

LocalizationService Notifications

The LocalizationService class implements ILocalizationService. It provides access to operations involving Language and DictionaryItem.

Below you can find a list of the most common LocalizationService object notifications.

• LanguageSavingNotification

• LanguageSavedNotification

• DictionaryItemSavingNotification

• DictionaryItemSavedNotification

• LanguageDeletingNotification

• LanguageDeletedNotification

• DictionaryItemDeletingNotification

• DictionaryItemDeletedNotification

CacheRefresher Notifications

Below you can find a list of the most common CacheRefresher object notifications.

• ContentCacheRefresherNotification

• MediaCacheRefresherNotification

• MemberCacheRefresherNotification

• UserCacheRefresherNotification

RelationService Notifications

Below you can find a list of the most common RelationService object notifications.

The RelationService provides access to operations involving IRelation and IRelationType, and publishes the following relation notifications:

• RelationSavingNotification

• RelationSavedNotification

• RelationDeletingNotification

• RelationDeletedNotification

• RelationTypeSavingNotification

• RelationTypeSavedNotification

• RelationTypeDeletingNotification

• RelationTypeDeletedNotification

UmbracoApplicationLifetime Notifications

Represents an Umbraco application lifetime (starting, started, stopping, stopped) notification.

Below you can find a list of the most common UmbracoApplicationLifetime object notifications.

• UmbracoApplicationStartingNotification

• UmbracoApplicationStartedNotification

• UmbracoApplicationStoppingNotification

• UmbracoApplicationStoppedNotification

Tree notifications

Learn more about these under Tree Change Notifications in the CMS API documentation.

Creating and publishing your own custom notifications

Umbraco uses notifications to allow people to hook into different workflow processes. This notification pattern is extensible, allowing you to create and publish custom notifications, and other people to observe and hook into your custom processes. This approach can be useful when creating Umbraco packages. For more information on how you create and publish your own notifications, see the creating and publishing notifications article.

Samples

Below you can find some articles with some examples using Notifications.

• CacheRefresher Notification

• ContentService Notifications

• Determining if an entity is new

• Hot vs. cold restarts

• MediaService Notifications

• MemberService Notifications

• Umbraco Application Lifetime Notifications