notificationTemplates

Property description

The notificationTemplates property configures the appearance of notifications and determines whether the specified notification type will be sent out.

Minimal JSON

Nested properties

Property	Description	Values	Mandatory
key	Unique key of the asset. Used for referencing in the same package or other packages using packageKey#assetKey.	string	Yes
notificationTypeKey	Key of the notification type. For supported values, see Notification type keys.	string	Yes
notificationChannelKey	Channel which delivers the notifications. Supported values are: email: Email notifications., grouped_email: Notifications are grouped and sent out in a set interval, e.g. every 30 min., web_socket: In-app notifications.	string	Yes
titleTemplate	Notification text template. Relative parameters can be included inside { } brackets. Supported relative parameters differ depending on the notification type.	string	Yes
descriptionHtmlTemplate	Used when the notification channel is set to email or grouped_email. Mandatory only for these channels.	string	Yes* (only for emailor grouped_email)
descriptionTemplate	Notification text template with relative parameters inside {} brackets. Used only with notification channel web_socket. Displayed as the notification description.	string	No
enabled	Enables or disables sending notification. true: Default value., false: Notification won’t be sent out.	boolean	No
moduleKey	Key of the module used for the notification template. Supported values are: branching, dictionary, glossary, hidden, simple_flow	string	No
state	State of the application. Supported options are: active: The notification is visible and available to users. Default value., inactive: The notification will be created but won’t be visible anywhere.	string	No

Supported notification type key values

Notification type key	Description
anonymous_concept_approved	Notifies user that a concept or change request has been approved.
anonymous_concept_declined	Notifies user that a concept or change request has been declined.
attribute_edit	Notifies user of an attribute being edited.
attribute_value_changed	Notifies user when an attribute value changes.
automation	Notifies user as a result of an automation event. Automation notifications support the following dynamic expressions.
bulk_delete_finished	Notifies user when a bulk delete operation was completed successfully.
bulk_delete_started	Notifies user when a bulk delete operation has started.
bulk_domains_info	Provides information about bulk domain actions.
bulk_edit_finished	Notifies user when a bulk edit was completed successfully.
bulk_edit_started	Notifies user when a bulk edit has started.
bulk_edit_info	Provides information related to a bulk edit operation.
child_object_created	Notifies user that a child object has been created.
clone_object_failed	Notifies user that an object cloning process failed.
clone_object_finished	Notifies user that an object has been successfully cloned.
comment_added	Notifies user that a comment was added to an object or discussion.
concept_applied	Notifies user that a concept has been applied.
concept_applied_by_creator	Notifies user that a concept was applied by its creator.
concept_approved	Notifies user that a concept has been approved.
concept_declined	Notifies user that a concept  has been declined.
concept_remove_sharing	Notifies user that shared access to a concept was removed.
concept_shared	Notifies user that a concept has been shared with them.
db_proc_finished	Notifies user about progress or results of a database processing task.
db_proc_object_added	Notifies user about progress or results of a database processing task.
db_proc_object_deleted	Notifies user about progress or results of a database processing task.
db_proc_object_updated	Notifies user about progress or results of a database processing task.
db_proc_started	Notifies user about progress or results of a database processing task.
forgotten_password	Sends password recovery instructions to the user.
grouped_notification	Groups multiple notifications in one message.
import_finished	Notifies user that object import was completed successfully.
import_object_added	Notifies user that object import was added.
import_object_deleted	Notifies user that object import was deleted.
import_object_modified	Notifies user that object import was modified.
import_started	Notifies user that object import has started.
ingestion_report_progress	Provides progress updates for a data ingestion report.
lineage_parsing_failed	Notifies user that a lineage parsing task has failed.
lineage_parsing_finished	Notifies user that a lineage parsing task was completed successfully.
lineage_parsing_started	Notifies user that a lineage parsing task has started.
marketplace_package_delete_progress	Notifies user that the package deletion via Marketplace is in progress.
marketplace_package_version_install_progress	Notifies user that the package version installation via Marketplace is in progress.
master_hash_update	Notifies user that the master hash has been updated.
merge_request_approved	Notifies user that a merge request has been approved.
merge_request_disapproved	Notifies user that a merge request was rejected.
merge_request_resolved	Notifies user that a merge request has been resolved
merge_request_started_propagating	Notifies user that merge changes have started propagating.
model_owner_has_changed	Notifies user that the model owner has changed.
model_version_changes_approved	Notifies user that a model version change request has been approved.
model_version_changes_disapproved	Notifies user that a model version change request has been rejected.
model_version_changes_started_propagating	Notifies user that model version changes started propagating.
notification_threshold_overflow	Notifies user that notification count has exceeded the threshold.
object_all_users_workflow_has_changed	Notifies user that the workflow state changed after being approved by all required users. For more information, see Workflow Transitions.
object_modified	Notifies user that an object has been modified.
object_relation_add	Notifies user that an object relation was added.
object_relation_delete	Notifies user that an object relation was removed.
object_share	Notifies user that an object has been shared with them.
object_workflow_state_has_changed	Notifies user of a change in an object’s workflow state.
objects_export_failed	Notifies user that an object export operation has failed.
objects_export_finished	Notifies user that an object export operation was completed successfully.
objects_export_started	Notifies user that an object export operation has started.
package_delete_progress	Notifies user about progress of a package deletion.
package_synchronize_info	Provides information related to package synchronization.
package_version_install_progress	Provides information on package installation progress.
package_version_rollback_progress	Provides information on package rollback progress.
package_version_validation_progress	Provides information on package validation progress.
pwd_metadata_load_finished	Notifies user that metadata loading for a PWD file has finished.
refresh_frontend	Notifies user that a frontend refresh has been triggered.
refresh_numbering_failed	Notifies user that a numbering refresh has failed.
refresh_numbering_finished	Notifies user that a numbering refresh was completed successfully.
refresh_numbering_started	Notifies user that a numbering refresh has started.
registration	Notifies user of a successful registration.
registration_failed_app	Notifies user that app registration failed.
registration_failed_user	Notifies user that user registration failed.
report_import_progress	Provides information on the progress of a report import.
send_anonymous_concept_to_approval	Notifies approvers that an anonymous concept was submitted for approval.
send_concept_to_approval	Notifies approvers that a concept was submitted for approval.
space_modified	Notifies user that a space has been modified.
space_request_access	Notifies admins of a request to access a space.
task_finished	Notifies user that a task was completed successfully.
task_updated	Notifies user that a task has been updated.
user_added_to_group	Notifies user (admin) that another user was successfully added to a group.
user_application_tag	Notifies user they were tagged in an application.
user_assigned_to_object_attribute	Notifies user they were assigned to an object attribute.
user_assigned_to_space_attribute	Notifies user they were assigned to a space attribute.
user_comment_tag	Notifies user they were mentioned in a comment.
user_import_failed	Notifies user that user import has failed.
user_import_finished	Notifies user that user import was fiinished successfully.
user_object_relation_assigned	Notifies user that the user object relation was created successfully.
user_object_relation_assigned_in_app	Notifies user that the user object relation in an application was created successfully.
user_object_relation_assigned_in_space	Notifies user that the user object relation in a space was created successfully.
user_object_relation_unassigned	Notifies user the user object relation was deleted.
user_object_relation_unassigned_in_app	Notifies user the user object relation in an application was deleted.
user_object_relation_unassigned_in_space	Notifies user the user object relation in a space was deleted.
user_object_tag	Notifies user they were tagged on an object.
user_removed_from_group	Notifies user (admin) that another user was successfully removed from a group.
user_space_tag	Notifies user they were tagged in a space.
your_concept_was_applied	Notifies user that their concept has been applied.