Subscribable Messages

To learn how the message subscriptions work, see the documentation for the Message Aggregator

Custom Entities

• ICustomEntityContentUpdatedMessage: Indicates that the content of a custom entity has changed, e.g. any content elements like page blocks or data model properties that for example might require a change to a search index.
• CustomEntityAddedMessage: Message published when a new custom entity has been added.
• CustomEntityUrlChangedMessage: Message published when the information that makes up a url on a custom entity has been changed (slug/locale).
• CustomEntityOrderingUpdatedMessage: Message published when the ordering of a custom entity has been changed. This message is often published in a batch, so if you're handling this message it's best to use IBatchMessageHandler<CustomEntityOrderingUpdatedMessage>.
• CustomEntityPublishedMessage: Message published when a custom entity has gone from a draft to publish state. This is not invoked when a new custom entity is created, to capture that event use CustomEntityAddedMessage and check the HasPublishedVersionChanged property.
• CustomEntityUnPublishedMessage: Message published when a custom entity has moved from published to draft state.
• CustomEntityDeletedMessage: Message published when a custom entity has been deleted.
• CustomEntityDraftVersionAddedMessage: Message published when a new draft version has been added to a custom entity.
• CustomEntityDraftVersionUpdatedMessage: Message published when a custom entity draft version has been updated.
• CustomEntityDraftVersionDeletedMessage: Message published when a custom entity draft version is deleted.
• CustomEntityVersionBlockAddedMessage: Message published when a page block has been added to a custom entity.
• CustomEntityVersionBlockUpdatedMessage: Message published when a page block has been updated on a custom entity.
• CustomEntityVersionBlockMovedMessage: Message published when a page block has been removed from a custom entity.
• CustomEntityVersionBlockDeletedMessage: Message published when a page block has been removed from a custom entity.

Document Assets

• DocumentAssetAddedMessage: Message published when a document is added.
• DocumentAssetUpdatedMessage: This message is published when a document is updated.
• DocumentAssetDeletedMessage: Message published when a document is deleted.

Image Assets

• ImageAssetAddedMessage: Message published when an image is added.
• ImageAssetUpdatedMessage: This message is published when an image is updated.
• ImageAssetDeletedMessage: Message published when an image is deleted.

Pages

• IPageContentUpdatedMessage: Indicates that the content of a page has changed e.g. any content elements like blocks or other page properties. This is also triggered when a new page has been added.
• PageAddedMessage: Message published when a page is added.
• PageUpdatedMessage: This message is published when the data directly associated with a page has been updated. To be notified when any part of a page (including versions) changes you should subscribe to IPageContentUpdatedMessage.
• PageUrlChangedMessage: Message published when properties that affect the URL of a page has changed (e.g. PageDirectoryId, UrlSlug, LocaleId etc). This message is not triggered if the URL indirectly changes e.g. if a parent directory changes.
• PageAccessRulesUpdatedMessage: Message published when access rules have been updated on a page, including any additions, deletions or updates.
• PagePublishedMessage: Message published when a page draft is published. Note that pages can also be published when created, use PageAddedMessage to capture that event.
• PageUnPublishedMessage: Message published when a page has gone from published to draft state.
• PageDeletedMessage: Message published when a page is deleted. When a directory is deleted, all child directories and pages are also deleted which will generate multiple messages in the same batch, one for each page deleted.
• PageDraftVersionAddedMessage: Message published when a draft version is added to a page.
• PageDraftVersionUpdatedMessage: This message is published when page draft has been updated. To be notified when any part of a page changes (including page data and publish changes) you should subscribe to IPageContentUpdatedMessage.
• PageVersionDeletedMessage: Message published when a draft version of a page has been deleted.
• PageVersionBlockAddedMessage: Message published when a block has been added to a page.
• PageVersionBlockUpdatedMessage: Message published when a block has been updated on a page.
• PageVersionBlockMovedMessage: Message published when a block has been moved on a page.
• PageVersionBlockDeletedMessage: Message published when a block has been removed from a page.

Page Directories

• PageDirectoryAddedMessage: Message published when a new page directory is added.
• PageDirectoryUpdatedMessage: This message is published when the properties directly associated with a page directory have been updated.
• PageDirectoryUrlChangedMessage: Message published when properties that affect the URL of a page directory has changed (e.g. ParentPageDirectoryId or UrlSlug). This message is also triggered when the URL indirectly changes because a parent directory URL has changed.
• PageDirectoryAccessRulesUpdatedMessage: Message published when access rules have been updated on a page directory, including any additions, deletions or updates. This message is not dispatched for child directories that inherit the rule.
• PageDirectoryDeletedMessage: Message published when a page directory is deleted. When a directory is deleted, it's child directories are also deleted which will generate multiple messages in the same batch, one for each directory deleted.

Users

• UserAddedMessage: Message published when a user is added.
• UserUpdatedMessage: This message is published when a user is updated, including when a username or email address is updated, which also publishes their own more specific events UserEmailUpdatedMessage and UserUsernameUpdatedMessage.
• UserDeletedMessage: Message published when a user is deleted.
• UserActivationStatusUpdatedMessage: This message is published when a user's activation status been updated, having either been deactivated or reactivated.
• UserUsernameUpdatedMessage: This message is published when the username for a user is updated. The less specific UserUpdatedMessage is also published when a username is updated.
• UserEmailUpdatedMessage: Message published published when the email for a user is updated. The less specific UserUpdatedMessage is also published when an email is updated, and if the email address is used as a username then a UserUsernameUpdatedMessage is published too.
• UserAccountVerificationInitiatedMessage: This message is published when a user successfully initiates the account verification process via InitiateUserAccountVerificationByEmailCommand.
• UserAccountVerificationStatusUpdatedMessage: This message is published when a user's account verification status has been updated, either being marked as verified, or had the verified flag removed.
• UserSecurityStampUpdatedMessage: This message is published when the security stamp for a user is updated which happens when key user credential data changes such as a username, password or account recovery information. The message is not published when a new user is created.
• UserAccountRecoveryInitiatedMessage: This message is published when a user successfully initiates the account recovery process via InitiateUserAccountRecoveryCommand.
• UserAccountRecoveryCompletedMessage: This message is published when a user successfully completes the account recovery process via CompleteUserAccountRecoveryCommand. This command will also trigger UserPasswordUpdatedMessage.
• UserPasswordResetMessage: This message is published when a user password is reset via the admin panel or via ResetUserPasswordCommand, assigning a new temporary password. This is a separate action to the self-service account recovery flow initiated using InitiateUserAccountRecoveryCommand.
• UserPasswordUpdatedMessage: This message is published when a user password is updated by a user. This message is not published when a password is reset by an admin user.
• UserSignedInMessage This message is published when a user successfully signs in.
• UserSignedOutMessage: This message is published when a user signs out.
• UserAuthenticationFailedMessage: Triggered when an user fails to authenticate e.g. when logging in or validating a password change request.