---
title: "Notification"
slug: "notification"
abstract: "Overview, properties, and example for the Notification Object"
---
# Notification

A Notification object represents a notification type and a list of channels that define how the notification is sent.

It is an object with the following properties:

| Name | Type | Description |
| --- | --- | --- |
| `notificationType` | String | A string that points to an item from Option List NotificationTypes. |
| `isUserOwned` | Bool | A boolean that defines if the notification is global or assigned to a specific user. |
| `user` | Link | A link to the [User Object](https://doc.sitecore.com/ch/en/developers/cloud-dev/user.html) for which the notification applies (if user-owned). |
| `channels` | Array | An array containing per channel a channelname and an is_checked boolean. |

The following table lists supported notifications and the associated identifiers.

| Notification | Identifier |
| --- | --- |
| **Download completed** | `OrderCompleted` |
| **Download failed** | `OrderFailed` |
| **Download partially failed** | `OrderPartiallyFailed` |
| **Embeddings job completed** | `EmbeddingsJobCompleted` |
| **Embeddings job failed** | `EmbeddingsJobFailed` |
| **Enrichment with AI completed** | `EnrichmentWithAICompleted` |
| **Enrichment with AI failed** | `EnrichmentWithAIFailed` |
| **Enrichment with AI partially failed** | `EnrichmentWithAIPartiallyFailed` |
| **Entity copy completed successfully** | `CopyEntityAsyncCompleted` |
| **Entity copy completed with errors** | `CopyEntityAsyncFailed` |
| **Entity copy started** | `CopyEntityAsyncCreated` |
| **External action execution completed** | `ExternalActionExecutedSuccessfully` |
| **External action execution failed** | `ExternalActionExecutedUnSuccessfully` |
| **Import completed** | `ImportCompleted` |
| **Import failed** | `ImportFailed` |
| **Mass edit job completed** | `MassEditJobCompleted` |
| **Mass edit job failed** | `MassEditJobFailed` |
| **Mentioned in a content annotation** | `AnnotationWithMention` |
| **Mentioned in a modified comment** | `DiscussionModified` |
| **Mentioned in a new comment** | `DiscussionCreated` |
| **Print entity generation completed** | `PrintEntityGenerationCompleted` |
| **Public link conversion configuration reset** | `PublicLinkConversionConfigRes` |
| **Reporting log export completed** | `ReportingLogOrderCompleted` |
| **Reporting log export failed** | `ReportingLogOrderFailed` |
| **Sharing email failed to send** | `SharingEmailFailedToSend` |
| **Sharing email sent** | `SharingEmailSent` |
| **Subtitles completed** | `SubtitlesCompleted` |
| **Subtitles failed** | `SubtitlesFailed` |
| **Subtitles queued** | `SubtitlesQueued` |
| **Task assigned to me** | `TaskCreated` |
| **Task declined that I created** | `TaskDeclined` |
| **Task done that I created** | `TaskDone` |
| **Task reminder** | `TaskReminder` |
| **User audit log order completed** | `UserAuditLogOrderCompleted` |
| **User audit log order failed** | `UserAuditLogOrderFailed` |
| **Video indexer completed** | `VideoIndexerCompleted` |
| **Video indexer failed** | `VideoIndexerFailed` |
| **Video indexer queued** | `VideoIndexerQueued` |
| **Work assigned to me** | `WorkAssignedToMe` |

## Example

```json
{
"id": 24,
"notification_type": "ReportingLogOrderCompleted",
"notification_type_label": "Reporting log export completed",
"is_user_owned": false,
"created_on": "2018-11-29T13:`36:18`.5523368Z",
"created_by": {
"href": "https://stylelabs_example.com/api/entities/6";,
"title": "The user who created the entity"
},
"modified_on": "2026-02-03T02:`57:15`.1870867Z",
"modified_by": {
"href": "https://stylelabs_example.com/api/entities/6";,
"title": "The user who last modified the entity"
},
"channels": [
{
"channel_name": "EmailNotification",
"channel_label": "Email",
"is_checked": true
},
{
"channel_name": "RealTimeNotification",
"channel_label": "Real time",
"is_checked": true
},
{
"channel_name": "InAppNotification",
"channel_label": "In-app",
"is_checked": true
}
],
"userId": 0,
"self": {
"href": "https://stylelabs_example.com/api/notifications";,
"title": "This Notification."
}
}

```