# Notifications

> Notifications - This page outlines how to manage notifications received by users.

This Markdown file sits beside the HTML page at the same path (with a `.md` suffix). It summarizes the topic and lists links for tools and LLM context.

Companion generated at `2026-05-06T18:17:09.769748+00:00` (UTC).

## Primary page

- [Notifications](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html): Full documentation for this topic (HTML).

## Sections on this page

- [Create an entity notification channel](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#create-an-entity-notification-channel): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationchannels_create-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses): In-page section heading.
- [List notification channels related by relatedentitytype](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#list-notification-channels-related-by-relatedentitytype): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationchannels_list-parameters): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_1): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_1): In-page section heading.
- [Delete an entity notification channel by relatedentitytype](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#delete-an-entity-notification-channel-by-relatedentitytype): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationchannels_delete-parameters): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_1): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_2): In-page section heading.
- [Retrieve an entity notification channel by relatedentitytype](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#retrieve-an-entity-notification-channel-by-relatedentitytype): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationchannels_retrieve-parameters): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_2): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_2): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_3): In-page section heading.
- [Update an entity notification channel by relatedentitytype](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#update-an-entity-notification-channel-by-relatedentitytype): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_1): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationchannels_put-parameters): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_3): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_4): In-page section heading.
- [Create an entity notification policy](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#create-an-entity-notification-policy): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_2): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationpolicies_create-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_3): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_5): In-page section heading.
- [List entity notification policies by relatedentitytype](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#list-entity-notification-policies-by-relatedentitytype): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationpolicies_list-parameters): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_4): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_4): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_6): In-page section heading.
- [Delete an entity notification policy by relatedentitytype](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#delete-an-entity-notification-policy-by-relatedentitytype): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationpolicies_delete-parameters): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_5): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_7): In-page section heading.
- [Retrieve an entity notification policy by relatedentitytype](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#retrieve-an-entity-notification-policy-by-relatedentitytype): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationpolicies_retrieve-parameters): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_6): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_5): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_8): In-page section heading.
- [Update an entity notification policy by relatedentitytype](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#update-an-entity-notification-policy-by-relatedentitytype): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_3): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationpolicies_put-parameters): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_7): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_9): In-page section heading.
- [Create an entity notification policy](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#create-an-entity-notification-policy_1): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_4): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationpoliciesfromtemplate_create-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_6): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_10): In-page section heading.
- [Create an entity notification policy template](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#create-an-entity-notification-policy-template): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_5): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationpolicytemplates_create-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_7): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_11): In-page section heading.
- [List entity notification policy templates by relatedentitytype](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#list-entity-notification-policy-templates-by-relatedentitytype): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationpolicytemplates_list-parameters): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_8): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_8): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_12): In-page section heading.
- [Delete an entity notification policy template by relatedentitytype](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#delete-an-entity-notification-policy-template-by-relatedentitytype): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationpolicytemplates_delete-parameters): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_9): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_13): In-page section heading.
- [Retrieve an entity notification policy template by relatedentitytype](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#retrieve-an-entity-notification-policy-template-by-relatedentitytype): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationpolicytemplates_retrieve-parameters): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_10): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_9): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_14): In-page section heading.
- [Update an entity notification policy template by relatedentitytype](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#update-an-entity-notification-policy-template-by-relatedentitytype): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_6): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationpolicytemplates_put-parameters): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_11): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_15): In-page section heading.
- [Retrieve list of all policies that are created from this template and are visible by relatedentitytype](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#retrieve-list-of-all-policies-that-are-created-from-this-template-and-are-visible-by-relatedentitytype): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationpolicytemplatesrelatedpolicies_list-parameters): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_12): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_10): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_16): In-page section heading.
- [Get the registered model access control list by relatedentitytype](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#get-the-registered-model-access-control-list-by-relatedentitytype): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationpolicytemplatessharedroles_list-parameters): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_13): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_11): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_17): In-page section heading.
- [Update the registered model controls by relatedentitytype](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#update-the-registered-model-controls-by-relatedentitytype): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_7): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#entitynotificationpolicytemplatessharedroles_patchmany-parameters): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_14): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_18): In-page section heading.
- [List notification channel templates](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#list-notification-channel-templates): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationchanneltemplates_list-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_12): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_19): In-page section heading.
- [Create a notification channel template](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#create-a-notification-channel-template): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_8): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationchanneltemplates_create-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_13): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_20): In-page section heading.
- [Delete a notification channel template by channel ID](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#delete-a-notification-channel-template-by-channel-id): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationchanneltemplates_delete-parameters): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_21): In-page section heading.
- [Retrieve a notification channel template by channel ID](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#retrieve-a-notification-channel-template-by-channel-id): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationchanneltemplates_retrieve-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_14): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_22): In-page section heading.
- [Update a notification channel template by channel ID](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#update-a-notification-channel-template-by-channel-id): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_9): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationchanneltemplates_put-parameters): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_23): In-page section heading.
- [Retrieve list of all policy templates that are using this channel and are visible by channel ID](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#retrieve-list-of-all-policy-templates-that-are-using-this-channel-and-are-visible-by-channel-id): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationchanneltemplatespolicytemplates_list-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_15): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_24): In-page section heading.
- [Retrieve list of all policies that are created from this template and are visible by channel ID](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#retrieve-list-of-all-policies-that-are-created-from-this-template-and-are-visible-by-channel-id): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationchanneltemplatesrelatedpolicies_list-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_16): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_25): In-page section heading.
- [Get the channel template access control list by channel ID](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#get-the-channel-template-access-control-list-by-channel-id): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationchanneltemplatessharedroles_list-parameters): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_15): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_17): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_26): In-page section heading.
- [Update the channel template controls by channel ID](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#update-the-channel-template-controls-by-channel-id): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_10): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationchanneltemplatessharedroles_patchmany-parameters): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_27): In-page section heading.
- [List notification channels](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#list-notification-channels): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationchannels_list-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_18): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_28): In-page section heading.
- [Create a notification channel](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#create-a-notification-channel): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_11): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationchannels_create-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_19): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_29): In-page section heading.
- [Delete a notification channel by channel ID](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#delete-a-notification-channel-by-channel-id): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationchannels_delete-parameters): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_30): In-page section heading.
- [Retrieve a notification channel by channel ID](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#retrieve-a-notification-channel-by-channel-id): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationchannels_retrieve-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_20): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_31): In-page section heading.
- [Update a notification channel by channel ID](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#update-a-notification-channel-by-channel-id): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_12): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationchannels_put-parameters): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_32): In-page section heading.
- [Send a 6-digit verification code](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#send-a-6-digit-verification-code): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_13): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationemailchannelverification_create-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_21): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_33): In-page section heading.
- [Retrieve the status of whether the admin entered the code correctly](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#retrieve-the-status-of-whether-the-admin-entered-the-code-correctly): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_14): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationemailchannelverificationstatus_create-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_22): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_34): In-page section heading.
- [The list of event types and groups the user can include](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#the-list-of-event-types-and-groups-the-user-can-include): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationevents_list-parameters): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_16): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_23): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_35): In-page section heading.
- [List the notification logs](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#list-the-notification-logs): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationlogs_list-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_24): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_36): In-page section heading.
- [List notification policies](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#list-notification-policies): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationpolicies_list-parameters): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_17): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_25): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_37): In-page section heading.
- [Create a notification policy](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#create-a-notification-policy): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_15): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationpolicies_create-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_26): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_38): In-page section heading.
- [Delete a notification policy by policy ID](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#delete-a-notification-policy-by-policy-id): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationpolicies_delete-parameters): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_39): In-page section heading.
- [Retrieve a notification policy by policy ID](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#retrieve-a-notification-policy-by-policy-id): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationpolicies_retrieve-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_27): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_40): In-page section heading.
- [Update a notification policy by policy ID](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#update-a-notification-policy-by-policy-id): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_16): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationpolicies_put-parameters): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_41): In-page section heading.
- [The list of the ignored notifications filtered by org ID if provided](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#the-list-of-the-ignored-notifications-filtered-by-org-id-if-provided): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationpolicymutes_list-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_28): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_42): In-page section heading.
- [Create a new ignored notification](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#create-a-new-ignored-notification): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_17): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationpolicymutes_create-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_29): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_43): In-page section heading.
- [Delete the existing notification policy mute by mute ID](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#delete-the-existing-notification-policy-mute-by-mute-id): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationpolicymutes_delete-parameters): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_44): In-page section heading.
- [Test the webhook notification channel](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#test-the-webhook-notification-channel): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_18): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationwebhookchanneltests_create-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_30): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_45): In-page section heading.
- [Retrieve the status of the notification channel test by notification ID](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#retrieve-the-status-of-the-notification-channel-test-by-notification-id): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notificationwebhookchanneltests_retrieve-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_31): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_46): In-page section heading.
- [Resend the notification](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#resend-the-notification): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_19): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#notifications_create-parameters): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_47): In-page section heading.
- [Post a remote deployment event](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#post-a-remote-deployment-event): In-page section heading.
- [Body parameter](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#body-parameter_20): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#remoteevents_create-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_32): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_48): In-page section heading.
- [Delete all user notifications](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#delete-all-user-notifications): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_49): In-page section heading.
- [The list of user notifications](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#the-list-of-user-notifications): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#usernotifications_list-parameters): In-page section heading.
- [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#example-responses_33): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_50): In-page section heading.
- [Mark all as read](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#mark-all-as-read): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_51): In-page section heading.
- [Delete user notification by user notification ID](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#delete-user-notification-by-user-notification-id): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#usernotifications_delete-parameters): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_52): In-page section heading.
- [Mark as read by user notification ID](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#mark-as-read-by-user-notification-id): In-page section heading.
- [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#usernotifications_patch-parameters): In-page section heading.
- [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#responses_53): In-page section heading.
- [AccessControlV2](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_AccessControlV2): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_18): In-page section heading.
- [ChannelCreatedByResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_ChannelCreatedByResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_1): In-page section heading.
- [ChannelDREntity](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_ChannelDREntity): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_2): In-page section heading.
- [CreateRemoteEventResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_CreateRemoteEventResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_3): In-page section heading.
- [CreatedByResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_CreatedByResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_4): In-page section heading.
- [CustomerHeader](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_CustomerHeader): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_5): In-page section heading.
- [DREntity](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_DREntity): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_6): In-page section heading.
- [EntityNotificationChannel](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EntityNotificationChannel): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_7): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_19): In-page section heading.
- [EntityNotificationChannelCreate](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EntityNotificationChannelCreate): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_8): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_20): In-page section heading.
- [EntityNotificationChannelResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EntityNotificationChannelResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_9): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_21): In-page section heading.
- [EntityNotificationChannelsListResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EntityNotificationChannelsListResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_10): In-page section heading.
- [EntityNotificationPoliciesListResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EntityNotificationPoliciesListResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_11): In-page section heading.
- [EntityNotificationPoliciesTemplatesListResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EntityNotificationPoliciesTemplatesListResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_12): In-page section heading.
- [EntityNotificationPolicyCreate](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EntityNotificationPolicyCreate): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_13): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_22): In-page section heading.
- [EntityNotificationPolicyCreateFromTemplate](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EntityNotificationPolicyCreateFromTemplate): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_14): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_23): In-page section heading.
- [EntityNotificationPolicyResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EntityNotificationPolicyResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_15): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_24): In-page section heading.
- [EntityNotificationPolicyTemplateCreate](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EntityNotificationPolicyTemplateCreate): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_16): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_25): In-page section heading.
- [EntityNotificationPolicyTemplateRelatedPoliciesListResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EntityNotificationPolicyTemplateRelatedPoliciesListResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_17): In-page section heading.
- [EntityNotificationPolicyTemplateRelatedPolicyResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EntityNotificationPolicyTemplateRelatedPolicyResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_18): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_26): In-page section heading.
- [EntityNotificationPolicyTemplateResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EntityNotificationPolicyTemplateResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_19): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_27): In-page section heading.
- [EntityNotificationPolicyTemplateUpdate](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EntityNotificationPolicyTemplateUpdate): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_20): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_28): In-page section heading.
- [EntityNotificationPolicyUpdate](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EntityNotificationPolicyUpdate): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_21): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_29): In-page section heading.
- [EventGroup](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EventGroup): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_22): In-page section heading.
- [EventGroupResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EventGroupResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_23): In-page section heading.
- [EventResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EventResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_24): In-page section heading.
- [EventType](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_EventType): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_25): In-page section heading.
- [ExternalNaNPredictionsEventData](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_ExternalNaNPredictionsEventData): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_26): In-page section heading.
- [FailedInviteData](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_FailedInviteData): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_27): In-page section heading.
- [GrantAccessControlWithId](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_GrantAccessControlWithId): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_28): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_30): In-page section heading.
- [GrantAccessControlWithUsername](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_GrantAccessControlWithUsername): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_29): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_31): In-page section heading.
- [InviteJobNotificationData](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_InviteJobNotificationData): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_30): In-page section heading.
- [ModerationData](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_ModerationData): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_31): In-page section heading.
- [NotificationChannel](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationChannel): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_32): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_32): In-page section heading.
- [NotificationChannelCreate](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationChannelCreate): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_33): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_33): In-page section heading.
- [NotificationChannelResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationChannelResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_34): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_34): In-page section heading.
- [NotificationChannelTempPolicyTemplateResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationChannelTempPolicyTemplateResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_35): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_35): In-page section heading.
- [NotificationChannelTemplateCreate](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationChannelTemplateCreate): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_36): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_36): In-page section heading.
- [NotificationChannelTemplateRelatedPoliciesListResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationChannelTemplateRelatedPoliciesListResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_37): In-page section heading.
- [NotificationChannelTemplateRelatedPolicyResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationChannelTemplateRelatedPolicyResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_38): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_37): In-page section heading.
- [NotificationChannelTemplateRelatedPolicyTemplateListResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationChannelTemplateRelatedPolicyTemplateListResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_39): In-page section heading.
- [NotificationChannelTemplateResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationChannelTemplateResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_40): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_38): In-page section heading.
- [NotificationChannelTemplatesListResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationChannelTemplatesListResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_41): In-page section heading.
- [NotificationChannelUpdate](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationChannelUpdate): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_42): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_39): In-page section heading.
- [NotificationChannelWithDREntityUpdate](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationChannelWithDREntityUpdate): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_43): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_40): In-page section heading.
- [NotificationChannelsListResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationChannelsListResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_44): In-page section heading.
- [NotificationEmailChannelVerification](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationEmailChannelVerification): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_45): In-page section heading.
- [NotificationEmailChannelVerificationResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationEmailChannelVerificationResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_46): In-page section heading.
- [NotificationEmailChannelVerificationStatus](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationEmailChannelVerificationStatus): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_47): In-page section heading.
- [NotificationEmailChannelVerificationStatusResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationEmailChannelVerificationStatusResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_48): In-page section heading.
- [NotificationEventListResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationEventListResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_49): In-page section heading.
- [NotificationLog](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationLog): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_50): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_41): In-page section heading.
- [NotificationLogListDataResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationLogListDataResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_51): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_42): In-page section heading.
- [NotificationLogListResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationLogListResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_52): In-page section heading.
- [NotificationPoliciesListResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationPoliciesListResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_53): In-page section heading.
- [NotificationPolicyCreate](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationPolicyCreate): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_54): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_43): In-page section heading.
- [NotificationPolicyMuteCreate](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationPolicyMuteCreate): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_55): In-page section heading.
- [NotificationPolicyMuteListResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationPolicyMuteListResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_56): In-page section heading.
- [NotificationPolicyMuteResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationPolicyMuteResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_57): In-page section heading.
- [NotificationPolicyResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationPolicyResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_58): In-page section heading.
- [NotificationPolicyUpdate](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationPolicyUpdate): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_59): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_44): In-page section heading.
- [NotificationResend](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationResend): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_60): In-page section heading.
- [NotificationWebhookChannelStatusResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationWebhookChannelStatusResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_61): In-page section heading.
- [NotificationWebhookChannelTestCreate](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationWebhookChannelTestCreate): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_62): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_45): In-page section heading.
- [NotificationWebhookChannelTestId](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_NotificationWebhookChannelTestId): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_63): In-page section heading.
- [PredictionRemoteEventData](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_PredictionRemoteEventData): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_64): In-page section heading.
- [RemoteEventCreate](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_RemoteEventCreate): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_65): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_46): In-page section heading.
- [RemoteEventData](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_RemoteEventData): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_66): In-page section heading.
- [RequestNotification](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_RequestNotification): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_67): In-page section heading.
- [ResponseNotification](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_ResponseNotification): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_68): In-page section heading.
- [SharedRolesUpdate](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_SharedRolesUpdate): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_69): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_47): In-page section heading.
- [SharingListV2Response](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_SharingListV2Response): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_70): In-page section heading.
- [SpoolerChannelEventData](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_SpoolerChannelEventData): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_71): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_48): In-page section heading.
- [SuccessfulInviteData](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_SuccessfulInviteData): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_72): In-page section heading.
- [UserNotificationListResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_UserNotificationListResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_73): In-page section heading.
- [UserNotificationRelatedCommentResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_UserNotificationRelatedCommentResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_74): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_49): In-page section heading.
- [UserNotificationRelatedDeploymentResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_UserNotificationRelatedDeploymentResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_75): In-page section heading.
- [UserNotificationRelatedProjectResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_UserNotificationRelatedProjectResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_76): In-page section heading.
- [UserNotificationRelatedSecureConfigResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_UserNotificationRelatedSecureConfigResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_77): In-page section heading.
- [UserNotificationRelatedUserResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_UserNotificationRelatedUserResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_78): In-page section heading.
- [UserNotificationRelatedUsersDeleteResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_UserNotificationRelatedUsersDeleteResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_79): In-page section heading.
- [UserNotificationResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#tocS_UserNotificationResponse): In-page section heading.
- [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#properties_80): In-page section heading.
- [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/notifications.html#enumerated-values_50): In-page section heading.

## Related documentation

- [Developer documentation](https://docs.datarobot.com/en/docs/api/index.html): Linked from this page.
- [API reference](https://docs.datarobot.com/en/docs/api/reference/index.html): Linked from this page.
- [REST API](https://docs.datarobot.com/en/docs/api/reference/public-api/index.html): Linked from this page.
- [Secure and govern](https://docs.datarobot.com/en/docs/api/reference/public-api/tag-govern.html): Linked from this page.

## Documentation content

This page outlines how to manage notifications received by users.

## Create an entity notification channel

Operation path: `POST /api/v2/entityNotificationChannels/`

Authentication requirements: `BearerAuth`

Create a new entity notification channel.

### Body parameter

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "DataRobotCustomJob",
        "DataRobotGroup",
        "DataRobotUser",
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "drEntities": {
      "description": "The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the DataRobot entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "maxLength": 100,
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The id of organization that notification channel belongs to.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityId": {
      "description": "The ID of the related entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "verificationCode": {
      "description": "Required if the channel type is Email.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "channelType",
    "name",
    "relatedEntityId",
    "relatedEntityType"
  ],
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| body | body | EntityNotificationChannelCreate | false | none |

### Example responses

> 201 Response

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "DataRobotCustomJob",
        "DataRobotGroup",
        "DataRobotUser",
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "createdAt": {
      "description": "The date of the notification channel creation.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "drEntities": {
      "description": "The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the DataRobot entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "id": {
      "description": "The ID of the notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "lastNotificationAt": {
      "description": "The timestamp of the last notification sent to the channel.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The id of organization that notification channel belongs to.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "policyCount": {
      "description": "The count of policies assigned to the channel.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "relatedEntityId": {
      "description": "The ID of the related entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "uid": {
      "description": "The identifier of the user who created the channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "updatedAt": {
      "description": "The date when the channel was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": [
        "boolean",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "channelType",
    "contentType",
    "createdAt",
    "customHeaders",
    "emailAddress",
    "id",
    "languageCode",
    "lastNotificationAt",
    "name",
    "orgId",
    "payloadUrl",
    "policyCount",
    "relatedEntityId",
    "relatedEntityType",
    "secretToken",
    "uid",
    "updatedAt",
    "validateSsl"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 201 | Created | The entity notification channel was created successfully. | EntityNotificationChannelResponse |

## List notification channels related by relatedentitytype

Operation path: `GET /api/v2/entityNotificationChannels/{relatedEntityType}/{relatedEntityId}/`

Authentication requirements: `BearerAuth`

List the notification channels related to the entity according to the query.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| offset | query | integer | true | The number of notification channels to skip. |
| limit | query | integer | true | The maximum number of notification channels to return. |
| namePart | query | string | false | Only return the notification channels whose names contain the given substring. |
| relatedEntityId | path | string | true | The ID of the related entity. |
| relatedEntityType | path | string | true | The type of the related entity. |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "The number of channels returned.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "The notification entity channels.",
      "items": {
        "properties": {
          "channelType": {
            "description": "The type of the new notification channel.",
            "enum": [
              "DataRobotCustomJob",
              "DataRobotGroup",
              "DataRobotUser",
              "Database",
              "Email",
              "InApp",
              "InsightsComputations",
              "MSTeams",
              "Slack",
              "Webhook"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "contentType": {
            "description": "The content type of the messages of the new notification channel.",
            "enum": [
              "application/json",
              "application/x-www-form-urlencoded"
            ],
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "createdAt": {
            "description": "The date of the notification channel creation.",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "customHeaders": {
            "description": "Custom headers and their values to be sent in the new notification channel.",
            "items": {
              "properties": {
                "name": {
                  "description": "The name of the header.",
                  "type": "string"
                },
                "value": {
                  "description": "The value of the header.",
                  "type": "string"
                }
              },
              "required": [
                "name",
                "value"
              ],
              "type": "object"
            },
            "maxItems": 100,
            "type": "array",
            "x-versionadded": "v2.33"
          },
          "drEntities": {
            "description": "The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.",
            "items": {
              "properties": {
                "id": {
                  "description": "The ID of the DataRobot entity.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                },
                "name": {
                  "description": "The name of the entity.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                }
              },
              "required": [
                "id",
                "name"
              ],
              "type": "object"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array",
            "x-versionadded": "v2.33"
          },
          "emailAddress": {
            "description": "The email address to be used in the new notification channel.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "id": {
            "description": "The ID of the notification channel.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "languageCode": {
            "description": "The preferred language code.",
            "enum": [
              "en",
              "es_419",
              "fr",
              "ja",
              "ko",
              "ptBR"
            ],
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "lastNotificationAt": {
            "description": "The timestamp of the last notification sent to the channel.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the new notification channel.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "orgId": {
            "description": "The id of organization that notification channel belongs to.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "payloadUrl": {
            "description": "The payload URL of the new notification channel.",
            "format": "uri",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "policyCount": {
            "description": "The count of policies assigned to the channel.",
            "type": "integer",
            "x-versionadded": "v2.33"
          },
          "relatedEntityId": {
            "description": "The ID of the related entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedEntityType": {
            "description": "The type of the related entity.",
            "enum": [
              "deployment",
              "Deployment",
              "DEPLOYMENT",
              "customjob",
              "Customjob",
              "CUSTOMJOB"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "secretToken": {
            "description": "Secret token to be used for new notification channel.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "uid": {
            "description": "The identifier of the user who created the channel.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "updatedAt": {
            "description": "The date when the channel was updated.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "validateSsl": {
            "description": "Defines if  validate ssl or not in the notification channel.",
            "type": [
              "boolean",
              "null"
            ],
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "channelType",
          "contentType",
          "createdAt",
          "customHeaders",
          "emailAddress",
          "id",
          "languageCode",
          "lastNotificationAt",
          "name",
          "orgId",
          "payloadUrl",
          "policyCount",
          "relatedEntityId",
          "relatedEntityType",
          "secretToken",
          "uid",
          "updatedAt",
          "validateSsl"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "The total number of channels that satisfy the query.",
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | The entity notification channels were listed successfully. | EntityNotificationChannelsListResponse |

## Delete an entity notification channel by relatedentitytype

Operation path: `DELETE /api/v2/entityNotificationChannels/{relatedEntityType}/{relatedEntityId}/{channelId}/`

Authentication requirements: `BearerAuth`

Delete the entity notification channel.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| channelId | path | string | true | The ID of the entity notification channel. |
| relatedEntityId | path | string | true | The ID of the related entity. |
| relatedEntityType | path | string | true | The type of the related entity. |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | The entity notification channel was deleted successfully. | None |

## Retrieve an entity notification channel by relatedentitytype

Operation path: `GET /api/v2/entityNotificationChannels/{relatedEntityType}/{relatedEntityId}/{channelId}/`

Authentication requirements: `BearerAuth`

Retrieve the entity notification channel.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| channelId | path | string | true | The ID of the entity notification channel. |
| relatedEntityId | path | string | true | The ID of the related entity. |
| relatedEntityType | path | string | true | The type of the related entity. |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

### Example responses

> 200 Response

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "DataRobotCustomJob",
        "DataRobotGroup",
        "DataRobotUser",
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "createdAt": {
      "description": "The date of the notification channel creation.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "drEntities": {
      "description": "The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the DataRobot entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "id": {
      "description": "The ID of the notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "lastNotificationAt": {
      "description": "The timestamp of the last notification sent to the channel.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The id of organization that notification channel belongs to.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "policyCount": {
      "description": "The count of policies assigned to the channel.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "relatedEntityId": {
      "description": "The ID of the related entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "uid": {
      "description": "The identifier of the user who created the channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "updatedAt": {
      "description": "The date when the channel was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": [
        "boolean",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "channelType",
    "contentType",
    "createdAt",
    "customHeaders",
    "emailAddress",
    "id",
    "languageCode",
    "lastNotificationAt",
    "name",
    "orgId",
    "payloadUrl",
    "policyCount",
    "relatedEntityId",
    "relatedEntityType",
    "secretToken",
    "uid",
    "updatedAt",
    "validateSsl"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | Entity notification channel retrieved successfully. | EntityNotificationChannelResponse |

## Update an entity notification channel by relatedentitytype

Operation path: `PUT /api/v2/entityNotificationChannels/{relatedEntityType}/{relatedEntityId}/{channelId}/`

Authentication requirements: `BearerAuth`

Update the entity notification channel.

### Body parameter

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "DataRobotCustomJob",
        "DataRobotGroup",
        "DataRobotUser",
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "drEntities": {
      "description": "The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the DataRobot entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "maxLength": 100,
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "verificationCode": {
      "description": "Required if the channel type is Email.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| channelId | path | string | true | The ID of the entity notification channel. |
| relatedEntityId | path | string | true | The ID of the related entity. |
| relatedEntityType | path | string | true | The type of the related entity. |
| body | body | NotificationChannelWithDREntityUpdate | false | none |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | The entity notification channel was updated successfully. | None |
| 400 | Bad Request | Email verification code is invalid. | None |

## Create an entity notification policy

Operation path: `POST /api/v2/entityNotificationPolicies/`

Authentication requirements: `BearerAuth`

Create a new entity notification policy.

### Body parameter

```
{
  "properties": {
    "active": {
      "description": "Whether the notification policy is active or not.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "channelScope": {
      "description": "Scope of the channel.",
      "enum": [
        "organization",
        "Organization",
        "ORGANIZATION",
        "entity",
        "Entity",
        "ENTITY",
        "template",
        "Template",
        "TEMPLATE"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "enum": [
        "secure_config.all",
        "dataset.all",
        "file.all",
        "comment.all",
        "invite_job.all",
        "deployment_prediction_explanations_computation.all",
        "model_deployments.critical_health",
        "model_deployments.critical_frequent_health_change",
        "model_deployments.frequent_health_change",
        "model_deployments.health",
        "model_deployments.retraining_policy",
        "inference_endpoints.health",
        "model_deployments.management_agent",
        "model_deployments.management_agent_health",
        "prediction_request.all",
        "challenger_management.all",
        "challenger_replay.all",
        "model_deployments.all",
        "project.all",
        "perma_delete_project.all",
        "users_delete.all",
        "applications.all",
        "model_version.stage_transitions",
        "model_version.all",
        "use_case.all",
        "batch_predictions.all",
        "change_requests.all",
        "custom_job_run.all",
        "custom_job_run.unsuccessful",
        "insights_computation.all",
        "notebook_schedule.all",
        "monitoring.all"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "enum": [
        "secure_config.created",
        "secure_config.deleted",
        "secure_config.shared",
        "dataset.created",
        "dataset.registered",
        "dataset.deleted",
        "datasets.deleted",
        "datasetrelationship.created",
        "dataset.shared",
        "datasets.shared",
        "file.created",
        "file.registered",
        "file.deleted",
        "file.shared",
        "comment.created",
        "comment.updated",
        "invite_job.completed",
        "misc.asset_access_request",
        "misc.webhook_connection_test",
        "misc.webhook_resend",
        "misc.email_verification",
        "monitoring.spooler_channel_base",
        "monitoring.spooler_channel_red",
        "monitoring.spooler_channel_green",
        "monitoring.external_model_nan_predictions",
        "management.deploymentInfo",
        "model_deployments.None",
        "model_deployments.deployment_sharing",
        "model_deployments.model_replacement",
        "prediction_request.None",
        "prediction_request.failed",
        "model_deployments.humility_rule",
        "model_deployments.model_replacement_lifecycle",
        "model_deployments.model_replacement_started",
        "model_deployments.model_replacement_succeeded",
        "model_deployments.model_replacement_failed",
        "model_deployments.model_replacement_validation_warning",
        "model_deployments.deployment_creation",
        "model_deployments.deployment_deletion",
        "model_deployments.service_health_yellow_from_green",
        "model_deployments.service_health_yellow_from_red",
        "model_deployments.service_health_red",
        "model_deployments.data_drift_yellow_from_green",
        "model_deployments.data_drift_yellow_from_red",
        "model_deployments.data_drift_red",
        "model_deployments.accuracy_yellow_from_green",
        "model_deployments.accuracy_yellow_from_red",
        "model_deployments.accuracy_red",
        "model_deployments.health.fairness_health.green_to_yellow",
        "model_deployments.health.fairness_health.red_to_yellow",
        "model_deployments.health.fairness_health.red",
        "model_deployments.health.custom_metrics_health.green_to_yellow",
        "model_deployments.health.custom_metrics_health.red_to_yellow",
        "model_deployments.health.custom_metrics_health.red",
        "model_deployments.health.base.green",
        "model_deployments.service_health_green",
        "model_deployments.data_drift_green",
        "model_deployments.accuracy_green",
        "model_deployments.health.fairness_health.green",
        "model_deployments.health.custom_metrics_health.green",
        "model_deployments.retraining_policy_run_started",
        "model_deployments.retraining_policy_run_succeeded",
        "model_deployments.retraining_policy_run_failed",
        "model_deployments.challenger_scoring_success",
        "model_deployments.challenger_scoring_data_warning",
        "model_deployments.challenger_scoring_failure",
        "model_deployments.challenger_scoring_started",
        "model_deployments.challenger_model_validation_warning",
        "model_deployments.challenger_model_created",
        "model_deployments.challenger_model_deleted",
        "model_deployments.actuals_upload_failed",
        "model_deployments.actuals_upload_warning",
        "model_deployments.training_data_baseline_calculation_started",
        "model_deployments.training_data_baseline_calculation_completed",
        "model_deployments.training_data_baseline_failed",
        "model_deployments.custom_model_deployment_creation_started",
        "model_deployments.custom_model_deployment_creation_completed",
        "model_deployments.custom_model_deployment_creation_failed",
        "model_deployments.custom_model_deployment_secure_config_failure",
        "model_deployments.deployment_prediction_explanations_preview_job_submitted",
        "model_deployments.deployment_prediction_explanations_preview_job_completed",
        "model_deployments.deployment_prediction_explanations_preview_job_failed",
        "model_deployments.custom_model_deployment_activated",
        "model_deployments.custom_model_deployment_activation_failed",
        "model_deployments.custom_model_deployment_deactivated",
        "model_deployments.custom_model_deployment_deactivation_failed",
        "model_deployments.prediction_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_warning",
        "model_deployments.actuals_processing_rate_limit_reached",
        "model_deployments.actuals_processing_rate_limit_warning",
        "model_deployments.deployment_monitoring_data_cleared",
        "model_deployments.deployment_launch_started",
        "model_deployments.deployment_launch_succeeded",
        "model_deployments.deployment_launch_failed",
        "model_deployments.deployment_shutdown_started",
        "model_deployments.deployment_shutdown_succeeded",
        "model_deployments.deployment_shutdown_failed",
        "model_deployments.endpoint_update_started",
        "model_deployments.endpoint_update_succeeded",
        "model_deployments.endpoint_update_failed",
        "model_deployments.management_agent_service_health_green",
        "model_deployments.management_agent_service_health_yellow",
        "model_deployments.management_agent_service_health_red",
        "model_deployments.management_agent_service_health_unknown",
        "model_deployments.predictions_missing_association_id",
        "model_deployments.prediction_result_rows_cleand_up",
        "model_deployments.batch_deleted",
        "model_deployments.batch_creation_limit_reached",
        "model_deployments.batch_creation_limit_exceeded",
        "model_deployments.batch_not_found",
        "model_deployments.predictions_encountered_for_locked_batch",
        "model_deployments.predictions_encountered_for_deleted_batch",
        "model_deployments.scheduled_report_generated",
        "model_deployments.predictions_timeliness_health_red",
        "model_deployments.actuals_timeliness_health_red",
        "model_deployments.service_health_still_red",
        "model_deployments.data_drift_still_red",
        "model_deployments.accuracy_still_red",
        "model_deployments.health.fairness_health.still_red",
        "model_deployments.health.custom_metrics_health.still_red",
        "model_deployments.predictions_timeliness_health_still_red",
        "model_deployments.actuals_timeliness_health_still_red",
        "model_deployments.service_health_still_yellow",
        "model_deployments.data_drift_still_yellow",
        "model_deployments.accuracy_still_yellow",
        "model_deployments.health.fairness_health.still_yellow",
        "model_deployments.health.custom_metrics_health.still_yellow",
        "model_deployments.prediction_payload_parsing_failure",
        "model_deployments.deployment_inference_server_creation_started",
        "model_deployments.deployment_inference_server_creation_failed",
        "model_deployments.deployment_inference_server_creation_completed",
        "model_deployments.deployment_inference_server_deletion",
        "model_deployments.deployment_inference_server_idle_stopped",
        "model_deployments.deployment_inference_server_maintenance_started",
        "entity_notification_policy_template.shared",
        "notification_channel_template.shared",
        "project.created",
        "project.deleted",
        "project.shared",
        "autopilot.complete",
        "autopilot.started",
        "autostart.failure",
        "perma_delete_project.success",
        "perma_delete_project.failure",
        "users_delete.preview_started",
        "users_delete.preview_completed",
        "users_delete.preview_failed",
        "users_delete.started",
        "users_delete.completed",
        "users_delete.failed",
        "application.created",
        "application.shared",
        "model_version.added",
        "model_version.stage_transition_from_registered_to_development",
        "model_version.stage_transition_from_registered_to_staging",
        "model_version.stage_transition_from_registered_to_production",
        "model_version.stage_transition_from_registered_to_archived",
        "model_version.stage_transition_from_development_to_registered",
        "model_version.stage_transition_from_development_to_staging",
        "model_version.stage_transition_from_development_to_production",
        "model_version.stage_transition_from_development_to_archived",
        "model_version.stage_transition_from_staging_to_registered",
        "model_version.stage_transition_from_staging_to_development",
        "model_version.stage_transition_from_staging_to_production",
        "model_version.stage_transition_from_staging_to_archived",
        "model_version.stage_transition_from_production_to_registered",
        "model_version.stage_transition_from_production_to_development",
        "model_version.stage_transition_from_production_to_staging",
        "model_version.stage_transition_from_production_to_archived",
        "model_version.stage_transition_from_archived_to_registered",
        "model_version.stage_transition_from_archived_to_development",
        "model_version.stage_transition_from_archived_to_production",
        "model_version.stage_transition_from_archived_to_staging",
        "use_case.shared",
        "batch_predictions.success",
        "batch_predictions.failed",
        "batch_predictions.scheduler.auto_disabled",
        "change_request.cancelled",
        "change_request.created",
        "change_request.deployment_approval_requested",
        "change_request.resolved",
        "change_request.proposed_changes_updated",
        "change_request.pending",
        "change_request.commenting_review_added",
        "change_request.approving_review_added",
        "change_request.changes_requesting_review_added",
        "custom_job_run.success",
        "custom_job_run.failed",
        "custom_job_run.interrupted",
        "custom_job_run.cancelled",
        "prediction_explanations_computation.None",
        "prediction_explanations_computation.prediction_explanations_preview_job_submitted",
        "prediction_explanations_computation.prediction_explanations_preview_job_completed",
        "prediction_explanations_computation.prediction_explanations_preview_job_failed",
        "monitoring.rate_limit_enforced",
        "notebook_schedule.created",
        "notebook_schedule.failure",
        "notebook_schedule.completed",
        "abstract",
        "moderation.metric.creation_error",
        "moderation.metric.reporting_error",
        "moderation.model.moderation_started",
        "moderation.model.moderation_completed",
        "moderation.model.pre_score_phase_started",
        "moderation.model.pre_score_phase_completed",
        "moderation.model.post_score_phase_started",
        "moderation.model.post_score_phase_completed",
        "moderation.model.config_error",
        "moderation.model.runtime_error",
        "moderation.model.scoring_started",
        "moderation.model.scoring_completed",
        "moderation.model.scoring_error"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "maximalFrequency": {
      "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification policy.",
      "maxLength": 100,
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The ID of the organization that owns the notification policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityId": {
      "description": "The id of related entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "channelId",
    "channelScope",
    "name",
    "relatedEntityId",
    "relatedEntityType"
  ],
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| body | body | EntityNotificationPolicyCreate | false | none |

### Example responses

> 201 Response

```
{
  "properties": {
    "active": {
      "description": "Defines if the notification policy is active or not.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "channel": {
      "description": "The notification channel information used to send the notification.",
      "properties": {
        "channelType": {
          "description": "The type of the new notification channel.",
          "enum": [
            "DataRobotCustomJob",
            "DataRobotGroup",
            "DataRobotUser",
            "Database",
            "Email",
            "InApp",
            "InsightsComputations",
            "MSTeams",
            "Slack",
            "Webhook"
          ],
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "contentType": {
          "description": "The content type of the messages of the new notification channel.",
          "enum": [
            "application/json",
            "application/x-www-form-urlencoded"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "createdAt": {
          "description": "The date of the notification channel creation.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "customHeaders": {
          "description": "Custom headers and their values to be sent in the new notification channel.",
          "items": {
            "properties": {
              "name": {
                "description": "The name of the header.",
                "type": "string"
              },
              "value": {
                "description": "The value of the header.",
                "type": "string"
              }
            },
            "required": [
              "name",
              "value"
            ],
            "type": "object"
          },
          "maxItems": 100,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "drEntities": {
          "description": "The ids of DataRobot Users or Group for DataRobotUser or DataRobotGroup channel types.",
          "items": {
            "properties": {
              "id": {
                "description": "The id of DataRobot entity.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "name": {
                "description": "The name of the entity.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "id",
              "name"
            ],
            "type": "object"
          },
          "maxItems": 100,
          "minItems": 1,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "emailAddress": {
          "description": "The email address to be used in the new notification channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "id": {
          "description": "The ID of the notification channel.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "languageCode": {
          "description": "The preferred language code.",
          "enum": [
            "en",
            "es_419",
            "fr",
            "ja",
            "ko",
            "ptBR"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "name": {
          "description": "The name of the new notification channel.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "orgId": {
          "description": "The ID of the organization that the notification channel belongs to.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "payloadUrl": {
          "description": "The payload URL of the new notification channel.",
          "format": "uri",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "relatedEntityId": {
          "description": "The id of related entity.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "relatedEntityType": {
          "description": "Type of related entity.",
          "enum": [
            "deployment",
            "Deployment",
            "DEPLOYMENT",
            "customjob",
            "Customjob",
            "CUSTOMJOB"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "secretToken": {
          "description": "Secret token to be used for new notification channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "uid": {
          "description": "The identifier of the user who created the channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "updatedAt": {
          "description": "The date when the channel was updated.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "validateSsl": {
          "description": "Whether to validate SSL for the notification channel.",
          "type": [
            "boolean",
            "null"
          ],
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "channelType",
        "contentType",
        "createdAt",
        "customHeaders",
        "emailAddress",
        "id",
        "languageCode",
        "name",
        "orgId",
        "payloadUrl",
        "secretToken",
        "uid",
        "updatedAt",
        "validateSsl"
      ],
      "type": "object"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "channelScope": {
      "description": "Scope of the channel.",
      "enum": [
        "organization",
        "Organization",
        "ORGANIZATION",
        "entity",
        "Entity",
        "ENTITY",
        "template",
        "Template",
        "TEMPLATE"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "created": {
      "description": "The date when the policy was created.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "properties": {
        "events": {
          "description": "The events included in this group.",
          "items": {
            "description": "The type of the event that triggers the notification.",
            "properties": {
              "id": {
                "description": "The ID of the event type.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event type.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "label"
            ],
            "type": "object"
          },
          "maxItems": 1000,
          "type": "array"
        },
        "id": {
          "description": "The ID of the event group.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event group.",
          "type": "string"
        }
      },
      "required": [
        "events",
        "id",
        "label"
      ],
      "type": "object"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "properties": {
        "id": {
          "description": "The ID of the event type.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event type.",
          "type": "string"
        }
      },
      "required": [
        "id",
        "label"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "lastTriggered": {
      "description": "The date when the last notification with the policy was triggered.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "maximalFrequency": {
      "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the notification policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The ID of the organization that owns the notification policy.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "relatedEntityId": {
      "description": "The id of related entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "templateId": {
      "description": "The id of template.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "uid": {
      "description": "The identifier of the user who created the policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "updatedAt": {
      "description": "The date when the policy was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "active",
    "channel",
    "channelId",
    "channelScope",
    "created",
    "eventGroup",
    "eventType",
    "id",
    "lastTriggered",
    "name",
    "orgId",
    "relatedEntityId",
    "relatedEntityType",
    "templateId",
    "uid",
    "updatedAt"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 201 | Created | Entity notification policy created successfully. | EntityNotificationPolicyResponse |

## List entity notification policies by relatedentitytype

Operation path: `GET /api/v2/entityNotificationPolicies/{relatedEntityType}/{relatedEntityId}/`

Authentication requirements: `BearerAuth`

List the entity notification policies that satisfy the query condition.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| offset | query | integer | true | How many notification channels to skip. |
| limit | query | integer | true | At most this many notification channels to return. |
| channelId | query | string | false | Return policies with this channel. |
| namePart | query | string | false | Only return the notification channels whose names contain the given substring. |
| eventGroup | query | string | false | Return policies with this event group. |
| channelScope | query | string | false | Scope of the channel. |
| relatedEntityId | path | string | true | The id of related entity. |
| relatedEntityType | path | string | true | The type of the related entity. |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| eventGroup | [secure_config.all, dataset.all, file.all, comment.all, invite_job.all, deployment_prediction_explanations_computation.all, model_deployments.critical_health, model_deployments.critical_frequent_health_change, model_deployments.frequent_health_change, model_deployments.health, model_deployments.retraining_policy, inference_endpoints.health, model_deployments.management_agent, model_deployments.management_agent_health, prediction_request.all, challenger_management.all, challenger_replay.all, model_deployments.all, project.all, perma_delete_project.all, users_delete.all, applications.all, model_version.stage_transitions, model_version.all, use_case.all, batch_predictions.all, change_requests.all, custom_job_run.all, custom_job_run.unsuccessful, insights_computation.all, notebook_schedule.all, monitoring.all] |
| channelScope | [organization, Organization, ORGANIZATION, entity, Entity, ENTITY, template, Template, TEMPLATE] |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "The number of entity policies returned.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "The entity notification policies.",
      "items": {
        "properties": {
          "active": {
            "description": "Defines if the notification policy is active or not.",
            "type": "boolean",
            "x-versionadded": "v2.33"
          },
          "channel": {
            "description": "The notification channel information used to send the notification.",
            "properties": {
              "channelType": {
                "description": "The type of the new notification channel.",
                "enum": [
                  "DataRobotCustomJob",
                  "DataRobotGroup",
                  "DataRobotUser",
                  "Database",
                  "Email",
                  "InApp",
                  "InsightsComputations",
                  "MSTeams",
                  "Slack",
                  "Webhook"
                ],
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "contentType": {
                "description": "The content type of the messages of the new notification channel.",
                "enum": [
                  "application/json",
                  "application/x-www-form-urlencoded"
                ],
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "createdAt": {
                "description": "The date of the notification channel creation.",
                "format": "date-time",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "customHeaders": {
                "description": "Custom headers and their values to be sent in the new notification channel.",
                "items": {
                  "properties": {
                    "name": {
                      "description": "The name of the header.",
                      "type": "string"
                    },
                    "value": {
                      "description": "The value of the header.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "name",
                    "value"
                  ],
                  "type": "object"
                },
                "maxItems": 100,
                "type": "array",
                "x-versionadded": "v2.33"
              },
              "drEntities": {
                "description": "The ids of DataRobot Users or Group for DataRobotUser or DataRobotGroup channel types.",
                "items": {
                  "properties": {
                    "id": {
                      "description": "The id of DataRobot entity.",
                      "type": "string",
                      "x-versionadded": "v2.33"
                    },
                    "name": {
                      "description": "The name of the entity.",
                      "type": "string",
                      "x-versionadded": "v2.33"
                    }
                  },
                  "required": [
                    "id",
                    "name"
                  ],
                  "type": "object"
                },
                "maxItems": 100,
                "minItems": 1,
                "type": "array",
                "x-versionadded": "v2.33"
              },
              "emailAddress": {
                "description": "The email address to be used in the new notification channel.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "id": {
                "description": "The ID of the notification channel.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "languageCode": {
                "description": "The preferred language code.",
                "enum": [
                  "en",
                  "es_419",
                  "fr",
                  "ja",
                  "ko",
                  "ptBR"
                ],
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "name": {
                "description": "The name of the new notification channel.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "orgId": {
                "description": "The ID of the organization that the notification channel belongs to.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "payloadUrl": {
                "description": "The payload URL of the new notification channel.",
                "format": "uri",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "relatedEntityId": {
                "description": "The id of related entity.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "relatedEntityType": {
                "description": "Type of related entity.",
                "enum": [
                  "deployment",
                  "Deployment",
                  "DEPLOYMENT",
                  "customjob",
                  "Customjob",
                  "CUSTOMJOB"
                ],
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "secretToken": {
                "description": "Secret token to be used for new notification channel.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "uid": {
                "description": "The identifier of the user who created the channel.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "updatedAt": {
                "description": "The date when the channel was updated.",
                "format": "date-time",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "validateSsl": {
                "description": "Whether to validate SSL for the notification channel.",
                "type": [
                  "boolean",
                  "null"
                ],
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "channelType",
              "contentType",
              "createdAt",
              "customHeaders",
              "emailAddress",
              "id",
              "languageCode",
              "name",
              "orgId",
              "payloadUrl",
              "secretToken",
              "uid",
              "updatedAt",
              "validateSsl"
            ],
            "type": "object"
          },
          "channelId": {
            "description": "The ID of the notification channel to be used to send the notification.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "channelScope": {
            "description": "Scope of the channel.",
            "enum": [
              "organization",
              "Organization",
              "ORGANIZATION",
              "entity",
              "Entity",
              "ENTITY",
              "template",
              "Template",
              "TEMPLATE"
            ],
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "created": {
            "description": "The date when the policy was created.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "eventGroup": {
            "description": "The group of the event that triggers the notification.",
            "properties": {
              "events": {
                "description": "The events included in this group.",
                "items": {
                  "description": "The type of the event that triggers the notification.",
                  "properties": {
                    "id": {
                      "description": "The ID of the event type.",
                      "type": "string"
                    },
                    "label": {
                      "description": "The display name of the event type.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "label"
                  ],
                  "type": "object"
                },
                "maxItems": 1000,
                "type": "array"
              },
              "id": {
                "description": "The ID of the event group.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event group.",
                "type": "string"
              }
            },
            "required": [
              "events",
              "id",
              "label"
            ],
            "type": "object"
          },
          "eventType": {
            "description": "The type of the event that triggers the notification.",
            "properties": {
              "id": {
                "description": "The ID of the event type.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event type.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "label"
            ],
            "type": "object"
          },
          "id": {
            "description": "The ID of the policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "lastTriggered": {
            "description": "The date when the last notification with the policy was triggered.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "maximalFrequency": {
            "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the notification policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "orgId": {
            "description": "The ID of the organization that owns the notification policy.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "relatedEntityId": {
            "description": "The id of related entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedEntityType": {
            "description": "The type of the related entity.",
            "enum": [
              "deployment",
              "Deployment",
              "DEPLOYMENT",
              "customjob",
              "Customjob",
              "CUSTOMJOB"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "templateId": {
            "description": "The id of template.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "uid": {
            "description": "The identifier of the user who created the policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "updatedAt": {
            "description": "The date when the policy was updated.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "active",
          "channel",
          "channelId",
          "channelScope",
          "created",
          "eventGroup",
          "eventType",
          "id",
          "lastTriggered",
          "name",
          "orgId",
          "relatedEntityId",
          "relatedEntityType",
          "templateId",
          "uid",
          "updatedAt"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "The total number of entity policies that satisfy the query.",
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | Entity notification policies listed successfully. | EntityNotificationPoliciesListResponse |

## Delete an entity notification policy by relatedentitytype

Operation path: `DELETE /api/v2/entityNotificationPolicies/{relatedEntityType}/{relatedEntityId}/{policyId}/`

Authentication requirements: `BearerAuth`

Delete the entity notification policy.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| policyId | path | string | true | The ID of the notification policy. |
| relatedEntityId | path | string | true | The id of related entity. |
| relatedEntityType | path | string | true | The type of the related entity. |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | Entity notification policy deleted successfully. | None |

## Retrieve an entity notification policy by relatedentitytype

Operation path: `GET /api/v2/entityNotificationPolicies/{relatedEntityType}/{relatedEntityId}/{policyId}/`

Authentication requirements: `BearerAuth`

Retrieve the entity notification policy.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| policyId | path | string | true | The ID of the notification policy. |
| relatedEntityId | path | string | true | The id of related entity. |
| relatedEntityType | path | string | true | The type of the related entity. |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

### Example responses

> 200 Response

```
{
  "properties": {
    "active": {
      "description": "Defines if the notification policy is active or not.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "channel": {
      "description": "The notification channel information used to send the notification.",
      "properties": {
        "channelType": {
          "description": "The type of the new notification channel.",
          "enum": [
            "DataRobotCustomJob",
            "DataRobotGroup",
            "DataRobotUser",
            "Database",
            "Email",
            "InApp",
            "InsightsComputations",
            "MSTeams",
            "Slack",
            "Webhook"
          ],
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "contentType": {
          "description": "The content type of the messages of the new notification channel.",
          "enum": [
            "application/json",
            "application/x-www-form-urlencoded"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "createdAt": {
          "description": "The date of the notification channel creation.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "customHeaders": {
          "description": "Custom headers and their values to be sent in the new notification channel.",
          "items": {
            "properties": {
              "name": {
                "description": "The name of the header.",
                "type": "string"
              },
              "value": {
                "description": "The value of the header.",
                "type": "string"
              }
            },
            "required": [
              "name",
              "value"
            ],
            "type": "object"
          },
          "maxItems": 100,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "drEntities": {
          "description": "The ids of DataRobot Users or Group for DataRobotUser or DataRobotGroup channel types.",
          "items": {
            "properties": {
              "id": {
                "description": "The id of DataRobot entity.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "name": {
                "description": "The name of the entity.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "id",
              "name"
            ],
            "type": "object"
          },
          "maxItems": 100,
          "minItems": 1,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "emailAddress": {
          "description": "The email address to be used in the new notification channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "id": {
          "description": "The ID of the notification channel.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "languageCode": {
          "description": "The preferred language code.",
          "enum": [
            "en",
            "es_419",
            "fr",
            "ja",
            "ko",
            "ptBR"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "name": {
          "description": "The name of the new notification channel.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "orgId": {
          "description": "The ID of the organization that the notification channel belongs to.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "payloadUrl": {
          "description": "The payload URL of the new notification channel.",
          "format": "uri",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "relatedEntityId": {
          "description": "The id of related entity.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "relatedEntityType": {
          "description": "Type of related entity.",
          "enum": [
            "deployment",
            "Deployment",
            "DEPLOYMENT",
            "customjob",
            "Customjob",
            "CUSTOMJOB"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "secretToken": {
          "description": "Secret token to be used for new notification channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "uid": {
          "description": "The identifier of the user who created the channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "updatedAt": {
          "description": "The date when the channel was updated.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "validateSsl": {
          "description": "Whether to validate SSL for the notification channel.",
          "type": [
            "boolean",
            "null"
          ],
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "channelType",
        "contentType",
        "createdAt",
        "customHeaders",
        "emailAddress",
        "id",
        "languageCode",
        "name",
        "orgId",
        "payloadUrl",
        "secretToken",
        "uid",
        "updatedAt",
        "validateSsl"
      ],
      "type": "object"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "channelScope": {
      "description": "Scope of the channel.",
      "enum": [
        "organization",
        "Organization",
        "ORGANIZATION",
        "entity",
        "Entity",
        "ENTITY",
        "template",
        "Template",
        "TEMPLATE"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "created": {
      "description": "The date when the policy was created.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "properties": {
        "events": {
          "description": "The events included in this group.",
          "items": {
            "description": "The type of the event that triggers the notification.",
            "properties": {
              "id": {
                "description": "The ID of the event type.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event type.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "label"
            ],
            "type": "object"
          },
          "maxItems": 1000,
          "type": "array"
        },
        "id": {
          "description": "The ID of the event group.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event group.",
          "type": "string"
        }
      },
      "required": [
        "events",
        "id",
        "label"
      ],
      "type": "object"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "properties": {
        "id": {
          "description": "The ID of the event type.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event type.",
          "type": "string"
        }
      },
      "required": [
        "id",
        "label"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "lastTriggered": {
      "description": "The date when the last notification with the policy was triggered.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "maximalFrequency": {
      "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the notification policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The ID of the organization that owns the notification policy.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "relatedEntityId": {
      "description": "The id of related entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "templateId": {
      "description": "The id of template.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "uid": {
      "description": "The identifier of the user who created the policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "updatedAt": {
      "description": "The date when the policy was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "active",
    "channel",
    "channelId",
    "channelScope",
    "created",
    "eventGroup",
    "eventType",
    "id",
    "lastTriggered",
    "name",
    "orgId",
    "relatedEntityId",
    "relatedEntityType",
    "templateId",
    "uid",
    "updatedAt"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | Entity notification policy retrieved successfully. | EntityNotificationPolicyResponse |

## Update an entity notification policy by relatedentitytype

Operation path: `PUT /api/v2/entityNotificationPolicies/{relatedEntityType}/{relatedEntityId}/{policyId}/`

Authentication requirements: `BearerAuth`

Update the entity notification policy.

### Body parameter

```
{
  "properties": {
    "active": {
      "description": "Whether the notification policy is active or not.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "channelScope": {
      "description": "Scope of the channel.",
      "enum": [
        "organization",
        "Organization",
        "ORGANIZATION",
        "entity",
        "Entity",
        "ENTITY",
        "template",
        "Template",
        "TEMPLATE"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "enum": [
        "secure_config.all",
        "dataset.all",
        "file.all",
        "comment.all",
        "invite_job.all",
        "deployment_prediction_explanations_computation.all",
        "model_deployments.critical_health",
        "model_deployments.critical_frequent_health_change",
        "model_deployments.frequent_health_change",
        "model_deployments.health",
        "model_deployments.retraining_policy",
        "inference_endpoints.health",
        "model_deployments.management_agent",
        "model_deployments.management_agent_health",
        "prediction_request.all",
        "challenger_management.all",
        "challenger_replay.all",
        "model_deployments.all",
        "project.all",
        "perma_delete_project.all",
        "users_delete.all",
        "applications.all",
        "model_version.stage_transitions",
        "model_version.all",
        "use_case.all",
        "batch_predictions.all",
        "change_requests.all",
        "custom_job_run.all",
        "custom_job_run.unsuccessful",
        "insights_computation.all",
        "notebook_schedule.all",
        "monitoring.all"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "enum": [
        "secure_config.created",
        "secure_config.deleted",
        "secure_config.shared",
        "dataset.created",
        "dataset.registered",
        "dataset.deleted",
        "datasets.deleted",
        "datasetrelationship.created",
        "dataset.shared",
        "datasets.shared",
        "file.created",
        "file.registered",
        "file.deleted",
        "file.shared",
        "comment.created",
        "comment.updated",
        "invite_job.completed",
        "misc.asset_access_request",
        "misc.webhook_connection_test",
        "misc.webhook_resend",
        "misc.email_verification",
        "monitoring.spooler_channel_base",
        "monitoring.spooler_channel_red",
        "monitoring.spooler_channel_green",
        "monitoring.external_model_nan_predictions",
        "management.deploymentInfo",
        "model_deployments.None",
        "model_deployments.deployment_sharing",
        "model_deployments.model_replacement",
        "prediction_request.None",
        "prediction_request.failed",
        "model_deployments.humility_rule",
        "model_deployments.model_replacement_lifecycle",
        "model_deployments.model_replacement_started",
        "model_deployments.model_replacement_succeeded",
        "model_deployments.model_replacement_failed",
        "model_deployments.model_replacement_validation_warning",
        "model_deployments.deployment_creation",
        "model_deployments.deployment_deletion",
        "model_deployments.service_health_yellow_from_green",
        "model_deployments.service_health_yellow_from_red",
        "model_deployments.service_health_red",
        "model_deployments.data_drift_yellow_from_green",
        "model_deployments.data_drift_yellow_from_red",
        "model_deployments.data_drift_red",
        "model_deployments.accuracy_yellow_from_green",
        "model_deployments.accuracy_yellow_from_red",
        "model_deployments.accuracy_red",
        "model_deployments.health.fairness_health.green_to_yellow",
        "model_deployments.health.fairness_health.red_to_yellow",
        "model_deployments.health.fairness_health.red",
        "model_deployments.health.custom_metrics_health.green_to_yellow",
        "model_deployments.health.custom_metrics_health.red_to_yellow",
        "model_deployments.health.custom_metrics_health.red",
        "model_deployments.health.base.green",
        "model_deployments.service_health_green",
        "model_deployments.data_drift_green",
        "model_deployments.accuracy_green",
        "model_deployments.health.fairness_health.green",
        "model_deployments.health.custom_metrics_health.green",
        "model_deployments.retraining_policy_run_started",
        "model_deployments.retraining_policy_run_succeeded",
        "model_deployments.retraining_policy_run_failed",
        "model_deployments.challenger_scoring_success",
        "model_deployments.challenger_scoring_data_warning",
        "model_deployments.challenger_scoring_failure",
        "model_deployments.challenger_scoring_started",
        "model_deployments.challenger_model_validation_warning",
        "model_deployments.challenger_model_created",
        "model_deployments.challenger_model_deleted",
        "model_deployments.actuals_upload_failed",
        "model_deployments.actuals_upload_warning",
        "model_deployments.training_data_baseline_calculation_started",
        "model_deployments.training_data_baseline_calculation_completed",
        "model_deployments.training_data_baseline_failed",
        "model_deployments.custom_model_deployment_creation_started",
        "model_deployments.custom_model_deployment_creation_completed",
        "model_deployments.custom_model_deployment_creation_failed",
        "model_deployments.custom_model_deployment_secure_config_failure",
        "model_deployments.deployment_prediction_explanations_preview_job_submitted",
        "model_deployments.deployment_prediction_explanations_preview_job_completed",
        "model_deployments.deployment_prediction_explanations_preview_job_failed",
        "model_deployments.custom_model_deployment_activated",
        "model_deployments.custom_model_deployment_activation_failed",
        "model_deployments.custom_model_deployment_deactivated",
        "model_deployments.custom_model_deployment_deactivation_failed",
        "model_deployments.prediction_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_warning",
        "model_deployments.actuals_processing_rate_limit_reached",
        "model_deployments.actuals_processing_rate_limit_warning",
        "model_deployments.deployment_monitoring_data_cleared",
        "model_deployments.deployment_launch_started",
        "model_deployments.deployment_launch_succeeded",
        "model_deployments.deployment_launch_failed",
        "model_deployments.deployment_shutdown_started",
        "model_deployments.deployment_shutdown_succeeded",
        "model_deployments.deployment_shutdown_failed",
        "model_deployments.endpoint_update_started",
        "model_deployments.endpoint_update_succeeded",
        "model_deployments.endpoint_update_failed",
        "model_deployments.management_agent_service_health_green",
        "model_deployments.management_agent_service_health_yellow",
        "model_deployments.management_agent_service_health_red",
        "model_deployments.management_agent_service_health_unknown",
        "model_deployments.predictions_missing_association_id",
        "model_deployments.prediction_result_rows_cleand_up",
        "model_deployments.batch_deleted",
        "model_deployments.batch_creation_limit_reached",
        "model_deployments.batch_creation_limit_exceeded",
        "model_deployments.batch_not_found",
        "model_deployments.predictions_encountered_for_locked_batch",
        "model_deployments.predictions_encountered_for_deleted_batch",
        "model_deployments.scheduled_report_generated",
        "model_deployments.predictions_timeliness_health_red",
        "model_deployments.actuals_timeliness_health_red",
        "model_deployments.service_health_still_red",
        "model_deployments.data_drift_still_red",
        "model_deployments.accuracy_still_red",
        "model_deployments.health.fairness_health.still_red",
        "model_deployments.health.custom_metrics_health.still_red",
        "model_deployments.predictions_timeliness_health_still_red",
        "model_deployments.actuals_timeliness_health_still_red",
        "model_deployments.service_health_still_yellow",
        "model_deployments.data_drift_still_yellow",
        "model_deployments.accuracy_still_yellow",
        "model_deployments.health.fairness_health.still_yellow",
        "model_deployments.health.custom_metrics_health.still_yellow",
        "model_deployments.prediction_payload_parsing_failure",
        "model_deployments.deployment_inference_server_creation_started",
        "model_deployments.deployment_inference_server_creation_failed",
        "model_deployments.deployment_inference_server_creation_completed",
        "model_deployments.deployment_inference_server_deletion",
        "model_deployments.deployment_inference_server_idle_stopped",
        "model_deployments.deployment_inference_server_maintenance_started",
        "entity_notification_policy_template.shared",
        "notification_channel_template.shared",
        "project.created",
        "project.deleted",
        "project.shared",
        "autopilot.complete",
        "autopilot.started",
        "autostart.failure",
        "perma_delete_project.success",
        "perma_delete_project.failure",
        "users_delete.preview_started",
        "users_delete.preview_completed",
        "users_delete.preview_failed",
        "users_delete.started",
        "users_delete.completed",
        "users_delete.failed",
        "application.created",
        "application.shared",
        "model_version.added",
        "model_version.stage_transition_from_registered_to_development",
        "model_version.stage_transition_from_registered_to_staging",
        "model_version.stage_transition_from_registered_to_production",
        "model_version.stage_transition_from_registered_to_archived",
        "model_version.stage_transition_from_development_to_registered",
        "model_version.stage_transition_from_development_to_staging",
        "model_version.stage_transition_from_development_to_production",
        "model_version.stage_transition_from_development_to_archived",
        "model_version.stage_transition_from_staging_to_registered",
        "model_version.stage_transition_from_staging_to_development",
        "model_version.stage_transition_from_staging_to_production",
        "model_version.stage_transition_from_staging_to_archived",
        "model_version.stage_transition_from_production_to_registered",
        "model_version.stage_transition_from_production_to_development",
        "model_version.stage_transition_from_production_to_staging",
        "model_version.stage_transition_from_production_to_archived",
        "model_version.stage_transition_from_archived_to_registered",
        "model_version.stage_transition_from_archived_to_development",
        "model_version.stage_transition_from_archived_to_production",
        "model_version.stage_transition_from_archived_to_staging",
        "use_case.shared",
        "batch_predictions.success",
        "batch_predictions.failed",
        "batch_predictions.scheduler.auto_disabled",
        "change_request.cancelled",
        "change_request.created",
        "change_request.deployment_approval_requested",
        "change_request.resolved",
        "change_request.proposed_changes_updated",
        "change_request.pending",
        "change_request.commenting_review_added",
        "change_request.approving_review_added",
        "change_request.changes_requesting_review_added",
        "custom_job_run.success",
        "custom_job_run.failed",
        "custom_job_run.interrupted",
        "custom_job_run.cancelled",
        "prediction_explanations_computation.None",
        "prediction_explanations_computation.prediction_explanations_preview_job_submitted",
        "prediction_explanations_computation.prediction_explanations_preview_job_completed",
        "prediction_explanations_computation.prediction_explanations_preview_job_failed",
        "monitoring.rate_limit_enforced",
        "notebook_schedule.created",
        "notebook_schedule.failure",
        "notebook_schedule.completed",
        "abstract",
        "moderation.metric.creation_error",
        "moderation.metric.reporting_error",
        "moderation.model.moderation_started",
        "moderation.model.moderation_completed",
        "moderation.model.pre_score_phase_started",
        "moderation.model.pre_score_phase_completed",
        "moderation.model.post_score_phase_started",
        "moderation.model.post_score_phase_completed",
        "moderation.model.config_error",
        "moderation.model.runtime_error",
        "moderation.model.scoring_started",
        "moderation.model.scoring_completed",
        "moderation.model.scoring_error"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "maximalFrequency": {
      "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the notification policy.",
      "maxLength": 100,
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| policyId | path | string | true | The ID of the notification policy. |
| relatedEntityId | path | string | true | The id of related entity. |
| relatedEntityType | path | string | true | The type of the related entity. |
| body | body | EntityNotificationPolicyUpdate | false | none |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | Entity notification policy updated successfully. | None |

## Create an entity notification policy

Operation path: `POST /api/v2/entityNotificationPoliciesFromTemplate/`

Authentication requirements: `BearerAuth`

Create a new entity notification policy from template.

### Body parameter

```
{
  "properties": {
    "active": {
      "description": "Whether the notification policy is active or not.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification policy.",
      "maxLength": 100,
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityId": {
      "description": "The id of related entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "templateId": {
      "description": "The id of template.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "name",
    "relatedEntityId",
    "relatedEntityType",
    "templateId"
  ],
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| body | body | EntityNotificationPolicyCreateFromTemplate | false | none |

### Example responses

> 201 Response

```
{
  "properties": {
    "active": {
      "description": "Defines if the notification policy is active or not.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "channel": {
      "description": "The notification channel information used to send the notification.",
      "properties": {
        "channelType": {
          "description": "The type of the new notification channel.",
          "enum": [
            "DataRobotCustomJob",
            "DataRobotGroup",
            "DataRobotUser",
            "Database",
            "Email",
            "InApp",
            "InsightsComputations",
            "MSTeams",
            "Slack",
            "Webhook"
          ],
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "contentType": {
          "description": "The content type of the messages of the new notification channel.",
          "enum": [
            "application/json",
            "application/x-www-form-urlencoded"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "createdAt": {
          "description": "The date of the notification channel creation.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "customHeaders": {
          "description": "Custom headers and their values to be sent in the new notification channel.",
          "items": {
            "properties": {
              "name": {
                "description": "The name of the header.",
                "type": "string"
              },
              "value": {
                "description": "The value of the header.",
                "type": "string"
              }
            },
            "required": [
              "name",
              "value"
            ],
            "type": "object"
          },
          "maxItems": 100,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "drEntities": {
          "description": "The ids of DataRobot Users or Group for DataRobotUser or DataRobotGroup channel types.",
          "items": {
            "properties": {
              "id": {
                "description": "The id of DataRobot entity.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "name": {
                "description": "The name of the entity.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "id",
              "name"
            ],
            "type": "object"
          },
          "maxItems": 100,
          "minItems": 1,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "emailAddress": {
          "description": "The email address to be used in the new notification channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "id": {
          "description": "The ID of the notification channel.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "languageCode": {
          "description": "The preferred language code.",
          "enum": [
            "en",
            "es_419",
            "fr",
            "ja",
            "ko",
            "ptBR"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "name": {
          "description": "The name of the new notification channel.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "orgId": {
          "description": "The ID of the organization that the notification channel belongs to.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "payloadUrl": {
          "description": "The payload URL of the new notification channel.",
          "format": "uri",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "relatedEntityId": {
          "description": "The id of related entity.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "relatedEntityType": {
          "description": "Type of related entity.",
          "enum": [
            "deployment",
            "Deployment",
            "DEPLOYMENT",
            "customjob",
            "Customjob",
            "CUSTOMJOB"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "secretToken": {
          "description": "Secret token to be used for new notification channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "uid": {
          "description": "The identifier of the user who created the channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "updatedAt": {
          "description": "The date when the channel was updated.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "validateSsl": {
          "description": "Whether to validate SSL for the notification channel.",
          "type": [
            "boolean",
            "null"
          ],
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "channelType",
        "contentType",
        "createdAt",
        "customHeaders",
        "emailAddress",
        "id",
        "languageCode",
        "name",
        "orgId",
        "payloadUrl",
        "secretToken",
        "uid",
        "updatedAt",
        "validateSsl"
      ],
      "type": "object"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "channelScope": {
      "description": "Scope of the channel.",
      "enum": [
        "organization",
        "Organization",
        "ORGANIZATION",
        "entity",
        "Entity",
        "ENTITY",
        "template",
        "Template",
        "TEMPLATE"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "created": {
      "description": "The date when the policy was created.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "properties": {
        "events": {
          "description": "The events included in this group.",
          "items": {
            "description": "The type of the event that triggers the notification.",
            "properties": {
              "id": {
                "description": "The ID of the event type.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event type.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "label"
            ],
            "type": "object"
          },
          "maxItems": 1000,
          "type": "array"
        },
        "id": {
          "description": "The ID of the event group.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event group.",
          "type": "string"
        }
      },
      "required": [
        "events",
        "id",
        "label"
      ],
      "type": "object"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "properties": {
        "id": {
          "description": "The ID of the event type.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event type.",
          "type": "string"
        }
      },
      "required": [
        "id",
        "label"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "lastTriggered": {
      "description": "The date when the last notification with the policy was triggered.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "maximalFrequency": {
      "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the notification policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The ID of the organization that owns the notification policy.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "relatedEntityId": {
      "description": "The id of related entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "templateId": {
      "description": "The id of template.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "uid": {
      "description": "The identifier of the user who created the policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "updatedAt": {
      "description": "The date when the policy was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "active",
    "channel",
    "channelId",
    "channelScope",
    "created",
    "eventGroup",
    "eventType",
    "id",
    "lastTriggered",
    "name",
    "orgId",
    "relatedEntityId",
    "relatedEntityType",
    "templateId",
    "uid",
    "updatedAt"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 201 | Created | Entity notification policy created successfully. | EntityNotificationPolicyResponse |

## Create an entity notification policy template

Operation path: `POST /api/v2/entityNotificationPolicyTemplates/`

Authentication requirements: `BearerAuth`

Create a new entity notification policy template.

### Body parameter

```
{
  "properties": {
    "active": {
      "description": "Whether the notification policy is active or not.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "enum": [
        "secure_config.all",
        "dataset.all",
        "file.all",
        "comment.all",
        "invite_job.all",
        "deployment_prediction_explanations_computation.all",
        "model_deployments.critical_health",
        "model_deployments.critical_frequent_health_change",
        "model_deployments.frequent_health_change",
        "model_deployments.health",
        "model_deployments.retraining_policy",
        "inference_endpoints.health",
        "model_deployments.management_agent",
        "model_deployments.management_agent_health",
        "prediction_request.all",
        "challenger_management.all",
        "challenger_replay.all",
        "model_deployments.all",
        "project.all",
        "perma_delete_project.all",
        "users_delete.all",
        "applications.all",
        "model_version.stage_transitions",
        "model_version.all",
        "use_case.all",
        "batch_predictions.all",
        "change_requests.all",
        "custom_job_run.all",
        "custom_job_run.unsuccessful",
        "insights_computation.all",
        "notebook_schedule.all",
        "monitoring.all"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "enum": [
        "secure_config.created",
        "secure_config.deleted",
        "secure_config.shared",
        "dataset.created",
        "dataset.registered",
        "dataset.deleted",
        "datasets.deleted",
        "datasetrelationship.created",
        "dataset.shared",
        "datasets.shared",
        "file.created",
        "file.registered",
        "file.deleted",
        "file.shared",
        "comment.created",
        "comment.updated",
        "invite_job.completed",
        "misc.asset_access_request",
        "misc.webhook_connection_test",
        "misc.webhook_resend",
        "misc.email_verification",
        "monitoring.spooler_channel_base",
        "monitoring.spooler_channel_red",
        "monitoring.spooler_channel_green",
        "monitoring.external_model_nan_predictions",
        "management.deploymentInfo",
        "model_deployments.None",
        "model_deployments.deployment_sharing",
        "model_deployments.model_replacement",
        "prediction_request.None",
        "prediction_request.failed",
        "model_deployments.humility_rule",
        "model_deployments.model_replacement_lifecycle",
        "model_deployments.model_replacement_started",
        "model_deployments.model_replacement_succeeded",
        "model_deployments.model_replacement_failed",
        "model_deployments.model_replacement_validation_warning",
        "model_deployments.deployment_creation",
        "model_deployments.deployment_deletion",
        "model_deployments.service_health_yellow_from_green",
        "model_deployments.service_health_yellow_from_red",
        "model_deployments.service_health_red",
        "model_deployments.data_drift_yellow_from_green",
        "model_deployments.data_drift_yellow_from_red",
        "model_deployments.data_drift_red",
        "model_deployments.accuracy_yellow_from_green",
        "model_deployments.accuracy_yellow_from_red",
        "model_deployments.accuracy_red",
        "model_deployments.health.fairness_health.green_to_yellow",
        "model_deployments.health.fairness_health.red_to_yellow",
        "model_deployments.health.fairness_health.red",
        "model_deployments.health.custom_metrics_health.green_to_yellow",
        "model_deployments.health.custom_metrics_health.red_to_yellow",
        "model_deployments.health.custom_metrics_health.red",
        "model_deployments.health.base.green",
        "model_deployments.service_health_green",
        "model_deployments.data_drift_green",
        "model_deployments.accuracy_green",
        "model_deployments.health.fairness_health.green",
        "model_deployments.health.custom_metrics_health.green",
        "model_deployments.retraining_policy_run_started",
        "model_deployments.retraining_policy_run_succeeded",
        "model_deployments.retraining_policy_run_failed",
        "model_deployments.challenger_scoring_success",
        "model_deployments.challenger_scoring_data_warning",
        "model_deployments.challenger_scoring_failure",
        "model_deployments.challenger_scoring_started",
        "model_deployments.challenger_model_validation_warning",
        "model_deployments.challenger_model_created",
        "model_deployments.challenger_model_deleted",
        "model_deployments.actuals_upload_failed",
        "model_deployments.actuals_upload_warning",
        "model_deployments.training_data_baseline_calculation_started",
        "model_deployments.training_data_baseline_calculation_completed",
        "model_deployments.training_data_baseline_failed",
        "model_deployments.custom_model_deployment_creation_started",
        "model_deployments.custom_model_deployment_creation_completed",
        "model_deployments.custom_model_deployment_creation_failed",
        "model_deployments.custom_model_deployment_secure_config_failure",
        "model_deployments.deployment_prediction_explanations_preview_job_submitted",
        "model_deployments.deployment_prediction_explanations_preview_job_completed",
        "model_deployments.deployment_prediction_explanations_preview_job_failed",
        "model_deployments.custom_model_deployment_activated",
        "model_deployments.custom_model_deployment_activation_failed",
        "model_deployments.custom_model_deployment_deactivated",
        "model_deployments.custom_model_deployment_deactivation_failed",
        "model_deployments.prediction_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_warning",
        "model_deployments.actuals_processing_rate_limit_reached",
        "model_deployments.actuals_processing_rate_limit_warning",
        "model_deployments.deployment_monitoring_data_cleared",
        "model_deployments.deployment_launch_started",
        "model_deployments.deployment_launch_succeeded",
        "model_deployments.deployment_launch_failed",
        "model_deployments.deployment_shutdown_started",
        "model_deployments.deployment_shutdown_succeeded",
        "model_deployments.deployment_shutdown_failed",
        "model_deployments.endpoint_update_started",
        "model_deployments.endpoint_update_succeeded",
        "model_deployments.endpoint_update_failed",
        "model_deployments.management_agent_service_health_green",
        "model_deployments.management_agent_service_health_yellow",
        "model_deployments.management_agent_service_health_red",
        "model_deployments.management_agent_service_health_unknown",
        "model_deployments.predictions_missing_association_id",
        "model_deployments.prediction_result_rows_cleand_up",
        "model_deployments.batch_deleted",
        "model_deployments.batch_creation_limit_reached",
        "model_deployments.batch_creation_limit_exceeded",
        "model_deployments.batch_not_found",
        "model_deployments.predictions_encountered_for_locked_batch",
        "model_deployments.predictions_encountered_for_deleted_batch",
        "model_deployments.scheduled_report_generated",
        "model_deployments.predictions_timeliness_health_red",
        "model_deployments.actuals_timeliness_health_red",
        "model_deployments.service_health_still_red",
        "model_deployments.data_drift_still_red",
        "model_deployments.accuracy_still_red",
        "model_deployments.health.fairness_health.still_red",
        "model_deployments.health.custom_metrics_health.still_red",
        "model_deployments.predictions_timeliness_health_still_red",
        "model_deployments.actuals_timeliness_health_still_red",
        "model_deployments.service_health_still_yellow",
        "model_deployments.data_drift_still_yellow",
        "model_deployments.accuracy_still_yellow",
        "model_deployments.health.fairness_health.still_yellow",
        "model_deployments.health.custom_metrics_health.still_yellow",
        "model_deployments.prediction_payload_parsing_failure",
        "model_deployments.deployment_inference_server_creation_started",
        "model_deployments.deployment_inference_server_creation_failed",
        "model_deployments.deployment_inference_server_creation_completed",
        "model_deployments.deployment_inference_server_deletion",
        "model_deployments.deployment_inference_server_idle_stopped",
        "model_deployments.deployment_inference_server_maintenance_started",
        "entity_notification_policy_template.shared",
        "notification_channel_template.shared",
        "project.created",
        "project.deleted",
        "project.shared",
        "autopilot.complete",
        "autopilot.started",
        "autostart.failure",
        "perma_delete_project.success",
        "perma_delete_project.failure",
        "users_delete.preview_started",
        "users_delete.preview_completed",
        "users_delete.preview_failed",
        "users_delete.started",
        "users_delete.completed",
        "users_delete.failed",
        "application.created",
        "application.shared",
        "model_version.added",
        "model_version.stage_transition_from_registered_to_development",
        "model_version.stage_transition_from_registered_to_staging",
        "model_version.stage_transition_from_registered_to_production",
        "model_version.stage_transition_from_registered_to_archived",
        "model_version.stage_transition_from_development_to_registered",
        "model_version.stage_transition_from_development_to_staging",
        "model_version.stage_transition_from_development_to_production",
        "model_version.stage_transition_from_development_to_archived",
        "model_version.stage_transition_from_staging_to_registered",
        "model_version.stage_transition_from_staging_to_development",
        "model_version.stage_transition_from_staging_to_production",
        "model_version.stage_transition_from_staging_to_archived",
        "model_version.stage_transition_from_production_to_registered",
        "model_version.stage_transition_from_production_to_development",
        "model_version.stage_transition_from_production_to_staging",
        "model_version.stage_transition_from_production_to_archived",
        "model_version.stage_transition_from_archived_to_registered",
        "model_version.stage_transition_from_archived_to_development",
        "model_version.stage_transition_from_archived_to_production",
        "model_version.stage_transition_from_archived_to_staging",
        "use_case.shared",
        "batch_predictions.success",
        "batch_predictions.failed",
        "batch_predictions.scheduler.auto_disabled",
        "change_request.cancelled",
        "change_request.created",
        "change_request.deployment_approval_requested",
        "change_request.resolved",
        "change_request.proposed_changes_updated",
        "change_request.pending",
        "change_request.commenting_review_added",
        "change_request.approving_review_added",
        "change_request.changes_requesting_review_added",
        "custom_job_run.success",
        "custom_job_run.failed",
        "custom_job_run.interrupted",
        "custom_job_run.cancelled",
        "prediction_explanations_computation.None",
        "prediction_explanations_computation.prediction_explanations_preview_job_submitted",
        "prediction_explanations_computation.prediction_explanations_preview_job_completed",
        "prediction_explanations_computation.prediction_explanations_preview_job_failed",
        "monitoring.rate_limit_enforced",
        "notebook_schedule.created",
        "notebook_schedule.failure",
        "notebook_schedule.completed",
        "abstract",
        "moderation.metric.creation_error",
        "moderation.metric.reporting_error",
        "moderation.model.moderation_started",
        "moderation.model.moderation_completed",
        "moderation.model.pre_score_phase_started",
        "moderation.model.pre_score_phase_completed",
        "moderation.model.post_score_phase_started",
        "moderation.model.post_score_phase_completed",
        "moderation.model.config_error",
        "moderation.model.runtime_error",
        "moderation.model.scoring_started",
        "moderation.model.scoring_completed",
        "moderation.model.scoring_error"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "maximalFrequency": {
      "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification policy.",
      "maxLength": 100,
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The ID of the organization that owns the notification policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "channelId",
    "name",
    "relatedEntityType"
  ],
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| body | body | EntityNotificationPolicyTemplateCreate | false | none |

### Example responses

> 201 Response

```
{
  "properties": {
    "active": {
      "description": "Defines if the notification policy is active or not.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "channel": {
      "description": "The notification channel information used to send the notification.",
      "properties": {
        "channelType": {
          "description": "The type of the new notification channel.",
          "enum": [
            "DataRobotCustomJob",
            "DataRobotGroup",
            "DataRobotUser",
            "Database",
            "Email",
            "InApp",
            "InsightsComputations",
            "MSTeams",
            "Slack",
            "Webhook"
          ],
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "contentType": {
          "description": "The content type of the messages of the new notification channel.",
          "enum": [
            "application/json",
            "application/x-www-form-urlencoded"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "createdAt": {
          "description": "The date of the notification channel creation.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "customHeaders": {
          "description": "Custom headers and their values to be sent in the new notification channel.",
          "items": {
            "properties": {
              "name": {
                "description": "The name of the header.",
                "type": "string"
              },
              "value": {
                "description": "The value of the header.",
                "type": "string"
              }
            },
            "required": [
              "name",
              "value"
            ],
            "type": "object"
          },
          "maxItems": 100,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "drEntities": {
          "description": "The ids of DataRobot Users or Group for DataRobotUser or DataRobotGroup channel types.",
          "items": {
            "properties": {
              "id": {
                "description": "The id of DataRobot entity.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "name": {
                "description": "The name of the entity.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "id",
              "name"
            ],
            "type": "object"
          },
          "maxItems": 100,
          "minItems": 1,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "emailAddress": {
          "description": "The email address to be used in the new notification channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "id": {
          "description": "The ID of the notification channel.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "languageCode": {
          "description": "The preferred language code.",
          "enum": [
            "en",
            "es_419",
            "fr",
            "ja",
            "ko",
            "ptBR"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "name": {
          "description": "The name of the new notification channel.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "orgId": {
          "description": "The ID of the organization that the notification channel belongs to.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "payloadUrl": {
          "description": "The payload URL of the new notification channel.",
          "format": "uri",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "relatedEntityId": {
          "description": "The id of related entity.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "relatedEntityType": {
          "description": "Type of related entity.",
          "enum": [
            "deployment",
            "Deployment",
            "DEPLOYMENT",
            "customjob",
            "Customjob",
            "CUSTOMJOB"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "secretToken": {
          "description": "Secret token to be used for new notification channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "uid": {
          "description": "The identifier of the user who created the channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "updatedAt": {
          "description": "The date when the channel was updated.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "validateSsl": {
          "description": "Whether to validate SSL for the notification channel.",
          "type": [
            "boolean",
            "null"
          ],
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "channelType",
        "contentType",
        "createdAt",
        "customHeaders",
        "emailAddress",
        "id",
        "languageCode",
        "name",
        "orgId",
        "payloadUrl",
        "secretToken",
        "uid",
        "updatedAt",
        "validateSsl"
      ],
      "type": "object"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "channelScope": {
      "description": "Scope of the channel.",
      "enum": [
        "organization",
        "Organization",
        "ORGANIZATION",
        "entity",
        "Entity",
        "ENTITY",
        "template",
        "Template",
        "TEMPLATE"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "created": {
      "description": "The date when the policy was created.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "User that created template.",
      "properties": {
        "firstName": {
          "description": "First Name.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "lastName": {
          "description": "Last Name.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "username": {
          "description": "Username.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "firstName",
        "lastName",
        "username"
      ],
      "type": "object"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "properties": {
        "events": {
          "description": "The events included in this group.",
          "items": {
            "description": "The type of the event that triggers the notification.",
            "properties": {
              "id": {
                "description": "The ID of the event type.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event type.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "label"
            ],
            "type": "object"
          },
          "maxItems": 1000,
          "type": "array"
        },
        "id": {
          "description": "The ID of the event group.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event group.",
          "type": "string"
        }
      },
      "required": [
        "events",
        "id",
        "label"
      ],
      "type": "object"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "properties": {
        "id": {
          "description": "The ID of the event type.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event type.",
          "type": "string"
        }
      },
      "required": [
        "id",
        "label"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "lastTriggered": {
      "description": "The date when the last notification with the policy was triggered.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "maximalFrequency": {
      "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the notification policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The ID of the organization that owns the notification policy.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedPoliciesCount": {
      "description": "The total number of entity policies that are using this template.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "role": {
      "description": "User role on entity.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "uid": {
      "description": "The identifier of the user who created the policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "updatedAt": {
      "description": "The date when the policy was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "active",
    "channel",
    "channelId",
    "created",
    "createdBy",
    "eventGroup",
    "eventType",
    "id",
    "lastTriggered",
    "name",
    "orgId",
    "relatedEntityType",
    "relatedPoliciesCount",
    "role",
    "uid",
    "updatedAt"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 201 | Created | Entity notification policy template created successfully. | EntityNotificationPolicyTemplateResponse |

## List entity notification policy templates by relatedentitytype

Operation path: `GET /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/`

Authentication requirements: `BearerAuth`

List the entity notification policies templates that satisfy the query condition.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| offset | query | integer | true | How many notification channels to skip. |
| limit | query | integer | true | At most this many notification channels to return. |
| channelId | query | string | false | Return policies with this channel. |
| namePart | query | string | false | Only return the notification channels whose names contain the given substring. |
| eventGroup | query | string | false | Return policies with this event group. |
| relatedEntityType | path | string | true | The type of the related entity. |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| eventGroup | [secure_config.all, dataset.all, file.all, comment.all, invite_job.all, deployment_prediction_explanations_computation.all, model_deployments.critical_health, model_deployments.critical_frequent_health_change, model_deployments.frequent_health_change, model_deployments.health, model_deployments.retraining_policy, inference_endpoints.health, model_deployments.management_agent, model_deployments.management_agent_health, prediction_request.all, challenger_management.all, challenger_replay.all, model_deployments.all, project.all, perma_delete_project.all, users_delete.all, applications.all, model_version.stage_transitions, model_version.all, use_case.all, batch_predictions.all, change_requests.all, custom_job_run.all, custom_job_run.unsuccessful, insights_computation.all, notebook_schedule.all, monitoring.all] |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "The number of entity policy templates returned.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "The entity notification policy templates.",
      "items": {
        "properties": {
          "active": {
            "description": "Defines if the notification policy is active or not.",
            "type": "boolean",
            "x-versionadded": "v2.33"
          },
          "channel": {
            "description": "The notification channel information used to send the notification.",
            "properties": {
              "channelType": {
                "description": "The type of the new notification channel.",
                "enum": [
                  "DataRobotCustomJob",
                  "DataRobotGroup",
                  "DataRobotUser",
                  "Database",
                  "Email",
                  "InApp",
                  "InsightsComputations",
                  "MSTeams",
                  "Slack",
                  "Webhook"
                ],
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "contentType": {
                "description": "The content type of the messages of the new notification channel.",
                "enum": [
                  "application/json",
                  "application/x-www-form-urlencoded"
                ],
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "createdAt": {
                "description": "The date of the notification channel creation.",
                "format": "date-time",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "customHeaders": {
                "description": "Custom headers and their values to be sent in the new notification channel.",
                "items": {
                  "properties": {
                    "name": {
                      "description": "The name of the header.",
                      "type": "string"
                    },
                    "value": {
                      "description": "The value of the header.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "name",
                    "value"
                  ],
                  "type": "object"
                },
                "maxItems": 100,
                "type": "array",
                "x-versionadded": "v2.33"
              },
              "drEntities": {
                "description": "The ids of DataRobot Users or Group for DataRobotUser or DataRobotGroup channel types.",
                "items": {
                  "properties": {
                    "id": {
                      "description": "The id of DataRobot entity.",
                      "type": "string",
                      "x-versionadded": "v2.33"
                    },
                    "name": {
                      "description": "The name of the entity.",
                      "type": "string",
                      "x-versionadded": "v2.33"
                    }
                  },
                  "required": [
                    "id",
                    "name"
                  ],
                  "type": "object"
                },
                "maxItems": 100,
                "minItems": 1,
                "type": "array",
                "x-versionadded": "v2.33"
              },
              "emailAddress": {
                "description": "The email address to be used in the new notification channel.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "id": {
                "description": "The ID of the notification channel.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "languageCode": {
                "description": "The preferred language code.",
                "enum": [
                  "en",
                  "es_419",
                  "fr",
                  "ja",
                  "ko",
                  "ptBR"
                ],
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "name": {
                "description": "The name of the new notification channel.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "orgId": {
                "description": "The ID of the organization that the notification channel belongs to.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "payloadUrl": {
                "description": "The payload URL of the new notification channel.",
                "format": "uri",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "relatedEntityId": {
                "description": "The id of related entity.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "relatedEntityType": {
                "description": "Type of related entity.",
                "enum": [
                  "deployment",
                  "Deployment",
                  "DEPLOYMENT",
                  "customjob",
                  "Customjob",
                  "CUSTOMJOB"
                ],
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "secretToken": {
                "description": "Secret token to be used for new notification channel.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "uid": {
                "description": "The identifier of the user who created the channel.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "updatedAt": {
                "description": "The date when the channel was updated.",
                "format": "date-time",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "validateSsl": {
                "description": "Whether to validate SSL for the notification channel.",
                "type": [
                  "boolean",
                  "null"
                ],
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "channelType",
              "contentType",
              "createdAt",
              "customHeaders",
              "emailAddress",
              "id",
              "languageCode",
              "name",
              "orgId",
              "payloadUrl",
              "secretToken",
              "uid",
              "updatedAt",
              "validateSsl"
            ],
            "type": "object"
          },
          "channelId": {
            "description": "The ID of the notification channel to be used to send the notification.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "channelScope": {
            "description": "Scope of the channel.",
            "enum": [
              "organization",
              "Organization",
              "ORGANIZATION",
              "entity",
              "Entity",
              "ENTITY",
              "template",
              "Template",
              "TEMPLATE"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "created": {
            "description": "The date when the policy was created.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "createdBy": {
            "description": "User that created template.",
            "properties": {
              "firstName": {
                "description": "First Name.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "lastName": {
                "description": "Last Name.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "username": {
                "description": "Username.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "firstName",
              "lastName",
              "username"
            ],
            "type": "object"
          },
          "eventGroup": {
            "description": "The group of the event that triggers the notification.",
            "properties": {
              "events": {
                "description": "The events included in this group.",
                "items": {
                  "description": "The type of the event that triggers the notification.",
                  "properties": {
                    "id": {
                      "description": "The ID of the event type.",
                      "type": "string"
                    },
                    "label": {
                      "description": "The display name of the event type.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "label"
                  ],
                  "type": "object"
                },
                "maxItems": 1000,
                "type": "array"
              },
              "id": {
                "description": "The ID of the event group.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event group.",
                "type": "string"
              }
            },
            "required": [
              "events",
              "id",
              "label"
            ],
            "type": "object"
          },
          "eventType": {
            "description": "The type of the event that triggers the notification.",
            "properties": {
              "id": {
                "description": "The ID of the event type.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event type.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "label"
            ],
            "type": "object"
          },
          "id": {
            "description": "The ID of the policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "lastTriggered": {
            "description": "The date when the last notification with the policy was triggered.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "maximalFrequency": {
            "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the notification policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "orgId": {
            "description": "The ID of the organization that owns the notification policy.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "relatedEntityType": {
            "description": "The type of the related entity.",
            "enum": [
              "deployment",
              "Deployment",
              "DEPLOYMENT",
              "customjob",
              "Customjob",
              "CUSTOMJOB"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedPoliciesCount": {
            "description": "The total number of entity policies that are using this template.",
            "type": "integer",
            "x-versionadded": "v2.33"
          },
          "role": {
            "description": "User role on entity.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "uid": {
            "description": "The identifier of the user who created the policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "updatedAt": {
            "description": "The date when the policy was updated.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "active",
          "channel",
          "channelId",
          "created",
          "createdBy",
          "eventGroup",
          "eventType",
          "id",
          "lastTriggered",
          "name",
          "orgId",
          "relatedEntityType",
          "relatedPoliciesCount",
          "role",
          "uid",
          "updatedAt"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "The total number of entity policies templates that satisfy the query.",
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | Entity notification policies templates listed successfully. | EntityNotificationPoliciesTemplatesListResponse |

## Delete an entity notification policy template by relatedentitytype

Operation path: `DELETE /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/{policyId}/`

Authentication requirements: `BearerAuth`

Delete the entity notification policy template.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| policyId | path | string | true | The ID of the notification policy template. |
| relatedEntityType | path | string | true | The type of the related entity. |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | Entity notification policy template deleted successfully. | None |

## Retrieve an entity notification policy template by relatedentitytype

Operation path: `GET /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/{policyId}/`

Authentication requirements: `BearerAuth`

Retrieve the entity notification policy template.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| policyId | path | string | true | The ID of the notification policy template. |
| relatedEntityType | path | string | true | The type of the related entity. |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

### Example responses

> 200 Response

```
{
  "properties": {
    "active": {
      "description": "Defines if the notification policy is active or not.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "channel": {
      "description": "The notification channel information used to send the notification.",
      "properties": {
        "channelType": {
          "description": "The type of the new notification channel.",
          "enum": [
            "DataRobotCustomJob",
            "DataRobotGroup",
            "DataRobotUser",
            "Database",
            "Email",
            "InApp",
            "InsightsComputations",
            "MSTeams",
            "Slack",
            "Webhook"
          ],
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "contentType": {
          "description": "The content type of the messages of the new notification channel.",
          "enum": [
            "application/json",
            "application/x-www-form-urlencoded"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "createdAt": {
          "description": "The date of the notification channel creation.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "customHeaders": {
          "description": "Custom headers and their values to be sent in the new notification channel.",
          "items": {
            "properties": {
              "name": {
                "description": "The name of the header.",
                "type": "string"
              },
              "value": {
                "description": "The value of the header.",
                "type": "string"
              }
            },
            "required": [
              "name",
              "value"
            ],
            "type": "object"
          },
          "maxItems": 100,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "drEntities": {
          "description": "The ids of DataRobot Users or Group for DataRobotUser or DataRobotGroup channel types.",
          "items": {
            "properties": {
              "id": {
                "description": "The id of DataRobot entity.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "name": {
                "description": "The name of the entity.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "id",
              "name"
            ],
            "type": "object"
          },
          "maxItems": 100,
          "minItems": 1,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "emailAddress": {
          "description": "The email address to be used in the new notification channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "id": {
          "description": "The ID of the notification channel.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "languageCode": {
          "description": "The preferred language code.",
          "enum": [
            "en",
            "es_419",
            "fr",
            "ja",
            "ko",
            "ptBR"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "name": {
          "description": "The name of the new notification channel.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "orgId": {
          "description": "The ID of the organization that the notification channel belongs to.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "payloadUrl": {
          "description": "The payload URL of the new notification channel.",
          "format": "uri",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "relatedEntityId": {
          "description": "The id of related entity.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "relatedEntityType": {
          "description": "Type of related entity.",
          "enum": [
            "deployment",
            "Deployment",
            "DEPLOYMENT",
            "customjob",
            "Customjob",
            "CUSTOMJOB"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "secretToken": {
          "description": "Secret token to be used for new notification channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "uid": {
          "description": "The identifier of the user who created the channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "updatedAt": {
          "description": "The date when the channel was updated.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "validateSsl": {
          "description": "Whether to validate SSL for the notification channel.",
          "type": [
            "boolean",
            "null"
          ],
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "channelType",
        "contentType",
        "createdAt",
        "customHeaders",
        "emailAddress",
        "id",
        "languageCode",
        "name",
        "orgId",
        "payloadUrl",
        "secretToken",
        "uid",
        "updatedAt",
        "validateSsl"
      ],
      "type": "object"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "channelScope": {
      "description": "Scope of the channel.",
      "enum": [
        "organization",
        "Organization",
        "ORGANIZATION",
        "entity",
        "Entity",
        "ENTITY",
        "template",
        "Template",
        "TEMPLATE"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "created": {
      "description": "The date when the policy was created.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "User that created template.",
      "properties": {
        "firstName": {
          "description": "First Name.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "lastName": {
          "description": "Last Name.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "username": {
          "description": "Username.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "firstName",
        "lastName",
        "username"
      ],
      "type": "object"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "properties": {
        "events": {
          "description": "The events included in this group.",
          "items": {
            "description": "The type of the event that triggers the notification.",
            "properties": {
              "id": {
                "description": "The ID of the event type.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event type.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "label"
            ],
            "type": "object"
          },
          "maxItems": 1000,
          "type": "array"
        },
        "id": {
          "description": "The ID of the event group.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event group.",
          "type": "string"
        }
      },
      "required": [
        "events",
        "id",
        "label"
      ],
      "type": "object"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "properties": {
        "id": {
          "description": "The ID of the event type.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event type.",
          "type": "string"
        }
      },
      "required": [
        "id",
        "label"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "lastTriggered": {
      "description": "The date when the last notification with the policy was triggered.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "maximalFrequency": {
      "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the notification policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The ID of the organization that owns the notification policy.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedPoliciesCount": {
      "description": "The total number of entity policies that are using this template.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "role": {
      "description": "User role on entity.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "uid": {
      "description": "The identifier of the user who created the policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "updatedAt": {
      "description": "The date when the policy was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "active",
    "channel",
    "channelId",
    "created",
    "createdBy",
    "eventGroup",
    "eventType",
    "id",
    "lastTriggered",
    "name",
    "orgId",
    "relatedEntityType",
    "relatedPoliciesCount",
    "role",
    "uid",
    "updatedAt"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | Entity notification policy template retrieved successfully. | EntityNotificationPolicyTemplateResponse |

## Update an entity notification policy template by relatedentitytype

Operation path: `PUT /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/{policyId}/`

Authentication requirements: `BearerAuth`

Update the entity notification policy template.

### Body parameter

```
{
  "properties": {
    "active": {
      "description": "Whether the notification policy is active or not.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "enum": [
        "secure_config.all",
        "dataset.all",
        "file.all",
        "comment.all",
        "invite_job.all",
        "deployment_prediction_explanations_computation.all",
        "model_deployments.critical_health",
        "model_deployments.critical_frequent_health_change",
        "model_deployments.frequent_health_change",
        "model_deployments.health",
        "model_deployments.retraining_policy",
        "inference_endpoints.health",
        "model_deployments.management_agent",
        "model_deployments.management_agent_health",
        "prediction_request.all",
        "challenger_management.all",
        "challenger_replay.all",
        "model_deployments.all",
        "project.all",
        "perma_delete_project.all",
        "users_delete.all",
        "applications.all",
        "model_version.stage_transitions",
        "model_version.all",
        "use_case.all",
        "batch_predictions.all",
        "change_requests.all",
        "custom_job_run.all",
        "custom_job_run.unsuccessful",
        "insights_computation.all",
        "notebook_schedule.all",
        "monitoring.all"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "enum": [
        "secure_config.created",
        "secure_config.deleted",
        "secure_config.shared",
        "dataset.created",
        "dataset.registered",
        "dataset.deleted",
        "datasets.deleted",
        "datasetrelationship.created",
        "dataset.shared",
        "datasets.shared",
        "file.created",
        "file.registered",
        "file.deleted",
        "file.shared",
        "comment.created",
        "comment.updated",
        "invite_job.completed",
        "misc.asset_access_request",
        "misc.webhook_connection_test",
        "misc.webhook_resend",
        "misc.email_verification",
        "monitoring.spooler_channel_base",
        "monitoring.spooler_channel_red",
        "monitoring.spooler_channel_green",
        "monitoring.external_model_nan_predictions",
        "management.deploymentInfo",
        "model_deployments.None",
        "model_deployments.deployment_sharing",
        "model_deployments.model_replacement",
        "prediction_request.None",
        "prediction_request.failed",
        "model_deployments.humility_rule",
        "model_deployments.model_replacement_lifecycle",
        "model_deployments.model_replacement_started",
        "model_deployments.model_replacement_succeeded",
        "model_deployments.model_replacement_failed",
        "model_deployments.model_replacement_validation_warning",
        "model_deployments.deployment_creation",
        "model_deployments.deployment_deletion",
        "model_deployments.service_health_yellow_from_green",
        "model_deployments.service_health_yellow_from_red",
        "model_deployments.service_health_red",
        "model_deployments.data_drift_yellow_from_green",
        "model_deployments.data_drift_yellow_from_red",
        "model_deployments.data_drift_red",
        "model_deployments.accuracy_yellow_from_green",
        "model_deployments.accuracy_yellow_from_red",
        "model_deployments.accuracy_red",
        "model_deployments.health.fairness_health.green_to_yellow",
        "model_deployments.health.fairness_health.red_to_yellow",
        "model_deployments.health.fairness_health.red",
        "model_deployments.health.custom_metrics_health.green_to_yellow",
        "model_deployments.health.custom_metrics_health.red_to_yellow",
        "model_deployments.health.custom_metrics_health.red",
        "model_deployments.health.base.green",
        "model_deployments.service_health_green",
        "model_deployments.data_drift_green",
        "model_deployments.accuracy_green",
        "model_deployments.health.fairness_health.green",
        "model_deployments.health.custom_metrics_health.green",
        "model_deployments.retraining_policy_run_started",
        "model_deployments.retraining_policy_run_succeeded",
        "model_deployments.retraining_policy_run_failed",
        "model_deployments.challenger_scoring_success",
        "model_deployments.challenger_scoring_data_warning",
        "model_deployments.challenger_scoring_failure",
        "model_deployments.challenger_scoring_started",
        "model_deployments.challenger_model_validation_warning",
        "model_deployments.challenger_model_created",
        "model_deployments.challenger_model_deleted",
        "model_deployments.actuals_upload_failed",
        "model_deployments.actuals_upload_warning",
        "model_deployments.training_data_baseline_calculation_started",
        "model_deployments.training_data_baseline_calculation_completed",
        "model_deployments.training_data_baseline_failed",
        "model_deployments.custom_model_deployment_creation_started",
        "model_deployments.custom_model_deployment_creation_completed",
        "model_deployments.custom_model_deployment_creation_failed",
        "model_deployments.custom_model_deployment_secure_config_failure",
        "model_deployments.deployment_prediction_explanations_preview_job_submitted",
        "model_deployments.deployment_prediction_explanations_preview_job_completed",
        "model_deployments.deployment_prediction_explanations_preview_job_failed",
        "model_deployments.custom_model_deployment_activated",
        "model_deployments.custom_model_deployment_activation_failed",
        "model_deployments.custom_model_deployment_deactivated",
        "model_deployments.custom_model_deployment_deactivation_failed",
        "model_deployments.prediction_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_warning",
        "model_deployments.actuals_processing_rate_limit_reached",
        "model_deployments.actuals_processing_rate_limit_warning",
        "model_deployments.deployment_monitoring_data_cleared",
        "model_deployments.deployment_launch_started",
        "model_deployments.deployment_launch_succeeded",
        "model_deployments.deployment_launch_failed",
        "model_deployments.deployment_shutdown_started",
        "model_deployments.deployment_shutdown_succeeded",
        "model_deployments.deployment_shutdown_failed",
        "model_deployments.endpoint_update_started",
        "model_deployments.endpoint_update_succeeded",
        "model_deployments.endpoint_update_failed",
        "model_deployments.management_agent_service_health_green",
        "model_deployments.management_agent_service_health_yellow",
        "model_deployments.management_agent_service_health_red",
        "model_deployments.management_agent_service_health_unknown",
        "model_deployments.predictions_missing_association_id",
        "model_deployments.prediction_result_rows_cleand_up",
        "model_deployments.batch_deleted",
        "model_deployments.batch_creation_limit_reached",
        "model_deployments.batch_creation_limit_exceeded",
        "model_deployments.batch_not_found",
        "model_deployments.predictions_encountered_for_locked_batch",
        "model_deployments.predictions_encountered_for_deleted_batch",
        "model_deployments.scheduled_report_generated",
        "model_deployments.predictions_timeliness_health_red",
        "model_deployments.actuals_timeliness_health_red",
        "model_deployments.service_health_still_red",
        "model_deployments.data_drift_still_red",
        "model_deployments.accuracy_still_red",
        "model_deployments.health.fairness_health.still_red",
        "model_deployments.health.custom_metrics_health.still_red",
        "model_deployments.predictions_timeliness_health_still_red",
        "model_deployments.actuals_timeliness_health_still_red",
        "model_deployments.service_health_still_yellow",
        "model_deployments.data_drift_still_yellow",
        "model_deployments.accuracy_still_yellow",
        "model_deployments.health.fairness_health.still_yellow",
        "model_deployments.health.custom_metrics_health.still_yellow",
        "model_deployments.prediction_payload_parsing_failure",
        "model_deployments.deployment_inference_server_creation_started",
        "model_deployments.deployment_inference_server_creation_failed",
        "model_deployments.deployment_inference_server_creation_completed",
        "model_deployments.deployment_inference_server_deletion",
        "model_deployments.deployment_inference_server_idle_stopped",
        "model_deployments.deployment_inference_server_maintenance_started",
        "entity_notification_policy_template.shared",
        "notification_channel_template.shared",
        "project.created",
        "project.deleted",
        "project.shared",
        "autopilot.complete",
        "autopilot.started",
        "autostart.failure",
        "perma_delete_project.success",
        "perma_delete_project.failure",
        "users_delete.preview_started",
        "users_delete.preview_completed",
        "users_delete.preview_failed",
        "users_delete.started",
        "users_delete.completed",
        "users_delete.failed",
        "application.created",
        "application.shared",
        "model_version.added",
        "model_version.stage_transition_from_registered_to_development",
        "model_version.stage_transition_from_registered_to_staging",
        "model_version.stage_transition_from_registered_to_production",
        "model_version.stage_transition_from_registered_to_archived",
        "model_version.stage_transition_from_development_to_registered",
        "model_version.stage_transition_from_development_to_staging",
        "model_version.stage_transition_from_development_to_production",
        "model_version.stage_transition_from_development_to_archived",
        "model_version.stage_transition_from_staging_to_registered",
        "model_version.stage_transition_from_staging_to_development",
        "model_version.stage_transition_from_staging_to_production",
        "model_version.stage_transition_from_staging_to_archived",
        "model_version.stage_transition_from_production_to_registered",
        "model_version.stage_transition_from_production_to_development",
        "model_version.stage_transition_from_production_to_staging",
        "model_version.stage_transition_from_production_to_archived",
        "model_version.stage_transition_from_archived_to_registered",
        "model_version.stage_transition_from_archived_to_development",
        "model_version.stage_transition_from_archived_to_production",
        "model_version.stage_transition_from_archived_to_staging",
        "use_case.shared",
        "batch_predictions.success",
        "batch_predictions.failed",
        "batch_predictions.scheduler.auto_disabled",
        "change_request.cancelled",
        "change_request.created",
        "change_request.deployment_approval_requested",
        "change_request.resolved",
        "change_request.proposed_changes_updated",
        "change_request.pending",
        "change_request.commenting_review_added",
        "change_request.approving_review_added",
        "change_request.changes_requesting_review_added",
        "custom_job_run.success",
        "custom_job_run.failed",
        "custom_job_run.interrupted",
        "custom_job_run.cancelled",
        "prediction_explanations_computation.None",
        "prediction_explanations_computation.prediction_explanations_preview_job_submitted",
        "prediction_explanations_computation.prediction_explanations_preview_job_completed",
        "prediction_explanations_computation.prediction_explanations_preview_job_failed",
        "monitoring.rate_limit_enforced",
        "notebook_schedule.created",
        "notebook_schedule.failure",
        "notebook_schedule.completed",
        "abstract",
        "moderation.metric.creation_error",
        "moderation.metric.reporting_error",
        "moderation.model.moderation_started",
        "moderation.model.moderation_completed",
        "moderation.model.pre_score_phase_started",
        "moderation.model.pre_score_phase_completed",
        "moderation.model.post_score_phase_started",
        "moderation.model.post_score_phase_completed",
        "moderation.model.config_error",
        "moderation.model.runtime_error",
        "moderation.model.scoring_started",
        "moderation.model.scoring_completed",
        "moderation.model.scoring_error"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "maximalFrequency": {
      "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the notification policy.",
      "maxLength": 100,
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| policyId | path | string | true | The ID of the notification policy template. |
| relatedEntityType | path | string | true | The type of the related entity. |
| body | body | EntityNotificationPolicyTemplateUpdate | false | none |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | Entity notification policy template updated successfully. | None |

## Retrieve list of all policies that are created from this template and are visible by relatedentitytype

Operation path: `GET /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/{policyId}/relatedPolicies/`

Authentication requirements: `BearerAuth`

Retrieve list of all policies that are created from this template and are visible for user.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| offset | query | integer | true | How many notification channels to skip. |
| limit | query | integer | true | At most this many notification channels to return. |
| policyId | path | string | true | The ID of the notification policy template. |
| relatedEntityType | path | string | true | The type of the related entity. |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "The number of entity policies returned.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "The entity notification policies.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the notification policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedEntityId": {
            "description": "The id of related entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedEntityName": {
            "description": "The name of related entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedEntityType": {
            "description": "The type of the related entity.",
            "enum": [
              "deployment",
              "Deployment",
              "DEPLOYMENT",
              "customjob",
              "Customjob",
              "CUSTOMJOB"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name",
          "relatedEntityId",
          "relatedEntityName",
          "relatedEntityType"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "The total number of entity policies that satisfy the query.",
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | List of all policies that are created from this template and are visible for user | EntityNotificationPolicyTemplateRelatedPoliciesListResponse |

## Get the registered model access control list by relatedentitytype

Operation path: `GET /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/{policyId}/sharedRoles/`

Authentication requirements: `BearerAuth`

Get a list of users, groups and organizations who have access to this registered model and their roles on the registered model.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| id | query | string | false | Only return roles for a user, group or organization with this identifier. |
| offset | query | integer | true | This many results will be skipped |
| limit | query | integer | true | At most this many results are returned |
| name | query | string | false | Only return roles for a user, group or organization with this name. |
| shareRecipientType | query | string | false | The list of access controls for recipients with this type. |
| policyId | path | string | true | The ID of the notification policy template. |
| relatedEntityType | path | string | true | The type of the related entity. |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| shareRecipientType | [user, group, organization, externalApplication] |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "The number of items returned.",
      "type": "integer"
    },
    "data": {
      "description": "The access control list.",
      "items": {
        "properties": {
          "id": {
            "description": "The identifier of the recipient.",
            "type": "string"
          },
          "name": {
            "description": "The name of the recipient.",
            "type": "string"
          },
          "role": {
            "description": "The role of the recipient on this entity.",
            "enum": [
              "ADMIN",
              "CONSUMER",
              "DATA_SCIENTIST",
              "EDITOR",
              "OBSERVER",
              "OWNER",
              "READ_ONLY",
              "READ_WRITE",
              "USER"
            ],
            "type": "string"
          },
          "shareRecipientType": {
            "description": "The type of the recipient.",
            "enum": [
              "user",
              "group",
              "organization",
              "externalApplication"
            ],
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "role",
          "shareRecipientType"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ]
    },
    "totalCount": {
      "description": "The total number of items matching the condition.",
      "type": "integer"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | The registered model access control list. | SharingListV2Response |
| 404 | Not Found | Either the Registered Model does not exist or the user does not have permissions to view the Registered Model. | None |
| 422 | Unprocessable Entity | Both username and userId were specified | None |

## Update the registered model controls by relatedentitytype

Operation path: `PATCH /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/{policyId}/sharedRoles/`

Authentication requirements: `BearerAuth`

Set roles for users on this registered model.

### Body parameter

```
{
  "properties": {
    "operation": {
      "description": "Name of the action being taken. The only operation is 'updateRoles'.",
      "enum": [
        "updateRoles"
      ],
      "type": "string"
    },
    "roles": {
      "description": "Array of GrantAccessControl objects., up to maximum 100 objects.",
      "items": {
        "oneOf": [
          {
            "properties": {
              "role": {
                "description": "The role of the recipient on this entity.",
                "enum": [
                  "ADMIN",
                  "CONSUMER",
                  "DATA_SCIENTIST",
                  "EDITOR",
                  "NO_ROLE",
                  "OBSERVER",
                  "OWNER",
                  "READ_ONLY",
                  "READ_WRITE",
                  "USER"
                ],
                "type": "string"
              },
              "shareRecipientType": {
                "description": "Describes the recipient type — one of user, group, organization, or externalApplication.",
                "enum": [
                  "user",
                  "group",
                  "organization",
                  "externalApplication"
                ],
                "type": "string"
              },
              "username": {
                "description": "Username of the user to update the access role for.",
                "type": "string"
              }
            },
            "required": [
              "role",
              "shareRecipientType",
              "username"
            ],
            "type": "object"
          },
          {
            "properties": {
              "id": {
                "description": "The ID of the recipient.",
                "type": "string"
              },
              "role": {
                "description": "The role of the recipient on this entity.",
                "enum": [
                  "ADMIN",
                  "CONSUMER",
                  "DATA_SCIENTIST",
                  "EDITOR",
                  "NO_ROLE",
                  "OBSERVER",
                  "OWNER",
                  "READ_ONLY",
                  "READ_WRITE",
                  "USER"
                ],
                "type": "string"
              },
              "shareRecipientType": {
                "description": "Describes the recipient type — one of user, group, organization, or externalApplication.",
                "enum": [
                  "user",
                  "group",
                  "organization",
                  "externalApplication"
                ],
                "type": "string"
              }
            },
            "required": [
              "id",
              "role",
              "shareRecipientType"
            ],
            "type": "object"
          }
        ]
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array"
    }
  },
  "required": [
    "operation",
    "roles"
  ],
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| policyId | path | string | true | The ID of the notification policy template. |
| relatedEntityType | path | string | true | The type of the related entity. |
| body | body | SharedRolesUpdate | false | none |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | The roles were updated successfully. | None |
| 409 | Conflict | The request would leave the registered model without an owner. | None |
| 422 | Unprocessable Entity | One of the users in the request does not exist, or the request is otherwise invalid | None |

## List notification channel templates

Operation path: `GET /api/v2/notificationChannelTemplates/`

Authentication requirements: `BearerAuth`

List the notification channel template according to the query.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| offset | query | integer | true | The number of notification channels to skip. |
| limit | query | integer | true | The maximum number of notification channels to return. |
| namePart | query | string | false | Only return the notification channels whose names contain the given substring. |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "The number of channel templates returned.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "The notification channel templates.",
      "items": {
        "properties": {
          "channelType": {
            "description": "The type of the new notification channel.",
            "enum": [
              "DataRobotCustomJob",
              "DataRobotGroup",
              "DataRobotUser",
              "Database",
              "Email",
              "InApp",
              "InsightsComputations",
              "MSTeams",
              "Slack",
              "Webhook"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "contentType": {
            "description": "The content type of the messages of the new notification channel.",
            "enum": [
              "application/json",
              "application/x-www-form-urlencoded"
            ],
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "createdAt": {
            "description": "The date of the notification channel creation.",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "createdBy": {
            "description": "The user who created the template.",
            "properties": {
              "firstName": {
                "description": "First Name.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "lastName": {
                "description": "Last Name.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "username": {
                "description": "Username.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "firstName",
              "lastName",
              "username"
            ],
            "type": "object"
          },
          "customHeaders": {
            "description": "Custom headers and their values to be sent in the new notification channel.",
            "items": {
              "properties": {
                "name": {
                  "description": "The name of the header.",
                  "type": "string"
                },
                "value": {
                  "description": "The value of the header.",
                  "type": "string"
                }
              },
              "required": [
                "name",
                "value"
              ],
              "type": "object"
            },
            "maxItems": 100,
            "type": "array",
            "x-versionadded": "v2.33"
          },
          "drEntities": {
            "description": "The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.",
            "items": {
              "properties": {
                "id": {
                  "description": "The ID of the DataRobot entity.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                },
                "name": {
                  "description": "The name of the entity.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                }
              },
              "required": [
                "id",
                "name"
              ],
              "type": "object"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array",
            "x-versionadded": "v2.33"
          },
          "emailAddress": {
            "description": "The email address to be used in the new notification channel.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "id": {
            "description": "The ID of the notification channel.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "languageCode": {
            "description": "The preferred language code.",
            "enum": [
              "en",
              "es_419",
              "fr",
              "ja",
              "ko",
              "ptBR"
            ],
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "lastNotificationAt": {
            "description": "The timestamp of the last notification sent to the channel.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the new notification channel.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "orgId": {
            "description": "The id of organization that notification channel belongs to.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "payloadUrl": {
            "description": "The payload URL of the new notification channel.",
            "format": "uri",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "policyCount": {
            "description": "The count of policies assigned to the channel.",
            "type": "integer",
            "x-versionadded": "v2.33"
          },
          "policyTemplatesCount": {
            "description": "The count of policy templates assigned to the channel.",
            "type": "integer",
            "x-versionadded": "v2.33"
          },
          "role": {
            "description": "User role on entity.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "secretToken": {
            "description": "Secret token to be used for new notification channel.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "uid": {
            "description": "The identifier of the user who created the channel.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "updatedAt": {
            "description": "The date when the channel was updated.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "validateSsl": {
            "description": "Defines if  validate ssl or not in the notification channel.",
            "type": [
              "boolean",
              "null"
            ],
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "channelType",
          "contentType",
          "createdAt",
          "createdBy",
          "customHeaders",
          "emailAddress",
          "id",
          "languageCode",
          "lastNotificationAt",
          "name",
          "orgId",
          "payloadUrl",
          "policyCount",
          "policyTemplatesCount",
          "role",
          "secretToken",
          "uid",
          "updatedAt",
          "validateSsl"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "The total number of channel templates that satisfy the query.",
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | Notification channel templates listed successfully. | NotificationChannelTemplatesListResponse |

## Create a notification channel template

Operation path: `POST /api/v2/notificationChannelTemplates/`

Authentication requirements: `BearerAuth`

Create a new notification channel template.

### Body parameter

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "DataRobotCustomJob",
        "DataRobotGroup",
        "DataRobotUser",
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "drEntities": {
      "description": "The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the DataRobot entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "maxLength": 100,
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The id of organization that notification channel belongs to.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "verificationCode": {
      "description": "Required if the channel type is Email.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "channelType",
    "name"
  ],
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| body | body | NotificationChannelTemplateCreate | false | none |

### Example responses

> 201 Response

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "DataRobotCustomJob",
        "DataRobotGroup",
        "DataRobotUser",
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "createdAt": {
      "description": "The date of the notification channel creation.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "The user who created the template.",
      "properties": {
        "firstName": {
          "description": "First Name.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "lastName": {
          "description": "Last Name.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "username": {
          "description": "Username.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "firstName",
        "lastName",
        "username"
      ],
      "type": "object"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "drEntities": {
      "description": "The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the DataRobot entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "id": {
      "description": "The ID of the notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "lastNotificationAt": {
      "description": "The timestamp of the last notification sent to the channel.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The id of organization that notification channel belongs to.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "policyCount": {
      "description": "The count of policies assigned to the channel.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "policyTemplatesCount": {
      "description": "The count of policy templates assigned to the channel.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "role": {
      "description": "User role on entity.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "uid": {
      "description": "The identifier of the user who created the channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "updatedAt": {
      "description": "The date when the channel was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": [
        "boolean",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "channelType",
    "contentType",
    "createdAt",
    "createdBy",
    "customHeaders",
    "emailAddress",
    "id",
    "languageCode",
    "lastNotificationAt",
    "name",
    "orgId",
    "payloadUrl",
    "policyCount",
    "policyTemplatesCount",
    "role",
    "secretToken",
    "uid",
    "updatedAt",
    "validateSsl"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 201 | Created | Notification channel template created successfully. | NotificationChannelTemplateResponse |

## Delete a notification channel template by channel ID

Operation path: `DELETE /api/v2/notificationChannelTemplates/{channelId}/`

Authentication requirements: `BearerAuth`

Delete the notification channel template.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| channelId | path | string | true | The ID of the notification channel. |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | Notification channel template deleted successfully. | None |

## Retrieve a notification channel template by channel ID

Operation path: `GET /api/v2/notificationChannelTemplates/{channelId}/`

Authentication requirements: `BearerAuth`

Retrieve the notification channel template.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| channelId | path | string | true | The ID of the notification channel. |

### Example responses

> 200 Response

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "DataRobotCustomJob",
        "DataRobotGroup",
        "DataRobotUser",
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "createdAt": {
      "description": "The date of the notification channel creation.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "The user who created the template.",
      "properties": {
        "firstName": {
          "description": "First Name.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "lastName": {
          "description": "Last Name.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "username": {
          "description": "Username.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "firstName",
        "lastName",
        "username"
      ],
      "type": "object"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "drEntities": {
      "description": "The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the DataRobot entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "id": {
      "description": "The ID of the notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "lastNotificationAt": {
      "description": "The timestamp of the last notification sent to the channel.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The id of organization that notification channel belongs to.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "policyCount": {
      "description": "The count of policies assigned to the channel.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "policyTemplatesCount": {
      "description": "The count of policy templates assigned to the channel.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "role": {
      "description": "User role on entity.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "uid": {
      "description": "The identifier of the user who created the channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "updatedAt": {
      "description": "The date when the channel was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": [
        "boolean",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "channelType",
    "contentType",
    "createdAt",
    "createdBy",
    "customHeaders",
    "emailAddress",
    "id",
    "languageCode",
    "lastNotificationAt",
    "name",
    "orgId",
    "payloadUrl",
    "policyCount",
    "policyTemplatesCount",
    "role",
    "secretToken",
    "uid",
    "updatedAt",
    "validateSsl"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | Notification channel template retrieved successfully. | NotificationChannelTemplateResponse |

## Update a notification channel template by channel ID

Operation path: `PUT /api/v2/notificationChannelTemplates/{channelId}/`

Authentication requirements: `BearerAuth`

Update the notification channel template.

### Body parameter

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "DataRobotCustomJob",
        "DataRobotGroup",
        "DataRobotUser",
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "drEntities": {
      "description": "The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the DataRobot entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "maxLength": 100,
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "verificationCode": {
      "description": "Required if the channel type is Email.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| channelId | path | string | true | The ID of the notification channel. |
| body | body | NotificationChannelWithDREntityUpdate | false | none |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | Notification channel template updated successfully. | None |
| 400 | Bad Request | Email verification code is invalid. | None |

## Retrieve list of all policy templates that are using this channel and are visible by channel ID

Operation path: `GET /api/v2/notificationChannelTemplates/{channelId}/policyTemplates/`

Authentication requirements: `BearerAuth`

Retrieve list of all policy templates that are using this channel and are visible for user.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| offset | query | integer | true | The number of notification channels to skip. |
| limit | query | integer | true | The maximum number of notification channels to return. |
| channelId | path | string | true | The ID of the notification channel. |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "The number of entity policies returned.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "The entity notification policy template.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the policy template.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the notification policy template.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedEntityType": {
            "description": "The type of the related entity template.",
            "enum": [
              "deployment",
              "Deployment",
              "DEPLOYMENT",
              "customjob",
              "Customjob",
              "CUSTOMJOB"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name",
          "relatedEntityType"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "The total number of entity policies that satisfy the query.",
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | List of all policy templates that are using this channel and are visible for user | NotificationChannelTemplateRelatedPolicyTemplateListResponse |

## Retrieve list of all policies that are created from this template and are visible by channel ID

Operation path: `GET /api/v2/notificationChannelTemplates/{channelId}/relatedPolicies/`

Authentication requirements: `BearerAuth`

Retrieve list of all policies that are created from this template and are visible for user.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| offset | query | integer | true | The number of notification channels to skip. |
| limit | query | integer | true | The maximum number of notification channels to return. |
| channelId | path | string | true | The ID of the notification channel. |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "The number of entity policies returned.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "The entity notification policies.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the notification policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedEntityId": {
            "description": "The id of related entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedEntityName": {
            "description": "The name of related entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedEntityType": {
            "description": "The type of the related entity.",
            "enum": [
              "deployment",
              "Deployment",
              "DEPLOYMENT",
              "customjob",
              "Customjob",
              "CUSTOMJOB"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name",
          "relatedEntityId",
          "relatedEntityName",
          "relatedEntityType"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "The total number of entity policies that satisfy the query.",
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | List of all policies that are created from this template and are visible for user | NotificationChannelTemplateRelatedPoliciesListResponse |

## Get the channel template access control list by channel ID

Operation path: `GET /api/v2/notificationChannelTemplates/{channelId}/sharedRoles/`

Authentication requirements: `BearerAuth`

Get a list of users, groups and organizations who have access to this channel template and their roles on the channel template.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| id | query | string | false | Only return roles for a user, group or organization with this identifier. |
| offset | query | integer | true | This many results will be skipped |
| limit | query | integer | true | At most this many results are returned |
| name | query | string | false | Only return roles for a user, group or organization with this name. |
| shareRecipientType | query | string | false | The list of access controls for recipients with this type. |
| channelId | path | string | true | The ID of the notification channel. |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| shareRecipientType | [user, group, organization, externalApplication] |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "The number of items returned.",
      "type": "integer"
    },
    "data": {
      "description": "The access control list.",
      "items": {
        "properties": {
          "id": {
            "description": "The identifier of the recipient.",
            "type": "string"
          },
          "name": {
            "description": "The name of the recipient.",
            "type": "string"
          },
          "role": {
            "description": "The role of the recipient on this entity.",
            "enum": [
              "ADMIN",
              "CONSUMER",
              "DATA_SCIENTIST",
              "EDITOR",
              "OBSERVER",
              "OWNER",
              "READ_ONLY",
              "READ_WRITE",
              "USER"
            ],
            "type": "string"
          },
          "shareRecipientType": {
            "description": "The type of the recipient.",
            "enum": [
              "user",
              "group",
              "organization",
              "externalApplication"
            ],
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "role",
          "shareRecipientType"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ]
    },
    "totalCount": {
      "description": "The total number of items matching the condition.",
      "type": "integer"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | The channel template access control list. | SharingListV2Response |
| 404 | Not Found | Either the channel template does not exist or the user does not have permissions to view the channel template. | None |
| 422 | Unprocessable Entity | Both username and userId were specified | None |

## Update the channel template controls by channel ID

Operation path: `PATCH /api/v2/notificationChannelTemplates/{channelId}/sharedRoles/`

Authentication requirements: `BearerAuth`

Set roles for users on this channel template.

### Body parameter

```
{
  "properties": {
    "operation": {
      "description": "Name of the action being taken. The only operation is 'updateRoles'.",
      "enum": [
        "updateRoles"
      ],
      "type": "string"
    },
    "roles": {
      "description": "Array of GrantAccessControl objects., up to maximum 100 objects.",
      "items": {
        "oneOf": [
          {
            "properties": {
              "role": {
                "description": "The role of the recipient on this entity.",
                "enum": [
                  "ADMIN",
                  "CONSUMER",
                  "DATA_SCIENTIST",
                  "EDITOR",
                  "NO_ROLE",
                  "OBSERVER",
                  "OWNER",
                  "READ_ONLY",
                  "READ_WRITE",
                  "USER"
                ],
                "type": "string"
              },
              "shareRecipientType": {
                "description": "Describes the recipient type — one of user, group, organization, or externalApplication.",
                "enum": [
                  "user",
                  "group",
                  "organization",
                  "externalApplication"
                ],
                "type": "string"
              },
              "username": {
                "description": "Username of the user to update the access role for.",
                "type": "string"
              }
            },
            "required": [
              "role",
              "shareRecipientType",
              "username"
            ],
            "type": "object"
          },
          {
            "properties": {
              "id": {
                "description": "The ID of the recipient.",
                "type": "string"
              },
              "role": {
                "description": "The role of the recipient on this entity.",
                "enum": [
                  "ADMIN",
                  "CONSUMER",
                  "DATA_SCIENTIST",
                  "EDITOR",
                  "NO_ROLE",
                  "OBSERVER",
                  "OWNER",
                  "READ_ONLY",
                  "READ_WRITE",
                  "USER"
                ],
                "type": "string"
              },
              "shareRecipientType": {
                "description": "Describes the recipient type — one of user, group, organization, or externalApplication.",
                "enum": [
                  "user",
                  "group",
                  "organization",
                  "externalApplication"
                ],
                "type": "string"
              }
            },
            "required": [
              "id",
              "role",
              "shareRecipientType"
            ],
            "type": "object"
          }
        ]
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array"
    }
  },
  "required": [
    "operation",
    "roles"
  ],
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| channelId | path | string | true | The ID of the notification channel. |
| body | body | SharedRolesUpdate | false | none |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | The roles were updated successfully. | None |
| 409 | Conflict | The request would leave the channel template without an owner. | None |
| 422 | Unprocessable Entity | One of the users in the request does not exist, or the request is otherwise invalid | None |

## List notification channels

Operation path: `GET /api/v2/notificationChannels/`

Authentication requirements: `BearerAuth`

List the notification channels according to the query.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| offset | query | integer | true | The number of notification channels to skip. |
| limit | query | integer | true | The maximum number of notification channels to return. |
| namePart | query | string | false | Only return the notification channels whose names contain the given substring. |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "The number of channels returned.",
      "type": "integer"
    },
    "data": {
      "description": "The notification channels.",
      "items": {
        "properties": {
          "channelType": {
            "description": "The type of the new notification channel.",
            "enum": [
              "Database",
              "Email",
              "InApp",
              "InsightsComputations",
              "MSTeams",
              "Slack",
              "Webhook"
            ],
            "type": "string"
          },
          "contentType": {
            "description": "The content type of the messages of the new notification channel.",
            "enum": [
              "application/json",
              "application/x-www-form-urlencoded"
            ],
            "type": [
              "string",
              "null"
            ]
          },
          "createdAt": {
            "description": "The date of the notification channel creation.",
            "format": "date-time",
            "type": "string"
          },
          "customHeaders": {
            "description": "Custom headers and their values to be sent in the new notification channel.",
            "items": {
              "properties": {
                "name": {
                  "description": "The name of the header.",
                  "type": "string"
                },
                "value": {
                  "description": "The value of the header.",
                  "type": "string"
                }
              },
              "required": [
                "name",
                "value"
              ],
              "type": "object"
            },
            "maxItems": 100,
            "type": "array"
          },
          "emailAddress": {
            "description": "The email address to be used in the new notification channel.",
            "type": [
              "string",
              "null"
            ]
          },
          "id": {
            "description": "The ID of the notification channel.",
            "type": "string"
          },
          "languageCode": {
            "description": "The preferred language code.",
            "enum": [
              "en",
              "es_419",
              "fr",
              "ja",
              "ko",
              "ptBR"
            ],
            "type": [
              "string",
              "null"
            ]
          },
          "lastNotificationAt": {
            "description": "The timestamp of the last notification sent to the channel.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "name": {
            "description": "The name of the new notification channel.",
            "type": "string"
          },
          "orgId": {
            "description": "The id of organization that notification channel belongs to.",
            "type": [
              "string",
              "null"
            ]
          },
          "payloadUrl": {
            "description": "The payload URL of the new notification channel.",
            "format": "uri",
            "type": [
              "string",
              "null"
            ]
          },
          "policyCount": {
            "description": "The count of policies assigned to the channel.",
            "type": "integer"
          },
          "secretToken": {
            "description": "Secret token to be used for new notification channel.",
            "type": [
              "string",
              "null"
            ]
          },
          "uid": {
            "description": "The identifier of the user who created the channel.",
            "type": [
              "string",
              "null"
            ]
          },
          "updatedAt": {
            "description": "The date when the channel was updated.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "validateSsl": {
            "description": "Defines if  validate ssl or not in the notification channel.",
            "type": [
              "boolean",
              "null"
            ]
          }
        },
        "required": [
          "channelType",
          "contentType",
          "createdAt",
          "customHeaders",
          "emailAddress",
          "id",
          "languageCode",
          "lastNotificationAt",
          "name",
          "orgId",
          "payloadUrl",
          "policyCount",
          "secretToken",
          "uid",
          "updatedAt",
          "validateSsl"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ]
    },
    "totalCount": {
      "description": "The total number of channels that satisfy the query.",
      "type": "integer"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | The notification channels were listed successfully. | NotificationChannelsListResponse |

## Create a notification channel

Operation path: `POST /api/v2/notificationChannels/`

Authentication requirements: `BearerAuth`

Create a new notification channel.

### Body parameter

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": "string"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": "string"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": "string"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "maxLength": 100,
      "type": "string"
    },
    "orgId": {
      "description": "The id of organization that notification channel belongs to.",
      "type": "string"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": "string"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": "string"
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": "boolean"
    },
    "verificationCode": {
      "description": "Required if the channel type is Email.",
      "type": "string"
    }
  },
  "required": [
    "channelType",
    "name"
  ],
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| body | body | NotificationChannelCreate | false | none |

### Example responses

> 201 Response

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "description": "The date of the notification channel creation.",
      "format": "date-time",
      "type": "string"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": [
        "string",
        "null"
      ]
    },
    "id": {
      "description": "The ID of the notification channel.",
      "type": "string"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "lastNotificationAt": {
      "description": "The timestamp of the last notification sent to the channel.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "name": {
      "description": "The name of the new notification channel.",
      "type": "string"
    },
    "orgId": {
      "description": "The id of organization that notification channel belongs to.",
      "type": [
        "string",
        "null"
      ]
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "policyCount": {
      "description": "The count of policies assigned to the channel.",
      "type": "integer"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": [
        "string",
        "null"
      ]
    },
    "uid": {
      "description": "The identifier of the user who created the channel.",
      "type": [
        "string",
        "null"
      ]
    },
    "updatedAt": {
      "description": "The date when the channel was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": [
        "boolean",
        "null"
      ]
    }
  },
  "required": [
    "channelType",
    "contentType",
    "createdAt",
    "customHeaders",
    "emailAddress",
    "id",
    "languageCode",
    "lastNotificationAt",
    "name",
    "orgId",
    "payloadUrl",
    "policyCount",
    "secretToken",
    "uid",
    "updatedAt",
    "validateSsl"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 201 | Created | The notification channel was created successfully. | NotificationChannelResponse |

## Delete a notification channel by channel ID

Operation path: `DELETE /api/v2/notificationChannels/{channelId}/`

Authentication requirements: `BearerAuth`

Delete the notification channel.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| channelId | path | string | true | The ID of the notification channel. |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | The notification channel was deleted successfully. | None |

## Retrieve a notification channel by channel ID

Operation path: `GET /api/v2/notificationChannels/{channelId}/`

Authentication requirements: `BearerAuth`

Retrieve the notification channel.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| channelId | path | string | true | The ID of the notification channel. |

### Example responses

> 200 Response

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "description": "The date of the notification channel creation.",
      "format": "date-time",
      "type": "string"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": [
        "string",
        "null"
      ]
    },
    "id": {
      "description": "The ID of the notification channel.",
      "type": "string"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "lastNotificationAt": {
      "description": "The timestamp of the last notification sent to the channel.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "name": {
      "description": "The name of the new notification channel.",
      "type": "string"
    },
    "orgId": {
      "description": "The id of organization that notification channel belongs to.",
      "type": [
        "string",
        "null"
      ]
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "policyCount": {
      "description": "The count of policies assigned to the channel.",
      "type": "integer"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": [
        "string",
        "null"
      ]
    },
    "uid": {
      "description": "The identifier of the user who created the channel.",
      "type": [
        "string",
        "null"
      ]
    },
    "updatedAt": {
      "description": "The date when the channel was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": [
        "boolean",
        "null"
      ]
    }
  },
  "required": [
    "channelType",
    "contentType",
    "createdAt",
    "customHeaders",
    "emailAddress",
    "id",
    "languageCode",
    "lastNotificationAt",
    "name",
    "orgId",
    "payloadUrl",
    "policyCount",
    "secretToken",
    "uid",
    "updatedAt",
    "validateSsl"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | The notification channel was retrieved successfully. | NotificationChannelResponse |

## Update a notification channel by channel ID

Operation path: `PUT /api/v2/notificationChannels/{channelId}/`

Authentication requirements: `BearerAuth`

Update the notification channel.

### Body parameter

```
{
  "properties": {
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": "string"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": "string"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": "string"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "maxLength": 100,
      "type": "string"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": "string"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": "string"
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": "boolean"
    },
    "verificationCode": {
      "description": "Required if the channel type is Email.",
      "type": "string"
    }
  },
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| channelId | path | string | true | The ID of the notification channel. |
| body | body | NotificationChannelUpdate | false | none |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | The notification channel was updated successfully. | None |
| 400 | Bad Request | Email verification code is invalid. | None |

## Send a 6-digit verification code

Operation path: `POST /api/v2/notificationEmailChannelVerification/`

Authentication requirements: `BearerAuth`

Send a 6-digit verification code to the user's email.

### Body parameter

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "type": "string"
    },
    "emailAddress": {
      "description": "The email address of the recipient.",
      "type": "string"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "maxLength": 100,
      "type": "string"
    },
    "orgId": {
      "description": "The ID of the organization that the notification channel belongs to.",
      "type": "string"
    }
  },
  "required": [
    "channelType",
    "emailAddress",
    "name"
  ],
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| body | body | NotificationEmailChannelVerification | false | none |

### Example responses

> 200 Response

```
{
  "properties": {
    "notificationId": {
      "description": "The response body is the JSON object with notification_id in it.",
      "type": "string"
    }
  },
  "required": [
    "notificationId"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | none | NotificationEmailChannelVerificationResponse |

## Retrieve the status of whether the admin entered the code correctly

Operation path: `POST /api/v2/notificationEmailChannelVerificationStatus/`

Authentication requirements: `BearerAuth`

Retrieve the status of whether the admin entered the code correctly.

### Body parameter

```
{
  "properties": {
    "emailAddress": {
      "description": "The email address of the recipient.",
      "type": "string"
    },
    "verificationCode": {
      "description": "The user-entered verification code.",
      "type": "string"
    }
  },
  "required": [
    "emailAddress",
    "verificationCode"
  ],
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| body | body | NotificationEmailChannelVerificationStatus | false | none |

### Example responses

> 200 Response

```
{
  "properties": {
    "status": {
      "description": "The status shows whether the admin entered the correct 6-digit verification code.",
      "type": "boolean"
    }
  },
  "required": [
    "status"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | none | NotificationEmailChannelVerificationStatusResponse |

## The list of event types and groups the user can include

Operation path: `GET /api/v2/notificationEvents/`

Authentication requirements: `BearerAuth`

The list of event types and groups the user can include in notification policies. Events and groups are filtered by user permissions and event properties. It is not a complete list of all defined events; instead, it is the list of the events available to the user.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| relatedEntityType | query | string | false | The type of the related entity. |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

### Example responses

> 200 Response

```
{
  "properties": {
    "eventGroups": {
      "description": "The selectable event groups.",
      "items": {
        "properties": {
          "events": {
            "description": "The event types belonging to the group.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "id": {
            "description": "The group ID.",
            "type": "string"
          },
          "label": {
            "description": "The group name for display.",
            "type": "string"
          },
          "requireMaxFrequency": {
            "description": "Indicates if a group requires max frequency setting.",
            "type": "boolean"
          }
        },
        "required": [
          "events",
          "id",
          "label",
          "requireMaxFrequency"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "events": {
      "description": "The selectable individual events.",
      "items": {
        "properties": {
          "id": {
            "description": "The event type as an ID.",
            "type": "string"
          },
          "label": {
            "description": "The event type for display.",
            "type": "string"
          },
          "requireMaxFrequency": {
            "description": "Indicates if an event requires max frequency setting.",
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "label",
          "requireMaxFrequency"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "eventGroups",
    "events"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | The event types and groups selectable for notification policies. | NotificationEventListResponse |

## List the notification logs

Operation path: `GET /api/v2/notificationLogs/`

Authentication requirements: `BearerAuth`

List the notification logs that correspond to provided conditions. Default ordering is desc by notification log timestamp.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| offset | query | integer | true | The number of records to skip over. Default 0. |
| limit | query | integer | true | The number of records to return. Default 100, minimum 1, maximum 1000. |
| policyId | query | string | false | The ID of the policy to filter notification logs. |
| channelId | query | string | false | The ID of the channel to filter notification logs. |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "The number of items returned on this page.",
      "type": "integer"
    },
    "data": {
      "description": "The array of notification logs.",
      "items": {
        "properties": {
          "channelId": {
            "description": "The ID of the channel that was used to send the notification.",
            "type": "string"
          },
          "channelScope": {
            "description": "The scope of the channel.",
            "enum": [
              "organization",
              "Organization",
              "ORGANIZATION",
              "entity",
              "Entity",
              "ENTITY",
              "template",
              "Template",
              "TEMPLATE"
            ],
            "type": [
              "string",
              "null"
            ]
          },
          "emailSubject": {
            "description": "The email subject.",
            "type": "string"
          },
          "id": {
            "description": "The ID of the notification log.",
            "type": "string"
          },
          "parentNotificationId": {
            "description": "The ID of the parent notification",
            "type": [
              "string",
              "null"
            ]
          },
          "policyId": {
            "description": "The ID of the policy that was used to send the notification.",
            "type": "string"
          },
          "request": {
            "description": "The request that was sent in the notification.",
            "properties": {
              "body": {
                "description": "The body of the request.",
                "type": "string"
              },
              "headers": {
                "description": "The headers of the request.",
                "type": "string"
              },
              "url": {
                "description": "The URL of the request.",
                "format": "uri",
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "body",
              "headers",
              "url"
            ],
            "type": "object"
          },
          "response": {
            "description": "The response that was received after sending the notification.",
            "properties": {
              "body": {
                "description": "The body of the response.",
                "type": "string"
              },
              "duration": {
                "description": "The duration.",
                "type": "integer"
              },
              "headers": {
                "description": "The headers of the response.",
                "type": "string"
              },
              "statusCode": {
                "description": "The status code of the response.",
                "type": "string"
              }
            },
            "required": [
              "body",
              "duration",
              "headers",
              "statusCode"
            ],
            "type": "object"
          },
          "retryCount": {
            "description": "The count of retries while sending the notification.",
            "type": "integer"
          },
          "status": {
            "description": "The status of the notification.",
            "type": [
              "string",
              "null"
            ]
          },
          "timestamp": {
            "description": "The date and time when the notification was sent.",
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "channelId",
          "channelScope",
          "emailSubject",
          "id",
          "parentNotificationId",
          "policyId",
          "request",
          "response",
          "retryCount",
          "status",
          "timestamp"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "next": {
      "description": "The URL of the next page (if null, there is no next page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL of the previous page (if null, there is no previous page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "totalCount": {
      "description": "The total number of notifications.",
      "type": "integer"
    }
  },
  "required": [
    "data",
    "next",
    "previous"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | none | NotificationLogListResponse |

## List notification policies

Operation path: `GET /api/v2/notificationPolicies/`

Authentication requirements: `BearerAuth`

List the notification policies that satisfy the query condition.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| offset | query | integer | true | How many notification channels to skip. |
| limit | query | integer | true | At most this many notification channels to return. |
| channelId | query | string | false | Return policies with this channel. |
| namePart | query | string | false | Only return the notification channels whose names contain the given substring. |
| eventGroup | query | string | false | Return policies with this event group. |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| eventGroup | [secure_config.all, dataset.all, file.all, comment.all, invite_job.all, deployment_prediction_explanations_computation.all, model_deployments.critical_health, model_deployments.critical_frequent_health_change, model_deployments.frequent_health_change, model_deployments.health, model_deployments.retraining_policy, inference_endpoints.health, model_deployments.management_agent, model_deployments.management_agent_health, prediction_request.all, challenger_management.all, challenger_replay.all, model_deployments.all, project.all, perma_delete_project.all, users_delete.all, applications.all, model_version.stage_transitions, model_version.all, use_case.all, batch_predictions.all, change_requests.all, custom_job_run.all, custom_job_run.unsuccessful, insights_computation.all, notebook_schedule.all, monitoring.all] |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "The number of policies returned.",
      "type": "integer"
    },
    "data": {
      "description": "The notification policies.",
      "items": {
        "properties": {
          "active": {
            "description": "Defines if the notification policy is active or not.",
            "type": "boolean"
          },
          "channel": {
            "description": "The notification channel information used to send the notification.",
            "properties": {
              "channelType": {
                "description": "The type of the new notification channel.",
                "enum": [
                  "Database",
                  "Email",
                  "InApp",
                  "InsightsComputations",
                  "MSTeams",
                  "Slack",
                  "Webhook"
                ],
                "type": "string"
              },
              "contentType": {
                "description": "The content type of the messages of the new notification channel.",
                "enum": [
                  "application/json",
                  "application/x-www-form-urlencoded"
                ],
                "type": [
                  "string",
                  "null"
                ]
              },
              "createdAt": {
                "description": "The date of the notification channel creation.",
                "format": "date-time",
                "type": "string"
              },
              "customHeaders": {
                "description": "Custom headers and their values to be sent in the new notification channel.",
                "items": {
                  "properties": {
                    "name": {
                      "description": "The name of the header.",
                      "type": "string"
                    },
                    "value": {
                      "description": "The value of the header.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "name",
                    "value"
                  ],
                  "type": "object"
                },
                "maxItems": 100,
                "type": "array"
              },
              "emailAddress": {
                "description": "The email address to be used in the new notification channel.",
                "type": [
                  "string",
                  "null"
                ]
              },
              "id": {
                "description": "The ID of the notification channel.",
                "type": "string"
              },
              "languageCode": {
                "description": "The preferred language code.",
                "enum": [
                  "en",
                  "es_419",
                  "fr",
                  "ja",
                  "ko",
                  "ptBR"
                ],
                "type": [
                  "string",
                  "null"
                ]
              },
              "name": {
                "description": "The name of the new notification channel.",
                "type": "string"
              },
              "orgId": {
                "description": "The ID of the organization that the notification channel belongs to.",
                "type": [
                  "string",
                  "null"
                ]
              },
              "payloadUrl": {
                "description": "The payload URL of the new notification channel.",
                "format": "uri",
                "type": [
                  "string",
                  "null"
                ]
              },
              "secretToken": {
                "description": "Secret token to be used for new notification channel.",
                "type": [
                  "string",
                  "null"
                ]
              },
              "uid": {
                "description": "The identifier of the user who created the channel.",
                "type": [
                  "string",
                  "null"
                ]
              },
              "updatedAt": {
                "description": "The date when the channel was updated.",
                "format": "date-time",
                "type": [
                  "string",
                  "null"
                ]
              },
              "validateSsl": {
                "description": "Whether to validate SSL for the notification channel.",
                "type": [
                  "boolean",
                  "null"
                ]
              }
            },
            "required": [
              "channelType",
              "contentType",
              "createdAt",
              "customHeaders",
              "emailAddress",
              "id",
              "languageCode",
              "name",
              "orgId",
              "payloadUrl",
              "secretToken",
              "uid",
              "updatedAt",
              "validateSsl"
            ],
            "type": "object"
          },
          "channelId": {
            "description": "The ID of the notification channel to be used to send the notification.",
            "type": "string"
          },
          "created": {
            "description": "The date when the policy was created.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "eventGroup": {
            "description": "The group of the event that triggers the notification.",
            "properties": {
              "events": {
                "description": "The events included in this group.",
                "items": {
                  "description": "The type of the event that triggers the notification.",
                  "properties": {
                    "id": {
                      "description": "The ID of the event type.",
                      "type": "string"
                    },
                    "label": {
                      "description": "The display name of the event type.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "label"
                  ],
                  "type": "object"
                },
                "maxItems": 1000,
                "type": "array"
              },
              "id": {
                "description": "The ID of the event group.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event group.",
                "type": "string"
              }
            },
            "required": [
              "events",
              "id",
              "label"
            ],
            "type": "object"
          },
          "eventType": {
            "description": "The type of the event that triggers the notification.",
            "properties": {
              "id": {
                "description": "The ID of the event type.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event type.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "label"
            ],
            "type": "object"
          },
          "id": {
            "description": "The ID of the policy.",
            "type": "string"
          },
          "lastTriggered": {
            "description": "The date when the last notification with the policy was triggered.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "name": {
            "description": "The name of the notification policy.",
            "type": "string"
          },
          "orgId": {
            "description": "The ID of the organization that owns the notification policy.",
            "type": [
              "string",
              "null"
            ]
          },
          "uid": {
            "description": "The identifier of the user who created the policy.",
            "type": "string"
          },
          "updatedAt": {
            "description": "The date when the policy was updated.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "active",
          "channel",
          "channelId",
          "created",
          "eventGroup",
          "eventType",
          "id",
          "lastTriggered",
          "name",
          "orgId",
          "uid",
          "updatedAt"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ]
    },
    "totalCount": {
      "description": "The total number of policies that satisfy the query.",
      "type": "integer"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | Notification policies listed successfully. | NotificationPoliciesListResponse |

## Create a notification policy

Operation path: `POST /api/v2/notificationPolicies/`

Authentication requirements: `BearerAuth`

Create a new notification policy.

### Body parameter

```
{
  "properties": {
    "active": {
      "description": "Whether the notification policy is active or not.",
      "type": "boolean"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "enum": [
        "secure_config.all",
        "dataset.all",
        "file.all",
        "comment.all",
        "invite_job.all",
        "deployment_prediction_explanations_computation.all",
        "model_deployments.critical_health",
        "model_deployments.critical_frequent_health_change",
        "model_deployments.frequent_health_change",
        "model_deployments.health",
        "model_deployments.retraining_policy",
        "inference_endpoints.health",
        "model_deployments.management_agent",
        "model_deployments.management_agent_health",
        "prediction_request.all",
        "challenger_management.all",
        "challenger_replay.all",
        "model_deployments.all",
        "project.all",
        "perma_delete_project.all",
        "users_delete.all",
        "applications.all",
        "model_version.stage_transitions",
        "model_version.all",
        "use_case.all",
        "batch_predictions.all",
        "change_requests.all",
        "custom_job_run.all",
        "custom_job_run.unsuccessful",
        "insights_computation.all",
        "notebook_schedule.all",
        "monitoring.all"
      ],
      "type": "string"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "enum": [
        "secure_config.created",
        "secure_config.deleted",
        "secure_config.shared",
        "dataset.created",
        "dataset.registered",
        "dataset.deleted",
        "datasets.deleted",
        "datasetrelationship.created",
        "dataset.shared",
        "datasets.shared",
        "file.created",
        "file.registered",
        "file.deleted",
        "file.shared",
        "comment.created",
        "comment.updated",
        "invite_job.completed",
        "misc.asset_access_request",
        "misc.webhook_connection_test",
        "misc.webhook_resend",
        "misc.email_verification",
        "monitoring.spooler_channel_base",
        "monitoring.spooler_channel_red",
        "monitoring.spooler_channel_green",
        "monitoring.external_model_nan_predictions",
        "management.deploymentInfo",
        "model_deployments.None",
        "model_deployments.deployment_sharing",
        "model_deployments.model_replacement",
        "prediction_request.None",
        "prediction_request.failed",
        "model_deployments.humility_rule",
        "model_deployments.model_replacement_lifecycle",
        "model_deployments.model_replacement_started",
        "model_deployments.model_replacement_succeeded",
        "model_deployments.model_replacement_failed",
        "model_deployments.model_replacement_validation_warning",
        "model_deployments.deployment_creation",
        "model_deployments.deployment_deletion",
        "model_deployments.service_health_yellow_from_green",
        "model_deployments.service_health_yellow_from_red",
        "model_deployments.service_health_red",
        "model_deployments.data_drift_yellow_from_green",
        "model_deployments.data_drift_yellow_from_red",
        "model_deployments.data_drift_red",
        "model_deployments.accuracy_yellow_from_green",
        "model_deployments.accuracy_yellow_from_red",
        "model_deployments.accuracy_red",
        "model_deployments.health.fairness_health.green_to_yellow",
        "model_deployments.health.fairness_health.red_to_yellow",
        "model_deployments.health.fairness_health.red",
        "model_deployments.health.custom_metrics_health.green_to_yellow",
        "model_deployments.health.custom_metrics_health.red_to_yellow",
        "model_deployments.health.custom_metrics_health.red",
        "model_deployments.health.base.green",
        "model_deployments.service_health_green",
        "model_deployments.data_drift_green",
        "model_deployments.accuracy_green",
        "model_deployments.health.fairness_health.green",
        "model_deployments.health.custom_metrics_health.green",
        "model_deployments.retraining_policy_run_started",
        "model_deployments.retraining_policy_run_succeeded",
        "model_deployments.retraining_policy_run_failed",
        "model_deployments.challenger_scoring_success",
        "model_deployments.challenger_scoring_data_warning",
        "model_deployments.challenger_scoring_failure",
        "model_deployments.challenger_scoring_started",
        "model_deployments.challenger_model_validation_warning",
        "model_deployments.challenger_model_created",
        "model_deployments.challenger_model_deleted",
        "model_deployments.actuals_upload_failed",
        "model_deployments.actuals_upload_warning",
        "model_deployments.training_data_baseline_calculation_started",
        "model_deployments.training_data_baseline_calculation_completed",
        "model_deployments.training_data_baseline_failed",
        "model_deployments.custom_model_deployment_creation_started",
        "model_deployments.custom_model_deployment_creation_completed",
        "model_deployments.custom_model_deployment_creation_failed",
        "model_deployments.custom_model_deployment_secure_config_failure",
        "model_deployments.deployment_prediction_explanations_preview_job_submitted",
        "model_deployments.deployment_prediction_explanations_preview_job_completed",
        "model_deployments.deployment_prediction_explanations_preview_job_failed",
        "model_deployments.custom_model_deployment_activated",
        "model_deployments.custom_model_deployment_activation_failed",
        "model_deployments.custom_model_deployment_deactivated",
        "model_deployments.custom_model_deployment_deactivation_failed",
        "model_deployments.prediction_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_warning",
        "model_deployments.actuals_processing_rate_limit_reached",
        "model_deployments.actuals_processing_rate_limit_warning",
        "model_deployments.deployment_monitoring_data_cleared",
        "model_deployments.deployment_launch_started",
        "model_deployments.deployment_launch_succeeded",
        "model_deployments.deployment_launch_failed",
        "model_deployments.deployment_shutdown_started",
        "model_deployments.deployment_shutdown_succeeded",
        "model_deployments.deployment_shutdown_failed",
        "model_deployments.endpoint_update_started",
        "model_deployments.endpoint_update_succeeded",
        "model_deployments.endpoint_update_failed",
        "model_deployments.management_agent_service_health_green",
        "model_deployments.management_agent_service_health_yellow",
        "model_deployments.management_agent_service_health_red",
        "model_deployments.management_agent_service_health_unknown",
        "model_deployments.predictions_missing_association_id",
        "model_deployments.prediction_result_rows_cleand_up",
        "model_deployments.batch_deleted",
        "model_deployments.batch_creation_limit_reached",
        "model_deployments.batch_creation_limit_exceeded",
        "model_deployments.batch_not_found",
        "model_deployments.predictions_encountered_for_locked_batch",
        "model_deployments.predictions_encountered_for_deleted_batch",
        "model_deployments.scheduled_report_generated",
        "model_deployments.predictions_timeliness_health_red",
        "model_deployments.actuals_timeliness_health_red",
        "model_deployments.service_health_still_red",
        "model_deployments.data_drift_still_red",
        "model_deployments.accuracy_still_red",
        "model_deployments.health.fairness_health.still_red",
        "model_deployments.health.custom_metrics_health.still_red",
        "model_deployments.predictions_timeliness_health_still_red",
        "model_deployments.actuals_timeliness_health_still_red",
        "model_deployments.service_health_still_yellow",
        "model_deployments.data_drift_still_yellow",
        "model_deployments.accuracy_still_yellow",
        "model_deployments.health.fairness_health.still_yellow",
        "model_deployments.health.custom_metrics_health.still_yellow",
        "model_deployments.prediction_payload_parsing_failure",
        "model_deployments.deployment_inference_server_creation_started",
        "model_deployments.deployment_inference_server_creation_failed",
        "model_deployments.deployment_inference_server_creation_completed",
        "model_deployments.deployment_inference_server_deletion",
        "model_deployments.deployment_inference_server_idle_stopped",
        "model_deployments.deployment_inference_server_maintenance_started",
        "entity_notification_policy_template.shared",
        "notification_channel_template.shared",
        "project.created",
        "project.deleted",
        "project.shared",
        "autopilot.complete",
        "autopilot.started",
        "autostart.failure",
        "perma_delete_project.success",
        "perma_delete_project.failure",
        "users_delete.preview_started",
        "users_delete.preview_completed",
        "users_delete.preview_failed",
        "users_delete.started",
        "users_delete.completed",
        "users_delete.failed",
        "application.created",
        "application.shared",
        "model_version.added",
        "model_version.stage_transition_from_registered_to_development",
        "model_version.stage_transition_from_registered_to_staging",
        "model_version.stage_transition_from_registered_to_production",
        "model_version.stage_transition_from_registered_to_archived",
        "model_version.stage_transition_from_development_to_registered",
        "model_version.stage_transition_from_development_to_staging",
        "model_version.stage_transition_from_development_to_production",
        "model_version.stage_transition_from_development_to_archived",
        "model_version.stage_transition_from_staging_to_registered",
        "model_version.stage_transition_from_staging_to_development",
        "model_version.stage_transition_from_staging_to_production",
        "model_version.stage_transition_from_staging_to_archived",
        "model_version.stage_transition_from_production_to_registered",
        "model_version.stage_transition_from_production_to_development",
        "model_version.stage_transition_from_production_to_staging",
        "model_version.stage_transition_from_production_to_archived",
        "model_version.stage_transition_from_archived_to_registered",
        "model_version.stage_transition_from_archived_to_development",
        "model_version.stage_transition_from_archived_to_production",
        "model_version.stage_transition_from_archived_to_staging",
        "use_case.shared",
        "batch_predictions.success",
        "batch_predictions.failed",
        "batch_predictions.scheduler.auto_disabled",
        "change_request.cancelled",
        "change_request.created",
        "change_request.deployment_approval_requested",
        "change_request.resolved",
        "change_request.proposed_changes_updated",
        "change_request.pending",
        "change_request.commenting_review_added",
        "change_request.approving_review_added",
        "change_request.changes_requesting_review_added",
        "custom_job_run.success",
        "custom_job_run.failed",
        "custom_job_run.interrupted",
        "custom_job_run.cancelled",
        "prediction_explanations_computation.None",
        "prediction_explanations_computation.prediction_explanations_preview_job_submitted",
        "prediction_explanations_computation.prediction_explanations_preview_job_completed",
        "prediction_explanations_computation.prediction_explanations_preview_job_failed",
        "monitoring.rate_limit_enforced",
        "notebook_schedule.created",
        "notebook_schedule.failure",
        "notebook_schedule.completed",
        "abstract",
        "moderation.metric.creation_error",
        "moderation.metric.reporting_error",
        "moderation.model.moderation_started",
        "moderation.model.moderation_completed",
        "moderation.model.pre_score_phase_started",
        "moderation.model.pre_score_phase_completed",
        "moderation.model.post_score_phase_started",
        "moderation.model.post_score_phase_completed",
        "moderation.model.config_error",
        "moderation.model.runtime_error",
        "moderation.model.scoring_started",
        "moderation.model.scoring_completed",
        "moderation.model.scoring_error"
      ],
      "type": "string"
    },
    "name": {
      "description": "The name of the new notification policy.",
      "maxLength": 100,
      "type": "string"
    },
    "orgId": {
      "description": "The ID of the organization that owns the notification policy.",
      "type": "string"
    }
  },
  "required": [
    "channelId",
    "name"
  ],
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| body | body | NotificationPolicyCreate | false | none |

### Example responses

> 201 Response

```
{
  "properties": {
    "active": {
      "description": "Defines if the notification policy is active or not.",
      "type": "boolean"
    },
    "channel": {
      "description": "The notification channel information used to send the notification.",
      "properties": {
        "channelType": {
          "description": "The type of the new notification channel.",
          "enum": [
            "Database",
            "Email",
            "InApp",
            "InsightsComputations",
            "MSTeams",
            "Slack",
            "Webhook"
          ],
          "type": "string"
        },
        "contentType": {
          "description": "The content type of the messages of the new notification channel.",
          "enum": [
            "application/json",
            "application/x-www-form-urlencoded"
          ],
          "type": [
            "string",
            "null"
          ]
        },
        "createdAt": {
          "description": "The date of the notification channel creation.",
          "format": "date-time",
          "type": "string"
        },
        "customHeaders": {
          "description": "Custom headers and their values to be sent in the new notification channel.",
          "items": {
            "properties": {
              "name": {
                "description": "The name of the header.",
                "type": "string"
              },
              "value": {
                "description": "The value of the header.",
                "type": "string"
              }
            },
            "required": [
              "name",
              "value"
            ],
            "type": "object"
          },
          "maxItems": 100,
          "type": "array"
        },
        "emailAddress": {
          "description": "The email address to be used in the new notification channel.",
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "description": "The ID of the notification channel.",
          "type": "string"
        },
        "languageCode": {
          "description": "The preferred language code.",
          "enum": [
            "en",
            "es_419",
            "fr",
            "ja",
            "ko",
            "ptBR"
          ],
          "type": [
            "string",
            "null"
          ]
        },
        "name": {
          "description": "The name of the new notification channel.",
          "type": "string"
        },
        "orgId": {
          "description": "The ID of the organization that the notification channel belongs to.",
          "type": [
            "string",
            "null"
          ]
        },
        "payloadUrl": {
          "description": "The payload URL of the new notification channel.",
          "format": "uri",
          "type": [
            "string",
            "null"
          ]
        },
        "secretToken": {
          "description": "Secret token to be used for new notification channel.",
          "type": [
            "string",
            "null"
          ]
        },
        "uid": {
          "description": "The identifier of the user who created the channel.",
          "type": [
            "string",
            "null"
          ]
        },
        "updatedAt": {
          "description": "The date when the channel was updated.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "validateSsl": {
          "description": "Whether to validate SSL for the notification channel.",
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "required": [
        "channelType",
        "contentType",
        "createdAt",
        "customHeaders",
        "emailAddress",
        "id",
        "languageCode",
        "name",
        "orgId",
        "payloadUrl",
        "secretToken",
        "uid",
        "updatedAt",
        "validateSsl"
      ],
      "type": "object"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string"
    },
    "created": {
      "description": "The date when the policy was created.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "properties": {
        "events": {
          "description": "The events included in this group.",
          "items": {
            "description": "The type of the event that triggers the notification.",
            "properties": {
              "id": {
                "description": "The ID of the event type.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event type.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "label"
            ],
            "type": "object"
          },
          "maxItems": 1000,
          "type": "array"
        },
        "id": {
          "description": "The ID of the event group.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event group.",
          "type": "string"
        }
      },
      "required": [
        "events",
        "id",
        "label"
      ],
      "type": "object"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "properties": {
        "id": {
          "description": "The ID of the event type.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event type.",
          "type": "string"
        }
      },
      "required": [
        "id",
        "label"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the policy.",
      "type": "string"
    },
    "lastTriggered": {
      "description": "The date when the last notification with the policy was triggered.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "name": {
      "description": "The name of the notification policy.",
      "type": "string"
    },
    "orgId": {
      "description": "The ID of the organization that owns the notification policy.",
      "type": [
        "string",
        "null"
      ]
    },
    "uid": {
      "description": "The identifier of the user who created the policy.",
      "type": "string"
    },
    "updatedAt": {
      "description": "The date when the policy was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "active",
    "channel",
    "channelId",
    "created",
    "eventGroup",
    "eventType",
    "id",
    "lastTriggered",
    "name",
    "orgId",
    "uid",
    "updatedAt"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 201 | Created | Notification policy created successfully. | NotificationPolicyResponse |

## Delete a notification policy by policy ID

Operation path: `DELETE /api/v2/notificationPolicies/{policyId}/`

Authentication requirements: `BearerAuth`

Delete the notification policy.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| policyId | path | string | true | The ID of the notification policy. |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | Notification policy deleted successfully. | None |

## Retrieve a notification policy by policy ID

Operation path: `GET /api/v2/notificationPolicies/{policyId}/`

Authentication requirements: `BearerAuth`

Retrieve the notification policy.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| policyId | path | string | true | The ID of the notification policy. |

### Example responses

> 200 Response

```
{
  "properties": {
    "active": {
      "description": "Defines if the notification policy is active or not.",
      "type": "boolean"
    },
    "channel": {
      "description": "The notification channel information used to send the notification.",
      "properties": {
        "channelType": {
          "description": "The type of the new notification channel.",
          "enum": [
            "Database",
            "Email",
            "InApp",
            "InsightsComputations",
            "MSTeams",
            "Slack",
            "Webhook"
          ],
          "type": "string"
        },
        "contentType": {
          "description": "The content type of the messages of the new notification channel.",
          "enum": [
            "application/json",
            "application/x-www-form-urlencoded"
          ],
          "type": [
            "string",
            "null"
          ]
        },
        "createdAt": {
          "description": "The date of the notification channel creation.",
          "format": "date-time",
          "type": "string"
        },
        "customHeaders": {
          "description": "Custom headers and their values to be sent in the new notification channel.",
          "items": {
            "properties": {
              "name": {
                "description": "The name of the header.",
                "type": "string"
              },
              "value": {
                "description": "The value of the header.",
                "type": "string"
              }
            },
            "required": [
              "name",
              "value"
            ],
            "type": "object"
          },
          "maxItems": 100,
          "type": "array"
        },
        "emailAddress": {
          "description": "The email address to be used in the new notification channel.",
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "description": "The ID of the notification channel.",
          "type": "string"
        },
        "languageCode": {
          "description": "The preferred language code.",
          "enum": [
            "en",
            "es_419",
            "fr",
            "ja",
            "ko",
            "ptBR"
          ],
          "type": [
            "string",
            "null"
          ]
        },
        "name": {
          "description": "The name of the new notification channel.",
          "type": "string"
        },
        "orgId": {
          "description": "The ID of the organization that the notification channel belongs to.",
          "type": [
            "string",
            "null"
          ]
        },
        "payloadUrl": {
          "description": "The payload URL of the new notification channel.",
          "format": "uri",
          "type": [
            "string",
            "null"
          ]
        },
        "secretToken": {
          "description": "Secret token to be used for new notification channel.",
          "type": [
            "string",
            "null"
          ]
        },
        "uid": {
          "description": "The identifier of the user who created the channel.",
          "type": [
            "string",
            "null"
          ]
        },
        "updatedAt": {
          "description": "The date when the channel was updated.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "validateSsl": {
          "description": "Whether to validate SSL for the notification channel.",
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "required": [
        "channelType",
        "contentType",
        "createdAt",
        "customHeaders",
        "emailAddress",
        "id",
        "languageCode",
        "name",
        "orgId",
        "payloadUrl",
        "secretToken",
        "uid",
        "updatedAt",
        "validateSsl"
      ],
      "type": "object"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string"
    },
    "created": {
      "description": "The date when the policy was created.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "properties": {
        "events": {
          "description": "The events included in this group.",
          "items": {
            "description": "The type of the event that triggers the notification.",
            "properties": {
              "id": {
                "description": "The ID of the event type.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event type.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "label"
            ],
            "type": "object"
          },
          "maxItems": 1000,
          "type": "array"
        },
        "id": {
          "description": "The ID of the event group.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event group.",
          "type": "string"
        }
      },
      "required": [
        "events",
        "id",
        "label"
      ],
      "type": "object"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "properties": {
        "id": {
          "description": "The ID of the event type.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event type.",
          "type": "string"
        }
      },
      "required": [
        "id",
        "label"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the policy.",
      "type": "string"
    },
    "lastTriggered": {
      "description": "The date when the last notification with the policy was triggered.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "name": {
      "description": "The name of the notification policy.",
      "type": "string"
    },
    "orgId": {
      "description": "The ID of the organization that owns the notification policy.",
      "type": [
        "string",
        "null"
      ]
    },
    "uid": {
      "description": "The identifier of the user who created the policy.",
      "type": "string"
    },
    "updatedAt": {
      "description": "The date when the policy was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "active",
    "channel",
    "channelId",
    "created",
    "eventGroup",
    "eventType",
    "id",
    "lastTriggered",
    "name",
    "orgId",
    "uid",
    "updatedAt"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | Notification policy retrieved successfully. | NotificationPolicyResponse |

## Update a notification policy by policy ID

Operation path: `PUT /api/v2/notificationPolicies/{policyId}/`

Authentication requirements: `BearerAuth`

Update the notification policy.

### Body parameter

```
{
  "properties": {
    "active": {
      "description": "Whether the notification policy is active or not.",
      "type": "boolean"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "enum": [
        "secure_config.all",
        "dataset.all",
        "file.all",
        "comment.all",
        "invite_job.all",
        "deployment_prediction_explanations_computation.all",
        "model_deployments.critical_health",
        "model_deployments.critical_frequent_health_change",
        "model_deployments.frequent_health_change",
        "model_deployments.health",
        "model_deployments.retraining_policy",
        "inference_endpoints.health",
        "model_deployments.management_agent",
        "model_deployments.management_agent_health",
        "prediction_request.all",
        "challenger_management.all",
        "challenger_replay.all",
        "model_deployments.all",
        "project.all",
        "perma_delete_project.all",
        "users_delete.all",
        "applications.all",
        "model_version.stage_transitions",
        "model_version.all",
        "use_case.all",
        "batch_predictions.all",
        "change_requests.all",
        "custom_job_run.all",
        "custom_job_run.unsuccessful",
        "insights_computation.all",
        "notebook_schedule.all",
        "monitoring.all"
      ],
      "type": "string"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "enum": [
        "secure_config.created",
        "secure_config.deleted",
        "secure_config.shared",
        "dataset.created",
        "dataset.registered",
        "dataset.deleted",
        "datasets.deleted",
        "datasetrelationship.created",
        "dataset.shared",
        "datasets.shared",
        "file.created",
        "file.registered",
        "file.deleted",
        "file.shared",
        "comment.created",
        "comment.updated",
        "invite_job.completed",
        "misc.asset_access_request",
        "misc.webhook_connection_test",
        "misc.webhook_resend",
        "misc.email_verification",
        "monitoring.spooler_channel_base",
        "monitoring.spooler_channel_red",
        "monitoring.spooler_channel_green",
        "monitoring.external_model_nan_predictions",
        "management.deploymentInfo",
        "model_deployments.None",
        "model_deployments.deployment_sharing",
        "model_deployments.model_replacement",
        "prediction_request.None",
        "prediction_request.failed",
        "model_deployments.humility_rule",
        "model_deployments.model_replacement_lifecycle",
        "model_deployments.model_replacement_started",
        "model_deployments.model_replacement_succeeded",
        "model_deployments.model_replacement_failed",
        "model_deployments.model_replacement_validation_warning",
        "model_deployments.deployment_creation",
        "model_deployments.deployment_deletion",
        "model_deployments.service_health_yellow_from_green",
        "model_deployments.service_health_yellow_from_red",
        "model_deployments.service_health_red",
        "model_deployments.data_drift_yellow_from_green",
        "model_deployments.data_drift_yellow_from_red",
        "model_deployments.data_drift_red",
        "model_deployments.accuracy_yellow_from_green",
        "model_deployments.accuracy_yellow_from_red",
        "model_deployments.accuracy_red",
        "model_deployments.health.fairness_health.green_to_yellow",
        "model_deployments.health.fairness_health.red_to_yellow",
        "model_deployments.health.fairness_health.red",
        "model_deployments.health.custom_metrics_health.green_to_yellow",
        "model_deployments.health.custom_metrics_health.red_to_yellow",
        "model_deployments.health.custom_metrics_health.red",
        "model_deployments.health.base.green",
        "model_deployments.service_health_green",
        "model_deployments.data_drift_green",
        "model_deployments.accuracy_green",
        "model_deployments.health.fairness_health.green",
        "model_deployments.health.custom_metrics_health.green",
        "model_deployments.retraining_policy_run_started",
        "model_deployments.retraining_policy_run_succeeded",
        "model_deployments.retraining_policy_run_failed",
        "model_deployments.challenger_scoring_success",
        "model_deployments.challenger_scoring_data_warning",
        "model_deployments.challenger_scoring_failure",
        "model_deployments.challenger_scoring_started",
        "model_deployments.challenger_model_validation_warning",
        "model_deployments.challenger_model_created",
        "model_deployments.challenger_model_deleted",
        "model_deployments.actuals_upload_failed",
        "model_deployments.actuals_upload_warning",
        "model_deployments.training_data_baseline_calculation_started",
        "model_deployments.training_data_baseline_calculation_completed",
        "model_deployments.training_data_baseline_failed",
        "model_deployments.custom_model_deployment_creation_started",
        "model_deployments.custom_model_deployment_creation_completed",
        "model_deployments.custom_model_deployment_creation_failed",
        "model_deployments.custom_model_deployment_secure_config_failure",
        "model_deployments.deployment_prediction_explanations_preview_job_submitted",
        "model_deployments.deployment_prediction_explanations_preview_job_completed",
        "model_deployments.deployment_prediction_explanations_preview_job_failed",
        "model_deployments.custom_model_deployment_activated",
        "model_deployments.custom_model_deployment_activation_failed",
        "model_deployments.custom_model_deployment_deactivated",
        "model_deployments.custom_model_deployment_deactivation_failed",
        "model_deployments.prediction_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_warning",
        "model_deployments.actuals_processing_rate_limit_reached",
        "model_deployments.actuals_processing_rate_limit_warning",
        "model_deployments.deployment_monitoring_data_cleared",
        "model_deployments.deployment_launch_started",
        "model_deployments.deployment_launch_succeeded",
        "model_deployments.deployment_launch_failed",
        "model_deployments.deployment_shutdown_started",
        "model_deployments.deployment_shutdown_succeeded",
        "model_deployments.deployment_shutdown_failed",
        "model_deployments.endpoint_update_started",
        "model_deployments.endpoint_update_succeeded",
        "model_deployments.endpoint_update_failed",
        "model_deployments.management_agent_service_health_green",
        "model_deployments.management_agent_service_health_yellow",
        "model_deployments.management_agent_service_health_red",
        "model_deployments.management_agent_service_health_unknown",
        "model_deployments.predictions_missing_association_id",
        "model_deployments.prediction_result_rows_cleand_up",
        "model_deployments.batch_deleted",
        "model_deployments.batch_creation_limit_reached",
        "model_deployments.batch_creation_limit_exceeded",
        "model_deployments.batch_not_found",
        "model_deployments.predictions_encountered_for_locked_batch",
        "model_deployments.predictions_encountered_for_deleted_batch",
        "model_deployments.scheduled_report_generated",
        "model_deployments.predictions_timeliness_health_red",
        "model_deployments.actuals_timeliness_health_red",
        "model_deployments.service_health_still_red",
        "model_deployments.data_drift_still_red",
        "model_deployments.accuracy_still_red",
        "model_deployments.health.fairness_health.still_red",
        "model_deployments.health.custom_metrics_health.still_red",
        "model_deployments.predictions_timeliness_health_still_red",
        "model_deployments.actuals_timeliness_health_still_red",
        "model_deployments.service_health_still_yellow",
        "model_deployments.data_drift_still_yellow",
        "model_deployments.accuracy_still_yellow",
        "model_deployments.health.fairness_health.still_yellow",
        "model_deployments.health.custom_metrics_health.still_yellow",
        "model_deployments.prediction_payload_parsing_failure",
        "model_deployments.deployment_inference_server_creation_started",
        "model_deployments.deployment_inference_server_creation_failed",
        "model_deployments.deployment_inference_server_creation_completed",
        "model_deployments.deployment_inference_server_deletion",
        "model_deployments.deployment_inference_server_idle_stopped",
        "model_deployments.deployment_inference_server_maintenance_started",
        "entity_notification_policy_template.shared",
        "notification_channel_template.shared",
        "project.created",
        "project.deleted",
        "project.shared",
        "autopilot.complete",
        "autopilot.started",
        "autostart.failure",
        "perma_delete_project.success",
        "perma_delete_project.failure",
        "users_delete.preview_started",
        "users_delete.preview_completed",
        "users_delete.preview_failed",
        "users_delete.started",
        "users_delete.completed",
        "users_delete.failed",
        "application.created",
        "application.shared",
        "model_version.added",
        "model_version.stage_transition_from_registered_to_development",
        "model_version.stage_transition_from_registered_to_staging",
        "model_version.stage_transition_from_registered_to_production",
        "model_version.stage_transition_from_registered_to_archived",
        "model_version.stage_transition_from_development_to_registered",
        "model_version.stage_transition_from_development_to_staging",
        "model_version.stage_transition_from_development_to_production",
        "model_version.stage_transition_from_development_to_archived",
        "model_version.stage_transition_from_staging_to_registered",
        "model_version.stage_transition_from_staging_to_development",
        "model_version.stage_transition_from_staging_to_production",
        "model_version.stage_transition_from_staging_to_archived",
        "model_version.stage_transition_from_production_to_registered",
        "model_version.stage_transition_from_production_to_development",
        "model_version.stage_transition_from_production_to_staging",
        "model_version.stage_transition_from_production_to_archived",
        "model_version.stage_transition_from_archived_to_registered",
        "model_version.stage_transition_from_archived_to_development",
        "model_version.stage_transition_from_archived_to_production",
        "model_version.stage_transition_from_archived_to_staging",
        "use_case.shared",
        "batch_predictions.success",
        "batch_predictions.failed",
        "batch_predictions.scheduler.auto_disabled",
        "change_request.cancelled",
        "change_request.created",
        "change_request.deployment_approval_requested",
        "change_request.resolved",
        "change_request.proposed_changes_updated",
        "change_request.pending",
        "change_request.commenting_review_added",
        "change_request.approving_review_added",
        "change_request.changes_requesting_review_added",
        "custom_job_run.success",
        "custom_job_run.failed",
        "custom_job_run.interrupted",
        "custom_job_run.cancelled",
        "prediction_explanations_computation.None",
        "prediction_explanations_computation.prediction_explanations_preview_job_submitted",
        "prediction_explanations_computation.prediction_explanations_preview_job_completed",
        "prediction_explanations_computation.prediction_explanations_preview_job_failed",
        "monitoring.rate_limit_enforced",
        "notebook_schedule.created",
        "notebook_schedule.failure",
        "notebook_schedule.completed",
        "abstract",
        "moderation.metric.creation_error",
        "moderation.metric.reporting_error",
        "moderation.model.moderation_started",
        "moderation.model.moderation_completed",
        "moderation.model.pre_score_phase_started",
        "moderation.model.pre_score_phase_completed",
        "moderation.model.post_score_phase_started",
        "moderation.model.post_score_phase_completed",
        "moderation.model.config_error",
        "moderation.model.runtime_error",
        "moderation.model.scoring_started",
        "moderation.model.scoring_completed",
        "moderation.model.scoring_error"
      ],
      "type": "string"
    },
    "name": {
      "description": "The name of the notification policy.",
      "maxLength": 100,
      "type": "string"
    }
  },
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| policyId | path | string | true | The ID of the notification policy. |
| body | body | NotificationPolicyUpdate | false | none |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | Notification policy updated successfully. | None |

## The list of the ignored notifications filtered by org ID if provided

Operation path: `GET /api/v2/notificationPolicyMutes/`

Authentication requirements: `BearerAuth`

The list of the ignored notifications filtered by org ID if provided.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| offset | query | integer | true | The number of records to skip over. Default 0. |
| limit | query | integer | true | The number of records to return. Default 100, minimum 1, maximum 1000. |
| entityId | query | string | false | The ID of the entity to filter. |
| orgId | query | string | false | The ID of the organization that ignored notifications relate to. |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "The number of items returned on this page.",
      "type": "integer"
    },
    "data": {
      "description": "The list of notification policy mutes.",
      "items": {
        "properties": {
          "entityId": {
            "description": "The ID of the entity to mute the notification for.",
            "type": "string"
          },
          "id": {
            "description": "The ID of the notification policy mute.",
            "type": "string"
          },
          "policyId": {
            "description": "The ID of the policy to mute notification for.",
            "type": "string"
          },
          "uid": {
            "description": "The UID of the notification policy mute.",
            "type": "string"
          }
        },
        "required": [
          "entityId",
          "id",
          "policyId",
          "uid"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array"
    },
    "next": {
      "description": "The URL pointing to the next page (if null, there is no next page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL pointing to the previous page (if null, there is no previous page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "totalCount": {
      "description": "The total number of items returned by the query.",
      "type": "integer"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | none | NotificationPolicyMuteListResponse |

## Create a new ignored notification

Operation path: `POST /api/v2/notificationPolicyMutes/`

Authentication requirements: `BearerAuth`

Create a new ignored notification.

### Body parameter

```
{
  "properties": {
    "entityId": {
      "description": "The ID of the entity to mute the notification for.",
      "type": "string"
    },
    "policyId": {
      "description": "The ID of the policy to mute notification for.",
      "type": "string"
    }
  },
  "required": [
    "entityId",
    "policyId"
  ],
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| body | body | NotificationPolicyMuteCreate | false | none |

### Example responses

> 200 Response

```
{
  "properties": {
    "entityId": {
      "description": "The ID of the entity to mute the notification for.",
      "type": "string"
    },
    "id": {
      "description": "The ID of the notification policy mute.",
      "type": "string"
    },
    "policyId": {
      "description": "The ID of the policy to mute notification for.",
      "type": "string"
    },
    "uid": {
      "description": "The UID of the notification policy mute.",
      "type": "string"
    }
  },
  "required": [
    "entityId",
    "id",
    "policyId",
    "uid"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | none | NotificationPolicyMuteResponse |

## Delete the existing notification policy mute by mute ID

Operation path: `DELETE /api/v2/notificationPolicyMutes/{muteId}/`

Authentication requirements: `BearerAuth`

Delete the existing notification policy mute.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| muteId | path | string | true | The ID of the notification policy mute to delete. |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | none | None |

## Test the webhook notification channel

Operation path: `POST /api/v2/notificationWebhookChannelTests/`

Authentication requirements: `BearerAuth`

Test the webhook notification channel.

### Body parameter

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": "string"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": "string"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "maxLength": 100,
      "type": "string"
    },
    "orgId": {
      "description": "The identifier of the organization that notification channel belongs to.",
      "type": "string"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": "string"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": "string"
    },
    "validateSsl": {
      "description": "Whether SSL will be validated in the notification channel.",
      "type": "boolean"
    }
  },
  "required": [
    "channelType",
    "name"
  ],
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| body | body | NotificationWebhookChannelTestCreate | false | none |

### Example responses

> 201 Response

```
{
  "properties": {
    "notificationId": {
      "description": "The ID of the notification.",
      "type": "string"
    }
  },
  "required": [
    "notificationId"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 201 | Created | The test for the webhook notification channel was created. | NotificationWebhookChannelTestId |

## Retrieve the status of the notification channel test by notification ID

Operation path: `GET /api/v2/notificationWebhookChannelTests/{notificationId}/`

Authentication requirements: `BearerAuth`

Retrieve the status of the notification channel test.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| notificationId | path | string | true | The ID of the notification. |

### Example responses

> 200 Response

```
{
  "properties": {
    "notificationLog": {
      "description": "The notification log record.",
      "properties": {
        "channelId": {
          "description": "The ID of the channel that was used to send the notification.",
          "type": "string"
        },
        "channelScope": {
          "description": "The scope of the channel.",
          "enum": [
            "organization",
            "Organization",
            "ORGANIZATION",
            "entity",
            "Entity",
            "ENTITY",
            "template",
            "Template",
            "TEMPLATE"
          ],
          "type": [
            "string",
            "null"
          ]
        },
        "emailSubject": {
          "description": "The email subject of the notification.",
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "description": "The ID of the notification log.",
          "type": "string"
        },
        "parentNotificationId": {
          "description": "The ID of the parent notification.",
          "type": [
            "string",
            "null"
          ]
        },
        "policyId": {
          "description": "The ID of the policy that was used to send the notification.",
          "type": "string"
        },
        "request": {
          "description": "The request that was sent in the notification.",
          "type": [
            "string",
            "null"
          ]
        },
        "response": {
          "description": "The response that was received after sending the notification.",
          "type": [
            "string",
            "null"
          ]
        },
        "retryCount": {
          "description": "The number of attempts to send the notification.",
          "type": [
            "integer",
            "null"
          ]
        },
        "status": {
          "description": "The status of the notification.",
          "type": "string"
        },
        "timestamp": {
          "description": "The date when the notification was sent.",
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "channelId",
        "channelScope",
        "emailSubject",
        "id",
        "parentNotificationId",
        "policyId",
        "request",
        "response",
        "retryCount",
        "status",
        "timestamp"
      ],
      "type": "object"
    },
    "status": {
      "description": "The status of the test notification.",
      "type": "string"
    }
  },
  "required": [
    "notificationLog",
    "status"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | The notification status was retrieved. | NotificationWebhookChannelStatusResponse |

## Resend the notification

Operation path: `POST /api/v2/notifications/`

Authentication requirements: `BearerAuth`

Resend the notification.

### Body parameter

```
{
  "properties": {
    "notificationId": {
      "description": "The ID of the notification to resend.",
      "type": "string"
    }
  },
  "required": [
    "notificationId"
  ],
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| body | body | NotificationResend | false | none |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 201 | Created | none | None |

## Post a remote deployment event

Operation path: `POST /api/v2/remoteEvents/`

Authentication requirements: `BearerAuth`

Post an event from a remote deployment.

### Body parameter

```
{
  "properties": {
    "data": {
      "description": "Event payload.",
      "properties": {
        "newModelId": {
          "description": "The identifier of the model after replacement.",
          "type": "string"
        },
        "oldModelId": {
          "description": "The identifier of the model before replacement.",
          "type": "string"
        },
        "reason": {
          "description": "The explanation on why the model has been replaced.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "deploymentId": {
      "description": "The identifier of the deployment associated with the event.",
      "type": "string"
    },
    "eventType": {
      "description": "The type of the event. Labels in all_lower_case are deprecated.",
      "enum": [
        "deploymentInfo",
        "externalNaNPredictions",
        "management.deploymentInfo",
        "model_deployments.accuracy_green",
        "model_deployments.accuracy_red",
        "model_deployments.accuracy_yellow_from_green",
        "model_deployments.data_drift_green",
        "model_deployments.data_drift_red",
        "model_deployments.data_drift_yellow_from_green",
        "model_deployments.model_replacement",
        "model_deployments.service_health_green",
        "model_deployments.service_health_red",
        "model_deployments.service_health_yellow_from_green",
        "moderationMetricCreationError",
        "moderationMetricReportingError",
        "moderationModelConfigError",
        "moderationModelModerationCompleted",
        "moderationModelModerationStarted",
        "moderationModelPostScorePhaseCompleted",
        "moderationModelPostScorePhaseStarted",
        "moderationModelPreScorePhaseCompleted",
        "moderationModelPreScorePhaseStarted",
        "moderationModelRuntimeError",
        "moderationModelScoringCompleted",
        "moderationModelScoringError",
        "moderationModelScoringStarted",
        "monitoring.external_model_nan_predictions",
        "monitoring.spooler_channel_green",
        "monitoring.spooler_channel_red",
        "predictionRequestFailed",
        "prediction_request.failed",
        "serviceHealthChangeGreen",
        "serviceHealthChangeRed",
        "serviceHealthChangeYellowFromGreen",
        "spoolerChannelGreen",
        "spoolerChannelRed"
      ],
      "type": "string"
    },
    "externalNanPredictionsData": {
      "description": "The external NaN predictions event payload.",
      "properties": {
        "count": {
          "description": "The number of NaN predictions by the external model.",
          "exclusiveMinimum": 0,
          "type": "integer"
        },
        "modelId": {
          "default": null,
          "description": "The identifier of the model.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "count",
        "modelId"
      ],
      "type": "object"
    },
    "message": {
      "description": "Descriptive message for health events.",
      "maxLength": 16384,
      "type": "string"
    },
    "moderationData": {
      "description": "The moderation event information.",
      "properties": {
        "guardName": {
          "description": "Name or label of the guard.",
          "maxLength": 255,
          "type": "string"
        },
        "metricName": {
          "description": "Name or label of the metric.",
          "maxLength": 255,
          "type": "string"
        }
      },
      "required": [
        "guardName",
        "metricName"
      ],
      "type": "object",
      "x-versionadded": "v2.35"
    },
    "orgId": {
      "description": "The identifier of the organization associated with the event.",
      "type": [
        "string",
        "null"
      ]
    },
    "predictionEnvironmentId": {
      "description": "The identifier of the prediction environment associated with the event.",
      "type": "string"
    },
    "predictionRequestData": {
      "description": "Prediction event payload.",
      "properties": {
        "error_code": {
          "description": "The error code if any.",
          "type": [
            "string",
            "null"
          ]
        },
        "model_id": {
          "description": "The identifier of the model.",
          "type": [
            "string",
            "null"
          ]
        },
        "response_body": {
          "description": "The response body message of the prediction event.",
          "type": "string"
        },
        "status_code": {
          "description": "The response status code of the prediction event.",
          "type": "integer"
        },
        "user_id": {
          "description": "The identifier of the user that accesses the deployment.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "response_body",
        "status_code"
      ],
      "type": "object"
    },
    "spoolerChannelData": {
      "description": "Spooler channel event payload.",
      "properties": {
        "name": {
          "description": "Name or label of the spooler channel.",
          "maxLength": 512,
          "type": "string"
        },
        "type": {
          "description": "Type of the spooler channel.",
          "enum": [
            "asyncMemory",
            "filesystem",
            "kafka",
            "memory",
            "pubSub",
            "rabbitMQ",
            "sqs"
          ],
          "type": "string"
        }
      },
      "required": [
        "name",
        "type"
      ],
      "type": "object"
    },
    "timestamp": {
      "description": "The time when the event occurred.",
      "format": "date-time",
      "type": "string"
    },
    "title": {
      "description": "The title of the event.",
      "maxLength": 512,
      "type": "string"
    }
  },
  "required": [
    "eventType",
    "timestamp"
  ],
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| body | body | RemoteEventCreate | false | none |

### Example responses

> 201 Response

```
{
  "properties": {
    "message": {
      "description": "The descriptive message about the event creation.",
      "type": "string"
    }
  },
  "required": [
    "message"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 201 | Created | The event was created. | CreateRemoteEventResponse |
| 404 | Not Found | The deployment was not found. | None |
| 422 | Unprocessable Entity | Unable to process the request instructions or failed to post the event. | None |

## Delete all user notifications

Operation path: `DELETE /api/v2/userNotifications/`

Authentication requirements: `BearerAuth`

Delete all notifications associated with the user.

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | Notifications were deleted. | None |

## The list of user notifications

Operation path: `GET /api/v2/userNotifications/`

Authentication requirements: `BearerAuth`

The list of the user's notifications from latest to oldest.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| offset | query | integer | false | The number of records to skip over. |
| limit | query | integer | false | The number of records to return. |
| isRead | query | boolean | false | When provided, returns only read or unread notifications. |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "The number of items returned on this page.",
      "type": "integer"
    },
    "data": {
      "description": "The list of the user's notifications.",
      "items": {
        "properties": {
          "callerUser": {
            "description": "Details about the user who triggered the notification.",
            "properties": {
              "fullName": {
                "description": "User's full name.",
                "type": [
                  "string",
                  "null"
                ]
              },
              "gravatarHash": {
                "description": "User's gravatar hash.",
                "type": "string"
              },
              "inactive": {
                "description": "True if the user was deleted.",
                "type": "boolean"
              },
              "uid": {
                "description": "The ID of the user.",
                "type": "string"
              },
              "username": {
                "description": "The username of the user.",
                "type": "string"
              }
            },
            "required": [
              "uid"
            ],
            "type": "object"
          },
          "created": {
            "description": "The ISO 8601 formatted date and time when the notification was created.",
            "format": "date-time",
            "type": "string"
          },
          "data": {
            "description": "Notification type-specific metadata.",
            "oneOf": [
              {
                "properties": {
                  "failedInvites": {
                    "description": "Failed invites.",
                    "items": {
                      "description": "Details about why the invite failed.",
                      "properties": {
                        "email": {
                          "description": "The email address of the invited user.",
                          "type": "string"
                        },
                        "errorMessage": {
                          "description": "The error message explaining why the invite failed.",
                          "type": "string"
                        },
                        "userId": {
                          "description": "The ID of the user.",
                          "type": "string"
                        }
                      },
                      "required": [
                        "email",
                        "errorMessage",
                        "userId"
                      ],
                      "type": "object",
                      "x-versionadded": "v2.39"
                    },
                    "maxItems": 20,
                    "type": "array"
                  },
                  "jobId": {
                    "description": "The ID of the invite job.",
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "statusId": {
                    "description": "The ID of the invite job status.",
                    "type": "string",
                    "x-versionadded": "v2.40"
                  },
                  "successfulInvites": {
                    "description": "Successful invites.",
                    "items": {
                      "description": "Details about the successful invite.",
                      "properties": {
                        "email": {
                          "description": "The email address of the invited user.",
                          "type": "string"
                        },
                        "userId": {
                          "description": "The ID of the user.",
                          "type": "string"
                        }
                      },
                      "required": [
                        "email",
                        "userId"
                      ],
                      "type": "object",
                      "x-versionadded": "v2.39"
                    },
                    "maxItems": 20,
                    "type": "array"
                  }
                },
                "required": [
                  "failedInvites",
                  "jobId",
                  "statusId",
                  "successfulInvites"
                ],
                "type": "object",
                "x-versionadded": "v2.39"
              },
              {
                "type": "null"
              }
            ],
            "x-versionadded": "v2.39"
          },
          "description": {
            "description": "The notification description.",
            "type": [
              "string",
              "null"
            ]
          },
          "eventType": {
            "description": "The type of the notification.",
            "enum": [
              "autopilot.complete",
              "project.shared",
              "comment.created",
              "comment.updated",
              "model_deployments.service_health_red",
              "model_deployments.data_drift_red",
              "model_deployments.accuracy_red",
              "model_deployments.health.fairness_health.red",
              "model_deployments.health.custom_metrics_health.red",
              "model_deployments.predictions_timeliness_health_red",
              "model_deployments.actuals_timeliness_health_red",
              "misc.asset_access_request",
              "users_delete.preview_started",
              "users_delete.preview_completed",
              "users_delete.preview_failed",
              "perma_delete_project.failure",
              "perma_delete_project.success",
              "secure_config.shared",
              "entity_notification_policy_template.shared",
              "notification_channel_template.shared",
              "invite_job.completed"
            ],
            "type": "string"
          },
          "isRead": {
            "description": "True if the notification is already read.",
            "type": "boolean"
          },
          "link": {
            "description": "The call-to-action link for the notification.",
            "type": "string"
          },
          "pushNotificationSent": {
            "description": "True if the notification was also sent via push notifications.",
            "type": "boolean"
          },
          "relatedComment": {
            "description": "Details about the comment related to the notification.",
            "properties": {
              "commentId": {
                "description": "The ID of the comment.",
                "type": "string"
              },
              "commentLink": {
                "description": "The link to the comment.",
                "type": "string"
              },
              "entityId": {
                "description": "The ID of the commented entity.",
                "type": "string"
              },
              "entityType": {
                "description": "The type of the commented entity.",
                "enum": [
                  "useCase",
                  "model",
                  "catalog",
                  "experimentContainer",
                  "deployment",
                  "workloadDeployment",
                  "workload"
                ],
                "type": "string"
              },
              "inactive": {
                "description": "True if the comment was deleted.",
                "type": "boolean"
              }
            },
            "required": [
              "commentId",
              "entityId"
            ],
            "type": "object"
          },
          "relatedDeployment": {
            "description": "Details about the deployment related to the notification.",
            "properties": {
              "deploymentId": {
                "description": "The ID of the deployment.",
                "type": "string"
              },
              "deploymentName": {
                "description": "The deployment label.",
                "type": [
                  "string",
                  "null"
                ]
              },
              "deploymentUrl": {
                "description": "The link to the deployment.",
                "type": "string"
              },
              "inactive": {
                "description": "True if the deployment was deleted.",
                "type": "boolean"
              },
              "modelId": {
                "description": "The ID of the related model.",
                "type": [
                  "string",
                  "null"
                ]
              },
              "projectId": {
                "description": "The ID of the related project.",
                "type": [
                  "string",
                  "null"
                ]
              },
              "userId": {
                "description": "The ID of the related user.",
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "deploymentId"
            ],
            "type": "object"
          },
          "relatedProject": {
            "description": "Details about the project related to the notification.",
            "properties": {
              "inactive": {
                "description": "True if the project was deleted.",
                "type": "boolean"
              },
              "pid": {
                "description": "The ID of the project.",
                "type": "string"
              },
              "projectLink": {
                "description": "The link to the project.",
                "type": "string"
              },
              "projectName": {
                "description": "The project name.",
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "pid"
            ],
            "type": "object"
          },
          "relatedSecureConfig": {
            "description": "Details about the secure config related to the notification.",
            "properties": {
              "secureConfigLink": {
                "description": "The link to the secure config.",
                "type": "string"
              },
              "secureConfigName": {
                "description": "The name of the secure config.",
                "type": "string"
              },
              "secureConfigSchemaName": {
                "description": "The type UUID of the secure config.",
                "type": "string"
              },
              "secureConfigSchemaUuid": {
                "description": "The type name of the secure config.",
                "type": "string"
              },
              "secureConfigUuid": {
                "description": "The ID of the secure config.",
                "type": "string"
              }
            },
            "required": [
              "secureConfigLink",
              "secureConfigName",
              "secureConfigSchemaName",
              "secureConfigSchemaUuid",
              "secureConfigUuid"
            ],
            "type": "object"
          },
          "relatedUsersDelete": {
            "description": "Details about the users permanent delete.",
            "properties": {
              "reportId": {
                "description": "The ID of the user's permanent delete report.",
                "type": "string"
              },
              "statusId": {
                "description": "The ID of the user's delete status.",
                "type": "string"
              },
              "usersToDeleteCount": {
                "description": "The number of users that will be deleted.",
                "type": "string"
              }
            },
            "required": [
              "reportId",
              "statusId",
              "usersToDeleteCount"
            ],
            "type": "object"
          },
          "sharedUsers": {
            "description": "The list of the user details a resource was shared with.",
            "items": {
              "description": "Details about the user who triggered the notification.",
              "properties": {
                "fullName": {
                  "description": "User's full name.",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "gravatarHash": {
                  "description": "User's gravatar hash.",
                  "type": "string"
                },
                "inactive": {
                  "description": "True if the user was deleted.",
                  "type": "boolean"
                },
                "uid": {
                  "description": "The ID of the user.",
                  "type": "string"
                },
                "username": {
                  "description": "The username of the user.",
                  "type": "string"
                }
              },
              "required": [
                "uid"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "statusId": {
            "description": "The asynchronous job status ID.",
            "type": "string"
          },
          "title": {
            "description": "The notification title.",
            "type": [
              "string",
              "null"
            ]
          },
          "tooltip": {
            "description": "The notification tooltip.",
            "type": [
              "string",
              "null"
            ]
          },
          "updated": {
            "description": "The ISO 8601 formatted date and time when the notification was updated.",
            "format": "date-time",
            "type": "string"
          },
          "userNotificationId": {
            "description": "The ID of the notification.",
            "type": "string"
          }
        },
        "required": [
          "callerUser",
          "created",
          "description",
          "eventType",
          "isRead",
          "link",
          "pushNotificationSent",
          "title",
          "tooltip",
          "updated",
          "userNotificationId"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array"
    },
    "next": {
      "description": "The URL of the next page (if null, there is no next page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL of the previous page (if null, there is no previous page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "totalCount": {
      "description": "The total number of items across all pages.",
      "type": "integer"
    }
  },
  "required": [
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | A paginated list of notifications. | UserNotificationListResponse |

## Mark all as read

Operation path: `PATCH /api/v2/userNotifications/`

Authentication requirements: `BearerAuth`

Mark all associated notifications with the user as read.

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | All notifications were marked as read. | None |

## Delete user notification by user notification ID

Operation path: `DELETE /api/v2/userNotifications/{userNotificationId}/`

Authentication requirements: `BearerAuth`

Delete one notification associated with the user.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| userNotificationId | path | string | true | Unique identifier of the notification. |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | Notification was deleted. | None |

## Mark as read by user notification ID

Operation path: `PATCH /api/v2/userNotifications/{userNotificationId}/`

Authentication requirements: `BearerAuth`

Mark one associated notification with the user as read.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| userNotificationId | path | string | true | Unique identifier of the notification. |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | Notification was marked as read. | None |

# Schemas

## AccessControlV2

```
{
  "properties": {
    "id": {
      "description": "The identifier of the recipient.",
      "type": "string"
    },
    "name": {
      "description": "The name of the recipient.",
      "type": "string"
    },
    "role": {
      "description": "The role of the recipient on this entity.",
      "enum": [
        "ADMIN",
        "CONSUMER",
        "DATA_SCIENTIST",
        "EDITOR",
        "OBSERVER",
        "OWNER",
        "READ_ONLY",
        "READ_WRITE",
        "USER"
      ],
      "type": "string"
    },
    "shareRecipientType": {
      "description": "The type of the recipient.",
      "enum": [
        "user",
        "group",
        "organization",
        "externalApplication"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "role",
    "shareRecipientType"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| id | string | true |  | The identifier of the recipient. |
| name | string | true |  | The name of the recipient. |
| role | string | true |  | The role of the recipient on this entity. |
| shareRecipientType | string | true |  | The type of the recipient. |

### Enumerated Values

| Property | Value |
| --- | --- |
| role | [ADMIN, CONSUMER, DATA_SCIENTIST, EDITOR, OBSERVER, OWNER, READ_ONLY, READ_WRITE, USER] |
| shareRecipientType | [user, group, organization, externalApplication] |

## ChannelCreatedByResponse

```
{
  "description": "The user who created the template.",
  "properties": {
    "firstName": {
      "description": "First Name.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "lastName": {
      "description": "Last Name.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "username": {
      "description": "Username.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "firstName",
    "lastName",
    "username"
  ],
  "type": "object"
}
```

The user who created the template.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| firstName | string,null | true |  | First Name. |
| lastName | string,null | true |  | Last Name. |
| username | string | true |  | Username. |

## ChannelDREntity

```
{
  "properties": {
    "id": {
      "description": "The id of DataRobot entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| id | string | true |  | The id of DataRobot entity. |
| name | string | true |  | The name of the entity. |

## CreateRemoteEventResponse

```
{
  "properties": {
    "message": {
      "description": "The descriptive message about the event creation.",
      "type": "string"
    }
  },
  "required": [
    "message"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| message | string | true |  | The descriptive message about the event creation. |

## CreatedByResponse

```
{
  "description": "User that created template.",
  "properties": {
    "firstName": {
      "description": "First Name.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "lastName": {
      "description": "Last Name.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "username": {
      "description": "Username.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "firstName",
    "lastName",
    "username"
  ],
  "type": "object"
}
```

User that created template.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| firstName | string,null | true |  | First Name. |
| lastName | string,null | true |  | Last Name. |
| username | string | true |  | Username. |

## CustomerHeader

```
{
  "properties": {
    "name": {
      "description": "The name of the header.",
      "type": "string"
    },
    "value": {
      "description": "The value of the header.",
      "type": "string"
    }
  },
  "required": [
    "name",
    "value"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| name | string | true |  | The name of the header. |
| value | string | true |  | The value of the header. |

## DREntity

```
{
  "properties": {
    "id": {
      "description": "The ID of the DataRobot entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| id | string | true |  | The ID of the DataRobot entity. |
| name | string | true |  | The name of the entity. |

## EntityNotificationChannel

```
{
  "description": "The notification channel information used to send the notification.",
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "DataRobotCustomJob",
        "DataRobotGroup",
        "DataRobotUser",
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "createdAt": {
      "description": "The date of the notification channel creation.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "drEntities": {
      "description": "The ids of DataRobot Users or Group for DataRobotUser or DataRobotGroup channel types.",
      "items": {
        "properties": {
          "id": {
            "description": "The id of DataRobot entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "id": {
      "description": "The ID of the notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The ID of the organization that the notification channel belongs to.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "relatedEntityId": {
      "description": "The id of related entity.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "Type of related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "uid": {
      "description": "The identifier of the user who created the channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "updatedAt": {
      "description": "The date when the channel was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "validateSsl": {
      "description": "Whether to validate SSL for the notification channel.",
      "type": [
        "boolean",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "channelType",
    "contentType",
    "createdAt",
    "customHeaders",
    "emailAddress",
    "id",
    "languageCode",
    "name",
    "orgId",
    "payloadUrl",
    "secretToken",
    "uid",
    "updatedAt",
    "validateSsl"
  ],
  "type": "object"
}
```

The notification channel information used to send the notification.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| channelType | string | true |  | The type of the new notification channel. |
| contentType | string,null | true |  | The content type of the messages of the new notification channel. |
| createdAt | string(date-time) | true |  | The date of the notification channel creation. |
| customHeaders | [CustomerHeader] | true | maxItems: 100 | Custom headers and their values to be sent in the new notification channel. |
| drEntities | [ChannelDREntity] | false | maxItems: 100minItems: 1 | The ids of DataRobot Users or Group for DataRobotUser or DataRobotGroup channel types. |
| emailAddress | string,null | true |  | The email address to be used in the new notification channel. |
| id | string | true |  | The ID of the notification channel. |
| languageCode | string,null | true |  | The preferred language code. |
| name | string | true |  | The name of the new notification channel. |
| orgId | string,null | true |  | The ID of the organization that the notification channel belongs to. |
| payloadUrl | string,null(uri) | true |  | The payload URL of the new notification channel. |
| relatedEntityId | string,null | false |  | The id of related entity. |
| relatedEntityType | string,null | false |  | Type of related entity. |
| secretToken | string,null | true |  | Secret token to be used for new notification channel. |
| uid | string,null | true |  | The identifier of the user who created the channel. |
| updatedAt | string,null(date-time) | true |  | The date when the channel was updated. |
| validateSsl | boolean,null | true |  | Whether to validate SSL for the notification channel. |

### Enumerated Values

| Property | Value |
| --- | --- |
| channelType | [DataRobotCustomJob, DataRobotGroup, DataRobotUser, Database, Email, InApp, InsightsComputations, MSTeams, Slack, Webhook] |
| contentType | [application/json, application/x-www-form-urlencoded] |
| languageCode | [en, es_419, fr, ja, ko, ptBR] |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

## EntityNotificationChannelCreate

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "DataRobotCustomJob",
        "DataRobotGroup",
        "DataRobotUser",
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "drEntities": {
      "description": "The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the DataRobot entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "maxLength": 100,
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The id of organization that notification channel belongs to.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityId": {
      "description": "The ID of the related entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "verificationCode": {
      "description": "Required if the channel type is Email.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "channelType",
    "name",
    "relatedEntityId",
    "relatedEntityType"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| channelType | string | true |  | The type of the new notification channel. |
| contentType | string | false |  | The content type of the messages of the new notification channel. |
| customHeaders | [CustomerHeader] | false | maxItems: 100 | Custom headers and their values to be sent in the new notification channel. |
| drEntities | [DREntity] | false | maxItems: 100minItems: 1 | The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types. |
| emailAddress | string | false |  | The email address to be used in the new notification channel. |
| languageCode | string | false |  | The preferred language code. |
| name | string | true | maxLength: 100 | The name of the new notification channel. |
| orgId | string | false |  | The id of organization that notification channel belongs to. |
| payloadUrl | string(uri) | false |  | The payload URL of the new notification channel. |
| relatedEntityId | string | true |  | The ID of the related entity. |
| relatedEntityType | string | true |  | The type of the related entity. |
| secretToken | string | false |  | Secret token to be used for new notification channel. |
| validateSsl | boolean | false |  | Defines if validate ssl or not in the notification channel. |
| verificationCode | string | false |  | Required if the channel type is Email. |

### Enumerated Values

| Property | Value |
| --- | --- |
| channelType | [DataRobotCustomJob, DataRobotGroup, DataRobotUser, Database, Email, InApp, InsightsComputations, MSTeams, Slack, Webhook] |
| contentType | [application/json, application/x-www-form-urlencoded] |
| languageCode | [en, es_419, fr, ja, ko, ptBR] |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

## EntityNotificationChannelResponse

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "DataRobotCustomJob",
        "DataRobotGroup",
        "DataRobotUser",
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "createdAt": {
      "description": "The date of the notification channel creation.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "drEntities": {
      "description": "The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the DataRobot entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "id": {
      "description": "The ID of the notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "lastNotificationAt": {
      "description": "The timestamp of the last notification sent to the channel.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The id of organization that notification channel belongs to.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "policyCount": {
      "description": "The count of policies assigned to the channel.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "relatedEntityId": {
      "description": "The ID of the related entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "uid": {
      "description": "The identifier of the user who created the channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "updatedAt": {
      "description": "The date when the channel was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": [
        "boolean",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "channelType",
    "contentType",
    "createdAt",
    "customHeaders",
    "emailAddress",
    "id",
    "languageCode",
    "lastNotificationAt",
    "name",
    "orgId",
    "payloadUrl",
    "policyCount",
    "relatedEntityId",
    "relatedEntityType",
    "secretToken",
    "uid",
    "updatedAt",
    "validateSsl"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| channelType | string | true |  | The type of the new notification channel. |
| contentType | string,null | true |  | The content type of the messages of the new notification channel. |
| createdAt | string(date-time) | true |  | The date of the notification channel creation. |
| customHeaders | [CustomerHeader] | true | maxItems: 100 | Custom headers and their values to be sent in the new notification channel. |
| drEntities | [DREntity] | false | maxItems: 100minItems: 1 | The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types. |
| emailAddress | string,null | true |  | The email address to be used in the new notification channel. |
| id | string | true |  | The ID of the notification channel. |
| languageCode | string,null | true |  | The preferred language code. |
| lastNotificationAt | string,null(date-time) | true |  | The timestamp of the last notification sent to the channel. |
| name | string | true |  | The name of the new notification channel. |
| orgId | string,null | true |  | The id of organization that notification channel belongs to. |
| payloadUrl | string,null(uri) | true |  | The payload URL of the new notification channel. |
| policyCount | integer | true |  | The count of policies assigned to the channel. |
| relatedEntityId | string | true |  | The ID of the related entity. |
| relatedEntityType | string | true |  | The type of the related entity. |
| secretToken | string,null | true |  | Secret token to be used for new notification channel. |
| uid | string,null | true |  | The identifier of the user who created the channel. |
| updatedAt | string,null(date-time) | true |  | The date when the channel was updated. |
| validateSsl | boolean,null | true |  | Defines if validate ssl or not in the notification channel. |

### Enumerated Values

| Property | Value |
| --- | --- |
| channelType | [DataRobotCustomJob, DataRobotGroup, DataRobotUser, Database, Email, InApp, InsightsComputations, MSTeams, Slack, Webhook] |
| contentType | [application/json, application/x-www-form-urlencoded] |
| languageCode | [en, es_419, fr, ja, ko, ptBR] |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

## EntityNotificationChannelsListResponse

```
{
  "properties": {
    "count": {
      "description": "The number of channels returned.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "The notification entity channels.",
      "items": {
        "properties": {
          "channelType": {
            "description": "The type of the new notification channel.",
            "enum": [
              "DataRobotCustomJob",
              "DataRobotGroup",
              "DataRobotUser",
              "Database",
              "Email",
              "InApp",
              "InsightsComputations",
              "MSTeams",
              "Slack",
              "Webhook"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "contentType": {
            "description": "The content type of the messages of the new notification channel.",
            "enum": [
              "application/json",
              "application/x-www-form-urlencoded"
            ],
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "createdAt": {
            "description": "The date of the notification channel creation.",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "customHeaders": {
            "description": "Custom headers and their values to be sent in the new notification channel.",
            "items": {
              "properties": {
                "name": {
                  "description": "The name of the header.",
                  "type": "string"
                },
                "value": {
                  "description": "The value of the header.",
                  "type": "string"
                }
              },
              "required": [
                "name",
                "value"
              ],
              "type": "object"
            },
            "maxItems": 100,
            "type": "array",
            "x-versionadded": "v2.33"
          },
          "drEntities": {
            "description": "The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.",
            "items": {
              "properties": {
                "id": {
                  "description": "The ID of the DataRobot entity.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                },
                "name": {
                  "description": "The name of the entity.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                }
              },
              "required": [
                "id",
                "name"
              ],
              "type": "object"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array",
            "x-versionadded": "v2.33"
          },
          "emailAddress": {
            "description": "The email address to be used in the new notification channel.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "id": {
            "description": "The ID of the notification channel.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "languageCode": {
            "description": "The preferred language code.",
            "enum": [
              "en",
              "es_419",
              "fr",
              "ja",
              "ko",
              "ptBR"
            ],
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "lastNotificationAt": {
            "description": "The timestamp of the last notification sent to the channel.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the new notification channel.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "orgId": {
            "description": "The id of organization that notification channel belongs to.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "payloadUrl": {
            "description": "The payload URL of the new notification channel.",
            "format": "uri",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "policyCount": {
            "description": "The count of policies assigned to the channel.",
            "type": "integer",
            "x-versionadded": "v2.33"
          },
          "relatedEntityId": {
            "description": "The ID of the related entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedEntityType": {
            "description": "The type of the related entity.",
            "enum": [
              "deployment",
              "Deployment",
              "DEPLOYMENT",
              "customjob",
              "Customjob",
              "CUSTOMJOB"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "secretToken": {
            "description": "Secret token to be used for new notification channel.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "uid": {
            "description": "The identifier of the user who created the channel.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "updatedAt": {
            "description": "The date when the channel was updated.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "validateSsl": {
            "description": "Defines if  validate ssl or not in the notification channel.",
            "type": [
              "boolean",
              "null"
            ],
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "channelType",
          "contentType",
          "createdAt",
          "customHeaders",
          "emailAddress",
          "id",
          "languageCode",
          "lastNotificationAt",
          "name",
          "orgId",
          "payloadUrl",
          "policyCount",
          "relatedEntityId",
          "relatedEntityType",
          "secretToken",
          "uid",
          "updatedAt",
          "validateSsl"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "The total number of channels that satisfy the query.",
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| count | integer | true |  | The number of channels returned. |
| data | [EntityNotificationChannelResponse] | true | maxItems: 1000 | The notification entity channels. |
| next | string,null | true |  | The URL pointing to the next page. |
| previous | string,null | true |  | The URL pointing to the previous page. |
| totalCount | integer | true |  | The total number of channels that satisfy the query. |

## EntityNotificationPoliciesListResponse

```
{
  "properties": {
    "count": {
      "description": "The number of entity policies returned.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "The entity notification policies.",
      "items": {
        "properties": {
          "active": {
            "description": "Defines if the notification policy is active or not.",
            "type": "boolean",
            "x-versionadded": "v2.33"
          },
          "channel": {
            "description": "The notification channel information used to send the notification.",
            "properties": {
              "channelType": {
                "description": "The type of the new notification channel.",
                "enum": [
                  "DataRobotCustomJob",
                  "DataRobotGroup",
                  "DataRobotUser",
                  "Database",
                  "Email",
                  "InApp",
                  "InsightsComputations",
                  "MSTeams",
                  "Slack",
                  "Webhook"
                ],
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "contentType": {
                "description": "The content type of the messages of the new notification channel.",
                "enum": [
                  "application/json",
                  "application/x-www-form-urlencoded"
                ],
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "createdAt": {
                "description": "The date of the notification channel creation.",
                "format": "date-time",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "customHeaders": {
                "description": "Custom headers and their values to be sent in the new notification channel.",
                "items": {
                  "properties": {
                    "name": {
                      "description": "The name of the header.",
                      "type": "string"
                    },
                    "value": {
                      "description": "The value of the header.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "name",
                    "value"
                  ],
                  "type": "object"
                },
                "maxItems": 100,
                "type": "array",
                "x-versionadded": "v2.33"
              },
              "drEntities": {
                "description": "The ids of DataRobot Users or Group for DataRobotUser or DataRobotGroup channel types.",
                "items": {
                  "properties": {
                    "id": {
                      "description": "The id of DataRobot entity.",
                      "type": "string",
                      "x-versionadded": "v2.33"
                    },
                    "name": {
                      "description": "The name of the entity.",
                      "type": "string",
                      "x-versionadded": "v2.33"
                    }
                  },
                  "required": [
                    "id",
                    "name"
                  ],
                  "type": "object"
                },
                "maxItems": 100,
                "minItems": 1,
                "type": "array",
                "x-versionadded": "v2.33"
              },
              "emailAddress": {
                "description": "The email address to be used in the new notification channel.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "id": {
                "description": "The ID of the notification channel.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "languageCode": {
                "description": "The preferred language code.",
                "enum": [
                  "en",
                  "es_419",
                  "fr",
                  "ja",
                  "ko",
                  "ptBR"
                ],
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "name": {
                "description": "The name of the new notification channel.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "orgId": {
                "description": "The ID of the organization that the notification channel belongs to.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "payloadUrl": {
                "description": "The payload URL of the new notification channel.",
                "format": "uri",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "relatedEntityId": {
                "description": "The id of related entity.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "relatedEntityType": {
                "description": "Type of related entity.",
                "enum": [
                  "deployment",
                  "Deployment",
                  "DEPLOYMENT",
                  "customjob",
                  "Customjob",
                  "CUSTOMJOB"
                ],
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "secretToken": {
                "description": "Secret token to be used for new notification channel.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "uid": {
                "description": "The identifier of the user who created the channel.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "updatedAt": {
                "description": "The date when the channel was updated.",
                "format": "date-time",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "validateSsl": {
                "description": "Whether to validate SSL for the notification channel.",
                "type": [
                  "boolean",
                  "null"
                ],
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "channelType",
              "contentType",
              "createdAt",
              "customHeaders",
              "emailAddress",
              "id",
              "languageCode",
              "name",
              "orgId",
              "payloadUrl",
              "secretToken",
              "uid",
              "updatedAt",
              "validateSsl"
            ],
            "type": "object"
          },
          "channelId": {
            "description": "The ID of the notification channel to be used to send the notification.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "channelScope": {
            "description": "Scope of the channel.",
            "enum": [
              "organization",
              "Organization",
              "ORGANIZATION",
              "entity",
              "Entity",
              "ENTITY",
              "template",
              "Template",
              "TEMPLATE"
            ],
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "created": {
            "description": "The date when the policy was created.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "eventGroup": {
            "description": "The group of the event that triggers the notification.",
            "properties": {
              "events": {
                "description": "The events included in this group.",
                "items": {
                  "description": "The type of the event that triggers the notification.",
                  "properties": {
                    "id": {
                      "description": "The ID of the event type.",
                      "type": "string"
                    },
                    "label": {
                      "description": "The display name of the event type.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "label"
                  ],
                  "type": "object"
                },
                "maxItems": 1000,
                "type": "array"
              },
              "id": {
                "description": "The ID of the event group.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event group.",
                "type": "string"
              }
            },
            "required": [
              "events",
              "id",
              "label"
            ],
            "type": "object"
          },
          "eventType": {
            "description": "The type of the event that triggers the notification.",
            "properties": {
              "id": {
                "description": "The ID of the event type.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event type.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "label"
            ],
            "type": "object"
          },
          "id": {
            "description": "The ID of the policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "lastTriggered": {
            "description": "The date when the last notification with the policy was triggered.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "maximalFrequency": {
            "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the notification policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "orgId": {
            "description": "The ID of the organization that owns the notification policy.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "relatedEntityId": {
            "description": "The id of related entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedEntityType": {
            "description": "The type of the related entity.",
            "enum": [
              "deployment",
              "Deployment",
              "DEPLOYMENT",
              "customjob",
              "Customjob",
              "CUSTOMJOB"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "templateId": {
            "description": "The id of template.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "uid": {
            "description": "The identifier of the user who created the policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "updatedAt": {
            "description": "The date when the policy was updated.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "active",
          "channel",
          "channelId",
          "channelScope",
          "created",
          "eventGroup",
          "eventType",
          "id",
          "lastTriggered",
          "name",
          "orgId",
          "relatedEntityId",
          "relatedEntityType",
          "templateId",
          "uid",
          "updatedAt"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "The total number of entity policies that satisfy the query.",
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| count | integer | true |  | The number of entity policies returned. |
| data | [EntityNotificationPolicyResponse] | true | maxItems: 1000 | The entity notification policies. |
| next | string,null | true |  | The URL pointing to the next page. |
| previous | string,null | true |  | The URL pointing to the previous page. |
| totalCount | integer | true |  | The total number of entity policies that satisfy the query. |

## EntityNotificationPoliciesTemplatesListResponse

```
{
  "properties": {
    "count": {
      "description": "The number of entity policy templates returned.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "The entity notification policy templates.",
      "items": {
        "properties": {
          "active": {
            "description": "Defines if the notification policy is active or not.",
            "type": "boolean",
            "x-versionadded": "v2.33"
          },
          "channel": {
            "description": "The notification channel information used to send the notification.",
            "properties": {
              "channelType": {
                "description": "The type of the new notification channel.",
                "enum": [
                  "DataRobotCustomJob",
                  "DataRobotGroup",
                  "DataRobotUser",
                  "Database",
                  "Email",
                  "InApp",
                  "InsightsComputations",
                  "MSTeams",
                  "Slack",
                  "Webhook"
                ],
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "contentType": {
                "description": "The content type of the messages of the new notification channel.",
                "enum": [
                  "application/json",
                  "application/x-www-form-urlencoded"
                ],
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "createdAt": {
                "description": "The date of the notification channel creation.",
                "format": "date-time",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "customHeaders": {
                "description": "Custom headers and their values to be sent in the new notification channel.",
                "items": {
                  "properties": {
                    "name": {
                      "description": "The name of the header.",
                      "type": "string"
                    },
                    "value": {
                      "description": "The value of the header.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "name",
                    "value"
                  ],
                  "type": "object"
                },
                "maxItems": 100,
                "type": "array",
                "x-versionadded": "v2.33"
              },
              "drEntities": {
                "description": "The ids of DataRobot Users or Group for DataRobotUser or DataRobotGroup channel types.",
                "items": {
                  "properties": {
                    "id": {
                      "description": "The id of DataRobot entity.",
                      "type": "string",
                      "x-versionadded": "v2.33"
                    },
                    "name": {
                      "description": "The name of the entity.",
                      "type": "string",
                      "x-versionadded": "v2.33"
                    }
                  },
                  "required": [
                    "id",
                    "name"
                  ],
                  "type": "object"
                },
                "maxItems": 100,
                "minItems": 1,
                "type": "array",
                "x-versionadded": "v2.33"
              },
              "emailAddress": {
                "description": "The email address to be used in the new notification channel.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "id": {
                "description": "The ID of the notification channel.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "languageCode": {
                "description": "The preferred language code.",
                "enum": [
                  "en",
                  "es_419",
                  "fr",
                  "ja",
                  "ko",
                  "ptBR"
                ],
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "name": {
                "description": "The name of the new notification channel.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "orgId": {
                "description": "The ID of the organization that the notification channel belongs to.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "payloadUrl": {
                "description": "The payload URL of the new notification channel.",
                "format": "uri",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "relatedEntityId": {
                "description": "The id of related entity.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "relatedEntityType": {
                "description": "Type of related entity.",
                "enum": [
                  "deployment",
                  "Deployment",
                  "DEPLOYMENT",
                  "customjob",
                  "Customjob",
                  "CUSTOMJOB"
                ],
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "secretToken": {
                "description": "Secret token to be used for new notification channel.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "uid": {
                "description": "The identifier of the user who created the channel.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "updatedAt": {
                "description": "The date when the channel was updated.",
                "format": "date-time",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "validateSsl": {
                "description": "Whether to validate SSL for the notification channel.",
                "type": [
                  "boolean",
                  "null"
                ],
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "channelType",
              "contentType",
              "createdAt",
              "customHeaders",
              "emailAddress",
              "id",
              "languageCode",
              "name",
              "orgId",
              "payloadUrl",
              "secretToken",
              "uid",
              "updatedAt",
              "validateSsl"
            ],
            "type": "object"
          },
          "channelId": {
            "description": "The ID of the notification channel to be used to send the notification.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "channelScope": {
            "description": "Scope of the channel.",
            "enum": [
              "organization",
              "Organization",
              "ORGANIZATION",
              "entity",
              "Entity",
              "ENTITY",
              "template",
              "Template",
              "TEMPLATE"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "created": {
            "description": "The date when the policy was created.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "createdBy": {
            "description": "User that created template.",
            "properties": {
              "firstName": {
                "description": "First Name.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "lastName": {
                "description": "Last Name.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "username": {
                "description": "Username.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "firstName",
              "lastName",
              "username"
            ],
            "type": "object"
          },
          "eventGroup": {
            "description": "The group of the event that triggers the notification.",
            "properties": {
              "events": {
                "description": "The events included in this group.",
                "items": {
                  "description": "The type of the event that triggers the notification.",
                  "properties": {
                    "id": {
                      "description": "The ID of the event type.",
                      "type": "string"
                    },
                    "label": {
                      "description": "The display name of the event type.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "label"
                  ],
                  "type": "object"
                },
                "maxItems": 1000,
                "type": "array"
              },
              "id": {
                "description": "The ID of the event group.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event group.",
                "type": "string"
              }
            },
            "required": [
              "events",
              "id",
              "label"
            ],
            "type": "object"
          },
          "eventType": {
            "description": "The type of the event that triggers the notification.",
            "properties": {
              "id": {
                "description": "The ID of the event type.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event type.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "label"
            ],
            "type": "object"
          },
          "id": {
            "description": "The ID of the policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "lastTriggered": {
            "description": "The date when the last notification with the policy was triggered.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "maximalFrequency": {
            "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the notification policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "orgId": {
            "description": "The ID of the organization that owns the notification policy.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "relatedEntityType": {
            "description": "The type of the related entity.",
            "enum": [
              "deployment",
              "Deployment",
              "DEPLOYMENT",
              "customjob",
              "Customjob",
              "CUSTOMJOB"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedPoliciesCount": {
            "description": "The total number of entity policies that are using this template.",
            "type": "integer",
            "x-versionadded": "v2.33"
          },
          "role": {
            "description": "User role on entity.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "uid": {
            "description": "The identifier of the user who created the policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "updatedAt": {
            "description": "The date when the policy was updated.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "active",
          "channel",
          "channelId",
          "created",
          "createdBy",
          "eventGroup",
          "eventType",
          "id",
          "lastTriggered",
          "name",
          "orgId",
          "relatedEntityType",
          "relatedPoliciesCount",
          "role",
          "uid",
          "updatedAt"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "The total number of entity policies templates that satisfy the query.",
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| count | integer | true |  | The number of entity policy templates returned. |
| data | [EntityNotificationPolicyTemplateResponse] | true | maxItems: 1000 | The entity notification policy templates. |
| next | string,null | true |  | The URL pointing to the next page. |
| previous | string,null | true |  | The URL pointing to the previous page. |
| totalCount | integer | true |  | The total number of entity policies templates that satisfy the query. |

## EntityNotificationPolicyCreate

```
{
  "properties": {
    "active": {
      "description": "Whether the notification policy is active or not.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "channelScope": {
      "description": "Scope of the channel.",
      "enum": [
        "organization",
        "Organization",
        "ORGANIZATION",
        "entity",
        "Entity",
        "ENTITY",
        "template",
        "Template",
        "TEMPLATE"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "enum": [
        "secure_config.all",
        "dataset.all",
        "file.all",
        "comment.all",
        "invite_job.all",
        "deployment_prediction_explanations_computation.all",
        "model_deployments.critical_health",
        "model_deployments.critical_frequent_health_change",
        "model_deployments.frequent_health_change",
        "model_deployments.health",
        "model_deployments.retraining_policy",
        "inference_endpoints.health",
        "model_deployments.management_agent",
        "model_deployments.management_agent_health",
        "prediction_request.all",
        "challenger_management.all",
        "challenger_replay.all",
        "model_deployments.all",
        "project.all",
        "perma_delete_project.all",
        "users_delete.all",
        "applications.all",
        "model_version.stage_transitions",
        "model_version.all",
        "use_case.all",
        "batch_predictions.all",
        "change_requests.all",
        "custom_job_run.all",
        "custom_job_run.unsuccessful",
        "insights_computation.all",
        "notebook_schedule.all",
        "monitoring.all"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "enum": [
        "secure_config.created",
        "secure_config.deleted",
        "secure_config.shared",
        "dataset.created",
        "dataset.registered",
        "dataset.deleted",
        "datasets.deleted",
        "datasetrelationship.created",
        "dataset.shared",
        "datasets.shared",
        "file.created",
        "file.registered",
        "file.deleted",
        "file.shared",
        "comment.created",
        "comment.updated",
        "invite_job.completed",
        "misc.asset_access_request",
        "misc.webhook_connection_test",
        "misc.webhook_resend",
        "misc.email_verification",
        "monitoring.spooler_channel_base",
        "monitoring.spooler_channel_red",
        "monitoring.spooler_channel_green",
        "monitoring.external_model_nan_predictions",
        "management.deploymentInfo",
        "model_deployments.None",
        "model_deployments.deployment_sharing",
        "model_deployments.model_replacement",
        "prediction_request.None",
        "prediction_request.failed",
        "model_deployments.humility_rule",
        "model_deployments.model_replacement_lifecycle",
        "model_deployments.model_replacement_started",
        "model_deployments.model_replacement_succeeded",
        "model_deployments.model_replacement_failed",
        "model_deployments.model_replacement_validation_warning",
        "model_deployments.deployment_creation",
        "model_deployments.deployment_deletion",
        "model_deployments.service_health_yellow_from_green",
        "model_deployments.service_health_yellow_from_red",
        "model_deployments.service_health_red",
        "model_deployments.data_drift_yellow_from_green",
        "model_deployments.data_drift_yellow_from_red",
        "model_deployments.data_drift_red",
        "model_deployments.accuracy_yellow_from_green",
        "model_deployments.accuracy_yellow_from_red",
        "model_deployments.accuracy_red",
        "model_deployments.health.fairness_health.green_to_yellow",
        "model_deployments.health.fairness_health.red_to_yellow",
        "model_deployments.health.fairness_health.red",
        "model_deployments.health.custom_metrics_health.green_to_yellow",
        "model_deployments.health.custom_metrics_health.red_to_yellow",
        "model_deployments.health.custom_metrics_health.red",
        "model_deployments.health.base.green",
        "model_deployments.service_health_green",
        "model_deployments.data_drift_green",
        "model_deployments.accuracy_green",
        "model_deployments.health.fairness_health.green",
        "model_deployments.health.custom_metrics_health.green",
        "model_deployments.retraining_policy_run_started",
        "model_deployments.retraining_policy_run_succeeded",
        "model_deployments.retraining_policy_run_failed",
        "model_deployments.challenger_scoring_success",
        "model_deployments.challenger_scoring_data_warning",
        "model_deployments.challenger_scoring_failure",
        "model_deployments.challenger_scoring_started",
        "model_deployments.challenger_model_validation_warning",
        "model_deployments.challenger_model_created",
        "model_deployments.challenger_model_deleted",
        "model_deployments.actuals_upload_failed",
        "model_deployments.actuals_upload_warning",
        "model_deployments.training_data_baseline_calculation_started",
        "model_deployments.training_data_baseline_calculation_completed",
        "model_deployments.training_data_baseline_failed",
        "model_deployments.custom_model_deployment_creation_started",
        "model_deployments.custom_model_deployment_creation_completed",
        "model_deployments.custom_model_deployment_creation_failed",
        "model_deployments.custom_model_deployment_secure_config_failure",
        "model_deployments.deployment_prediction_explanations_preview_job_submitted",
        "model_deployments.deployment_prediction_explanations_preview_job_completed",
        "model_deployments.deployment_prediction_explanations_preview_job_failed",
        "model_deployments.custom_model_deployment_activated",
        "model_deployments.custom_model_deployment_activation_failed",
        "model_deployments.custom_model_deployment_deactivated",
        "model_deployments.custom_model_deployment_deactivation_failed",
        "model_deployments.prediction_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_warning",
        "model_deployments.actuals_processing_rate_limit_reached",
        "model_deployments.actuals_processing_rate_limit_warning",
        "model_deployments.deployment_monitoring_data_cleared",
        "model_deployments.deployment_launch_started",
        "model_deployments.deployment_launch_succeeded",
        "model_deployments.deployment_launch_failed",
        "model_deployments.deployment_shutdown_started",
        "model_deployments.deployment_shutdown_succeeded",
        "model_deployments.deployment_shutdown_failed",
        "model_deployments.endpoint_update_started",
        "model_deployments.endpoint_update_succeeded",
        "model_deployments.endpoint_update_failed",
        "model_deployments.management_agent_service_health_green",
        "model_deployments.management_agent_service_health_yellow",
        "model_deployments.management_agent_service_health_red",
        "model_deployments.management_agent_service_health_unknown",
        "model_deployments.predictions_missing_association_id",
        "model_deployments.prediction_result_rows_cleand_up",
        "model_deployments.batch_deleted",
        "model_deployments.batch_creation_limit_reached",
        "model_deployments.batch_creation_limit_exceeded",
        "model_deployments.batch_not_found",
        "model_deployments.predictions_encountered_for_locked_batch",
        "model_deployments.predictions_encountered_for_deleted_batch",
        "model_deployments.scheduled_report_generated",
        "model_deployments.predictions_timeliness_health_red",
        "model_deployments.actuals_timeliness_health_red",
        "model_deployments.service_health_still_red",
        "model_deployments.data_drift_still_red",
        "model_deployments.accuracy_still_red",
        "model_deployments.health.fairness_health.still_red",
        "model_deployments.health.custom_metrics_health.still_red",
        "model_deployments.predictions_timeliness_health_still_red",
        "model_deployments.actuals_timeliness_health_still_red",
        "model_deployments.service_health_still_yellow",
        "model_deployments.data_drift_still_yellow",
        "model_deployments.accuracy_still_yellow",
        "model_deployments.health.fairness_health.still_yellow",
        "model_deployments.health.custom_metrics_health.still_yellow",
        "model_deployments.prediction_payload_parsing_failure",
        "model_deployments.deployment_inference_server_creation_started",
        "model_deployments.deployment_inference_server_creation_failed",
        "model_deployments.deployment_inference_server_creation_completed",
        "model_deployments.deployment_inference_server_deletion",
        "model_deployments.deployment_inference_server_idle_stopped",
        "model_deployments.deployment_inference_server_maintenance_started",
        "entity_notification_policy_template.shared",
        "notification_channel_template.shared",
        "project.created",
        "project.deleted",
        "project.shared",
        "autopilot.complete",
        "autopilot.started",
        "autostart.failure",
        "perma_delete_project.success",
        "perma_delete_project.failure",
        "users_delete.preview_started",
        "users_delete.preview_completed",
        "users_delete.preview_failed",
        "users_delete.started",
        "users_delete.completed",
        "users_delete.failed",
        "application.created",
        "application.shared",
        "model_version.added",
        "model_version.stage_transition_from_registered_to_development",
        "model_version.stage_transition_from_registered_to_staging",
        "model_version.stage_transition_from_registered_to_production",
        "model_version.stage_transition_from_registered_to_archived",
        "model_version.stage_transition_from_development_to_registered",
        "model_version.stage_transition_from_development_to_staging",
        "model_version.stage_transition_from_development_to_production",
        "model_version.stage_transition_from_development_to_archived",
        "model_version.stage_transition_from_staging_to_registered",
        "model_version.stage_transition_from_staging_to_development",
        "model_version.stage_transition_from_staging_to_production",
        "model_version.stage_transition_from_staging_to_archived",
        "model_version.stage_transition_from_production_to_registered",
        "model_version.stage_transition_from_production_to_development",
        "model_version.stage_transition_from_production_to_staging",
        "model_version.stage_transition_from_production_to_archived",
        "model_version.stage_transition_from_archived_to_registered",
        "model_version.stage_transition_from_archived_to_development",
        "model_version.stage_transition_from_archived_to_production",
        "model_version.stage_transition_from_archived_to_staging",
        "use_case.shared",
        "batch_predictions.success",
        "batch_predictions.failed",
        "batch_predictions.scheduler.auto_disabled",
        "change_request.cancelled",
        "change_request.created",
        "change_request.deployment_approval_requested",
        "change_request.resolved",
        "change_request.proposed_changes_updated",
        "change_request.pending",
        "change_request.commenting_review_added",
        "change_request.approving_review_added",
        "change_request.changes_requesting_review_added",
        "custom_job_run.success",
        "custom_job_run.failed",
        "custom_job_run.interrupted",
        "custom_job_run.cancelled",
        "prediction_explanations_computation.None",
        "prediction_explanations_computation.prediction_explanations_preview_job_submitted",
        "prediction_explanations_computation.prediction_explanations_preview_job_completed",
        "prediction_explanations_computation.prediction_explanations_preview_job_failed",
        "monitoring.rate_limit_enforced",
        "notebook_schedule.created",
        "notebook_schedule.failure",
        "notebook_schedule.completed",
        "abstract",
        "moderation.metric.creation_error",
        "moderation.metric.reporting_error",
        "moderation.model.moderation_started",
        "moderation.model.moderation_completed",
        "moderation.model.pre_score_phase_started",
        "moderation.model.pre_score_phase_completed",
        "moderation.model.post_score_phase_started",
        "moderation.model.post_score_phase_completed",
        "moderation.model.config_error",
        "moderation.model.runtime_error",
        "moderation.model.scoring_started",
        "moderation.model.scoring_completed",
        "moderation.model.scoring_error"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "maximalFrequency": {
      "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification policy.",
      "maxLength": 100,
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The ID of the organization that owns the notification policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityId": {
      "description": "The id of related entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "channelId",
    "channelScope",
    "name",
    "relatedEntityId",
    "relatedEntityType"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| active | boolean | false |  | Whether the notification policy is active or not. |
| channelId | string | true |  | The ID of the notification channel to be used to send the notification. |
| channelScope | string,null | true |  | Scope of the channel. |
| eventGroup | string | false |  | The group of the event that triggers the notification. |
| eventType | string | false |  | The type of the event that triggers the notification. |
| maximalFrequency | string,null | false |  | Maximal frequency between policy runs in ISO 8601 duration string. |
| name | string | true | maxLength: 100 | The name of the new notification policy. |
| orgId | string | false |  | The ID of the organization that owns the notification policy. |
| relatedEntityId | string | true |  | The id of related entity. |
| relatedEntityType | string | true |  | The type of the related entity. |

### Enumerated Values

| Property | Value |
| --- | --- |
| channelScope | [organization, Organization, ORGANIZATION, entity, Entity, ENTITY, template, Template, TEMPLATE] |
| eventGroup | [secure_config.all, dataset.all, file.all, comment.all, invite_job.all, deployment_prediction_explanations_computation.all, model_deployments.critical_health, model_deployments.critical_frequent_health_change, model_deployments.frequent_health_change, model_deployments.health, model_deployments.retraining_policy, inference_endpoints.health, model_deployments.management_agent, model_deployments.management_agent_health, prediction_request.all, challenger_management.all, challenger_replay.all, model_deployments.all, project.all, perma_delete_project.all, users_delete.all, applications.all, model_version.stage_transitions, model_version.all, use_case.all, batch_predictions.all, change_requests.all, custom_job_run.all, custom_job_run.unsuccessful, insights_computation.all, notebook_schedule.all, monitoring.all] |
| eventType | [secure_config.created, secure_config.deleted, secure_config.shared, dataset.created, dataset.registered, dataset.deleted, datasets.deleted, datasetrelationship.created, dataset.shared, datasets.shared, file.created, file.registered, file.deleted, file.shared, comment.created, comment.updated, invite_job.completed, misc.asset_access_request, misc.webhook_connection_test, misc.webhook_resend, misc.email_verification, monitoring.spooler_channel_base, monitoring.spooler_channel_red, monitoring.spooler_channel_green, monitoring.external_model_nan_predictions, management.deploymentInfo, model_deployments.None, model_deployments.deployment_sharing, model_deployments.model_replacement, prediction_request.None, prediction_request.failed, model_deployments.humility_rule, model_deployments.model_replacement_lifecycle, model_deployments.model_replacement_started, model_deployments.model_replacement_succeeded, model_deployments.model_replacement_failed, model_deployments.model_replacement_validation_warning, model_deployments.deployment_creation, model_deployments.deployment_deletion, model_deployments.service_health_yellow_from_green, model_deployments.service_health_yellow_from_red, model_deployments.service_health_red, model_deployments.data_drift_yellow_from_green, model_deployments.data_drift_yellow_from_red, model_deployments.data_drift_red, model_deployments.accuracy_yellow_from_green, model_deployments.accuracy_yellow_from_red, model_deployments.accuracy_red, model_deployments.health.fairness_health.green_to_yellow, model_deployments.health.fairness_health.red_to_yellow, model_deployments.health.fairness_health.red, model_deployments.health.custom_metrics_health.green_to_yellow, model_deployments.health.custom_metrics_health.red_to_yellow, model_deployments.health.custom_metrics_health.red, model_deployments.health.base.green, model_deployments.service_health_green, model_deployments.data_drift_green, model_deployments.accuracy_green, model_deployments.health.fairness_health.green, model_deployments.health.custom_metrics_health.green, model_deployments.retraining_policy_run_started, model_deployments.retraining_policy_run_succeeded, model_deployments.retraining_policy_run_failed, model_deployments.challenger_scoring_success, model_deployments.challenger_scoring_data_warning, model_deployments.challenger_scoring_failure, model_deployments.challenger_scoring_started, model_deployments.challenger_model_validation_warning, model_deployments.challenger_model_created, model_deployments.challenger_model_deleted, model_deployments.actuals_upload_failed, model_deployments.actuals_upload_warning, model_deployments.training_data_baseline_calculation_started, model_deployments.training_data_baseline_calculation_completed, model_deployments.training_data_baseline_failed, model_deployments.custom_model_deployment_creation_started, model_deployments.custom_model_deployment_creation_completed, model_deployments.custom_model_deployment_creation_failed, model_deployments.custom_model_deployment_secure_config_failure, model_deployments.deployment_prediction_explanations_preview_job_submitted, model_deployments.deployment_prediction_explanations_preview_job_completed, model_deployments.deployment_prediction_explanations_preview_job_failed, model_deployments.custom_model_deployment_activated, model_deployments.custom_model_deployment_activation_failed, model_deployments.custom_model_deployment_deactivated, model_deployments.custom_model_deployment_deactivation_failed, model_deployments.prediction_processing_rate_limit_reached, model_deployments.prediction_data_processing_rate_limit_reached, model_deployments.prediction_data_processing_rate_limit_warning, model_deployments.actuals_processing_rate_limit_reached, model_deployments.actuals_processing_rate_limit_warning, model_deployments.deployment_monitoring_data_cleared, model_deployments.deployment_launch_started, model_deployments.deployment_launch_succeeded, model_deployments.deployment_launch_failed, model_deployments.deployment_shutdown_started, model_deployments.deployment_shutdown_succeeded, model_deployments.deployment_shutdown_failed, model_deployments.endpoint_update_started, model_deployments.endpoint_update_succeeded, model_deployments.endpoint_update_failed, model_deployments.management_agent_service_health_green, model_deployments.management_agent_service_health_yellow, model_deployments.management_agent_service_health_red, model_deployments.management_agent_service_health_unknown, model_deployments.predictions_missing_association_id, model_deployments.prediction_result_rows_cleand_up, model_deployments.batch_deleted, model_deployments.batch_creation_limit_reached, model_deployments.batch_creation_limit_exceeded, model_deployments.batch_not_found, model_deployments.predictions_encountered_for_locked_batch, model_deployments.predictions_encountered_for_deleted_batch, model_deployments.scheduled_report_generated, model_deployments.predictions_timeliness_health_red, model_deployments.actuals_timeliness_health_red, model_deployments.service_health_still_red, model_deployments.data_drift_still_red, model_deployments.accuracy_still_red, model_deployments.health.fairness_health.still_red, model_deployments.health.custom_metrics_health.still_red, model_deployments.predictions_timeliness_health_still_red, model_deployments.actuals_timeliness_health_still_red, model_deployments.service_health_still_yellow, model_deployments.data_drift_still_yellow, model_deployments.accuracy_still_yellow, model_deployments.health.fairness_health.still_yellow, model_deployments.health.custom_metrics_health.still_yellow, model_deployments.prediction_payload_parsing_failure, model_deployments.deployment_inference_server_creation_started, model_deployments.deployment_inference_server_creation_failed, model_deployments.deployment_inference_server_creation_completed, model_deployments.deployment_inference_server_deletion, model_deployments.deployment_inference_server_idle_stopped, model_deployments.deployment_inference_server_maintenance_started, entity_notification_policy_template.shared, notification_channel_template.shared, project.created, project.deleted, project.shared, autopilot.complete, autopilot.started, autostart.failure, perma_delete_project.success, perma_delete_project.failure, users_delete.preview_started, users_delete.preview_completed, users_delete.preview_failed, users_delete.started, users_delete.completed, users_delete.failed, application.created, application.shared, model_version.added, model_version.stage_transition_from_registered_to_development, model_version.stage_transition_from_registered_to_staging, model_version.stage_transition_from_registered_to_production, model_version.stage_transition_from_registered_to_archived, model_version.stage_transition_from_development_to_registered, model_version.stage_transition_from_development_to_staging, model_version.stage_transition_from_development_to_production, model_version.stage_transition_from_development_to_archived, model_version.stage_transition_from_staging_to_registered, model_version.stage_transition_from_staging_to_development, model_version.stage_transition_from_staging_to_production, model_version.stage_transition_from_staging_to_archived, model_version.stage_transition_from_production_to_registered, model_version.stage_transition_from_production_to_development, model_version.stage_transition_from_production_to_staging, model_version.stage_transition_from_production_to_archived, model_version.stage_transition_from_archived_to_registered, model_version.stage_transition_from_archived_to_development, model_version.stage_transition_from_archived_to_production, model_version.stage_transition_from_archived_to_staging, use_case.shared, batch_predictions.success, batch_predictions.failed, batch_predictions.scheduler.auto_disabled, change_request.cancelled, change_request.created, change_request.deployment_approval_requested, change_request.resolved, change_request.proposed_changes_updated, change_request.pending, change_request.commenting_review_added, change_request.approving_review_added, change_request.changes_requesting_review_added, custom_job_run.success, custom_job_run.failed, custom_job_run.interrupted, custom_job_run.cancelled, prediction_explanations_computation.None, prediction_explanations_computation.prediction_explanations_preview_job_submitted, prediction_explanations_computation.prediction_explanations_preview_job_completed, prediction_explanations_computation.prediction_explanations_preview_job_failed, monitoring.rate_limit_enforced, notebook_schedule.created, notebook_schedule.failure, notebook_schedule.completed, abstract, moderation.metric.creation_error, moderation.metric.reporting_error, moderation.model.moderation_started, moderation.model.moderation_completed, moderation.model.pre_score_phase_started, moderation.model.pre_score_phase_completed, moderation.model.post_score_phase_started, moderation.model.post_score_phase_completed, moderation.model.config_error, moderation.model.runtime_error, moderation.model.scoring_started, moderation.model.scoring_completed, moderation.model.scoring_error] |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

## EntityNotificationPolicyCreateFromTemplate

```
{
  "properties": {
    "active": {
      "description": "Whether the notification policy is active or not.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification policy.",
      "maxLength": 100,
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityId": {
      "description": "The id of related entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "templateId": {
      "description": "The id of template.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "name",
    "relatedEntityId",
    "relatedEntityType",
    "templateId"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| active | boolean | false |  | Whether the notification policy is active or not. |
| name | string | true | maxLength: 100 | The name of the new notification policy. |
| relatedEntityId | string | true |  | The id of related entity. |
| relatedEntityType | string | true |  | The type of the related entity. |
| templateId | string | true |  | The id of template. |

### Enumerated Values

| Property | Value |
| --- | --- |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

## EntityNotificationPolicyResponse

```
{
  "properties": {
    "active": {
      "description": "Defines if the notification policy is active or not.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "channel": {
      "description": "The notification channel information used to send the notification.",
      "properties": {
        "channelType": {
          "description": "The type of the new notification channel.",
          "enum": [
            "DataRobotCustomJob",
            "DataRobotGroup",
            "DataRobotUser",
            "Database",
            "Email",
            "InApp",
            "InsightsComputations",
            "MSTeams",
            "Slack",
            "Webhook"
          ],
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "contentType": {
          "description": "The content type of the messages of the new notification channel.",
          "enum": [
            "application/json",
            "application/x-www-form-urlencoded"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "createdAt": {
          "description": "The date of the notification channel creation.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "customHeaders": {
          "description": "Custom headers and their values to be sent in the new notification channel.",
          "items": {
            "properties": {
              "name": {
                "description": "The name of the header.",
                "type": "string"
              },
              "value": {
                "description": "The value of the header.",
                "type": "string"
              }
            },
            "required": [
              "name",
              "value"
            ],
            "type": "object"
          },
          "maxItems": 100,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "drEntities": {
          "description": "The ids of DataRobot Users or Group for DataRobotUser or DataRobotGroup channel types.",
          "items": {
            "properties": {
              "id": {
                "description": "The id of DataRobot entity.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "name": {
                "description": "The name of the entity.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "id",
              "name"
            ],
            "type": "object"
          },
          "maxItems": 100,
          "minItems": 1,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "emailAddress": {
          "description": "The email address to be used in the new notification channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "id": {
          "description": "The ID of the notification channel.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "languageCode": {
          "description": "The preferred language code.",
          "enum": [
            "en",
            "es_419",
            "fr",
            "ja",
            "ko",
            "ptBR"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "name": {
          "description": "The name of the new notification channel.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "orgId": {
          "description": "The ID of the organization that the notification channel belongs to.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "payloadUrl": {
          "description": "The payload URL of the new notification channel.",
          "format": "uri",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "relatedEntityId": {
          "description": "The id of related entity.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "relatedEntityType": {
          "description": "Type of related entity.",
          "enum": [
            "deployment",
            "Deployment",
            "DEPLOYMENT",
            "customjob",
            "Customjob",
            "CUSTOMJOB"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "secretToken": {
          "description": "Secret token to be used for new notification channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "uid": {
          "description": "The identifier of the user who created the channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "updatedAt": {
          "description": "The date when the channel was updated.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "validateSsl": {
          "description": "Whether to validate SSL for the notification channel.",
          "type": [
            "boolean",
            "null"
          ],
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "channelType",
        "contentType",
        "createdAt",
        "customHeaders",
        "emailAddress",
        "id",
        "languageCode",
        "name",
        "orgId",
        "payloadUrl",
        "secretToken",
        "uid",
        "updatedAt",
        "validateSsl"
      ],
      "type": "object"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "channelScope": {
      "description": "Scope of the channel.",
      "enum": [
        "organization",
        "Organization",
        "ORGANIZATION",
        "entity",
        "Entity",
        "ENTITY",
        "template",
        "Template",
        "TEMPLATE"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "created": {
      "description": "The date when the policy was created.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "properties": {
        "events": {
          "description": "The events included in this group.",
          "items": {
            "description": "The type of the event that triggers the notification.",
            "properties": {
              "id": {
                "description": "The ID of the event type.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event type.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "label"
            ],
            "type": "object"
          },
          "maxItems": 1000,
          "type": "array"
        },
        "id": {
          "description": "The ID of the event group.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event group.",
          "type": "string"
        }
      },
      "required": [
        "events",
        "id",
        "label"
      ],
      "type": "object"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "properties": {
        "id": {
          "description": "The ID of the event type.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event type.",
          "type": "string"
        }
      },
      "required": [
        "id",
        "label"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "lastTriggered": {
      "description": "The date when the last notification with the policy was triggered.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "maximalFrequency": {
      "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the notification policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The ID of the organization that owns the notification policy.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "relatedEntityId": {
      "description": "The id of related entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "templateId": {
      "description": "The id of template.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "uid": {
      "description": "The identifier of the user who created the policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "updatedAt": {
      "description": "The date when the policy was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "active",
    "channel",
    "channelId",
    "channelScope",
    "created",
    "eventGroup",
    "eventType",
    "id",
    "lastTriggered",
    "name",
    "orgId",
    "relatedEntityId",
    "relatedEntityType",
    "templateId",
    "uid",
    "updatedAt"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| active | boolean | true |  | Defines if the notification policy is active or not. |
| channel | EntityNotificationChannel | true |  | The notification channel information used to send the notification. |
| channelId | string | true |  | The ID of the notification channel to be used to send the notification. |
| channelScope | string,null | true |  | Scope of the channel. |
| created | string,null(date-time) | true |  | The date when the policy was created. |
| eventGroup | EventGroup | true |  | The group of the event that triggers the notification. |
| eventType | EventType | true |  | The type of the event that triggers the notification. |
| id | string | true |  | The ID of the policy. |
| lastTriggered | string,null(date-time) | true |  | The date when the last notification with the policy was triggered. |
| maximalFrequency | string,null | false |  | Maximal frequency between policy runs in ISO 8601 duration string. |
| name | string | true |  | The name of the notification policy. |
| orgId | string,null | true |  | The ID of the organization that owns the notification policy. |
| relatedEntityId | string | true |  | The id of related entity. |
| relatedEntityType | string | true |  | The type of the related entity. |
| templateId | string,null | true |  | The id of template. |
| uid | string | true |  | The identifier of the user who created the policy. |
| updatedAt | string,null(date-time) | true |  | The date when the policy was updated. |

### Enumerated Values

| Property | Value |
| --- | --- |
| channelScope | [organization, Organization, ORGANIZATION, entity, Entity, ENTITY, template, Template, TEMPLATE] |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

## EntityNotificationPolicyTemplateCreate

```
{
  "properties": {
    "active": {
      "description": "Whether the notification policy is active or not.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "enum": [
        "secure_config.all",
        "dataset.all",
        "file.all",
        "comment.all",
        "invite_job.all",
        "deployment_prediction_explanations_computation.all",
        "model_deployments.critical_health",
        "model_deployments.critical_frequent_health_change",
        "model_deployments.frequent_health_change",
        "model_deployments.health",
        "model_deployments.retraining_policy",
        "inference_endpoints.health",
        "model_deployments.management_agent",
        "model_deployments.management_agent_health",
        "prediction_request.all",
        "challenger_management.all",
        "challenger_replay.all",
        "model_deployments.all",
        "project.all",
        "perma_delete_project.all",
        "users_delete.all",
        "applications.all",
        "model_version.stage_transitions",
        "model_version.all",
        "use_case.all",
        "batch_predictions.all",
        "change_requests.all",
        "custom_job_run.all",
        "custom_job_run.unsuccessful",
        "insights_computation.all",
        "notebook_schedule.all",
        "monitoring.all"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "enum": [
        "secure_config.created",
        "secure_config.deleted",
        "secure_config.shared",
        "dataset.created",
        "dataset.registered",
        "dataset.deleted",
        "datasets.deleted",
        "datasetrelationship.created",
        "dataset.shared",
        "datasets.shared",
        "file.created",
        "file.registered",
        "file.deleted",
        "file.shared",
        "comment.created",
        "comment.updated",
        "invite_job.completed",
        "misc.asset_access_request",
        "misc.webhook_connection_test",
        "misc.webhook_resend",
        "misc.email_verification",
        "monitoring.spooler_channel_base",
        "monitoring.spooler_channel_red",
        "monitoring.spooler_channel_green",
        "monitoring.external_model_nan_predictions",
        "management.deploymentInfo",
        "model_deployments.None",
        "model_deployments.deployment_sharing",
        "model_deployments.model_replacement",
        "prediction_request.None",
        "prediction_request.failed",
        "model_deployments.humility_rule",
        "model_deployments.model_replacement_lifecycle",
        "model_deployments.model_replacement_started",
        "model_deployments.model_replacement_succeeded",
        "model_deployments.model_replacement_failed",
        "model_deployments.model_replacement_validation_warning",
        "model_deployments.deployment_creation",
        "model_deployments.deployment_deletion",
        "model_deployments.service_health_yellow_from_green",
        "model_deployments.service_health_yellow_from_red",
        "model_deployments.service_health_red",
        "model_deployments.data_drift_yellow_from_green",
        "model_deployments.data_drift_yellow_from_red",
        "model_deployments.data_drift_red",
        "model_deployments.accuracy_yellow_from_green",
        "model_deployments.accuracy_yellow_from_red",
        "model_deployments.accuracy_red",
        "model_deployments.health.fairness_health.green_to_yellow",
        "model_deployments.health.fairness_health.red_to_yellow",
        "model_deployments.health.fairness_health.red",
        "model_deployments.health.custom_metrics_health.green_to_yellow",
        "model_deployments.health.custom_metrics_health.red_to_yellow",
        "model_deployments.health.custom_metrics_health.red",
        "model_deployments.health.base.green",
        "model_deployments.service_health_green",
        "model_deployments.data_drift_green",
        "model_deployments.accuracy_green",
        "model_deployments.health.fairness_health.green",
        "model_deployments.health.custom_metrics_health.green",
        "model_deployments.retraining_policy_run_started",
        "model_deployments.retraining_policy_run_succeeded",
        "model_deployments.retraining_policy_run_failed",
        "model_deployments.challenger_scoring_success",
        "model_deployments.challenger_scoring_data_warning",
        "model_deployments.challenger_scoring_failure",
        "model_deployments.challenger_scoring_started",
        "model_deployments.challenger_model_validation_warning",
        "model_deployments.challenger_model_created",
        "model_deployments.challenger_model_deleted",
        "model_deployments.actuals_upload_failed",
        "model_deployments.actuals_upload_warning",
        "model_deployments.training_data_baseline_calculation_started",
        "model_deployments.training_data_baseline_calculation_completed",
        "model_deployments.training_data_baseline_failed",
        "model_deployments.custom_model_deployment_creation_started",
        "model_deployments.custom_model_deployment_creation_completed",
        "model_deployments.custom_model_deployment_creation_failed",
        "model_deployments.custom_model_deployment_secure_config_failure",
        "model_deployments.deployment_prediction_explanations_preview_job_submitted",
        "model_deployments.deployment_prediction_explanations_preview_job_completed",
        "model_deployments.deployment_prediction_explanations_preview_job_failed",
        "model_deployments.custom_model_deployment_activated",
        "model_deployments.custom_model_deployment_activation_failed",
        "model_deployments.custom_model_deployment_deactivated",
        "model_deployments.custom_model_deployment_deactivation_failed",
        "model_deployments.prediction_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_warning",
        "model_deployments.actuals_processing_rate_limit_reached",
        "model_deployments.actuals_processing_rate_limit_warning",
        "model_deployments.deployment_monitoring_data_cleared",
        "model_deployments.deployment_launch_started",
        "model_deployments.deployment_launch_succeeded",
        "model_deployments.deployment_launch_failed",
        "model_deployments.deployment_shutdown_started",
        "model_deployments.deployment_shutdown_succeeded",
        "model_deployments.deployment_shutdown_failed",
        "model_deployments.endpoint_update_started",
        "model_deployments.endpoint_update_succeeded",
        "model_deployments.endpoint_update_failed",
        "model_deployments.management_agent_service_health_green",
        "model_deployments.management_agent_service_health_yellow",
        "model_deployments.management_agent_service_health_red",
        "model_deployments.management_agent_service_health_unknown",
        "model_deployments.predictions_missing_association_id",
        "model_deployments.prediction_result_rows_cleand_up",
        "model_deployments.batch_deleted",
        "model_deployments.batch_creation_limit_reached",
        "model_deployments.batch_creation_limit_exceeded",
        "model_deployments.batch_not_found",
        "model_deployments.predictions_encountered_for_locked_batch",
        "model_deployments.predictions_encountered_for_deleted_batch",
        "model_deployments.scheduled_report_generated",
        "model_deployments.predictions_timeliness_health_red",
        "model_deployments.actuals_timeliness_health_red",
        "model_deployments.service_health_still_red",
        "model_deployments.data_drift_still_red",
        "model_deployments.accuracy_still_red",
        "model_deployments.health.fairness_health.still_red",
        "model_deployments.health.custom_metrics_health.still_red",
        "model_deployments.predictions_timeliness_health_still_red",
        "model_deployments.actuals_timeliness_health_still_red",
        "model_deployments.service_health_still_yellow",
        "model_deployments.data_drift_still_yellow",
        "model_deployments.accuracy_still_yellow",
        "model_deployments.health.fairness_health.still_yellow",
        "model_deployments.health.custom_metrics_health.still_yellow",
        "model_deployments.prediction_payload_parsing_failure",
        "model_deployments.deployment_inference_server_creation_started",
        "model_deployments.deployment_inference_server_creation_failed",
        "model_deployments.deployment_inference_server_creation_completed",
        "model_deployments.deployment_inference_server_deletion",
        "model_deployments.deployment_inference_server_idle_stopped",
        "model_deployments.deployment_inference_server_maintenance_started",
        "entity_notification_policy_template.shared",
        "notification_channel_template.shared",
        "project.created",
        "project.deleted",
        "project.shared",
        "autopilot.complete",
        "autopilot.started",
        "autostart.failure",
        "perma_delete_project.success",
        "perma_delete_project.failure",
        "users_delete.preview_started",
        "users_delete.preview_completed",
        "users_delete.preview_failed",
        "users_delete.started",
        "users_delete.completed",
        "users_delete.failed",
        "application.created",
        "application.shared",
        "model_version.added",
        "model_version.stage_transition_from_registered_to_development",
        "model_version.stage_transition_from_registered_to_staging",
        "model_version.stage_transition_from_registered_to_production",
        "model_version.stage_transition_from_registered_to_archived",
        "model_version.stage_transition_from_development_to_registered",
        "model_version.stage_transition_from_development_to_staging",
        "model_version.stage_transition_from_development_to_production",
        "model_version.stage_transition_from_development_to_archived",
        "model_version.stage_transition_from_staging_to_registered",
        "model_version.stage_transition_from_staging_to_development",
        "model_version.stage_transition_from_staging_to_production",
        "model_version.stage_transition_from_staging_to_archived",
        "model_version.stage_transition_from_production_to_registered",
        "model_version.stage_transition_from_production_to_development",
        "model_version.stage_transition_from_production_to_staging",
        "model_version.stage_transition_from_production_to_archived",
        "model_version.stage_transition_from_archived_to_registered",
        "model_version.stage_transition_from_archived_to_development",
        "model_version.stage_transition_from_archived_to_production",
        "model_version.stage_transition_from_archived_to_staging",
        "use_case.shared",
        "batch_predictions.success",
        "batch_predictions.failed",
        "batch_predictions.scheduler.auto_disabled",
        "change_request.cancelled",
        "change_request.created",
        "change_request.deployment_approval_requested",
        "change_request.resolved",
        "change_request.proposed_changes_updated",
        "change_request.pending",
        "change_request.commenting_review_added",
        "change_request.approving_review_added",
        "change_request.changes_requesting_review_added",
        "custom_job_run.success",
        "custom_job_run.failed",
        "custom_job_run.interrupted",
        "custom_job_run.cancelled",
        "prediction_explanations_computation.None",
        "prediction_explanations_computation.prediction_explanations_preview_job_submitted",
        "prediction_explanations_computation.prediction_explanations_preview_job_completed",
        "prediction_explanations_computation.prediction_explanations_preview_job_failed",
        "monitoring.rate_limit_enforced",
        "notebook_schedule.created",
        "notebook_schedule.failure",
        "notebook_schedule.completed",
        "abstract",
        "moderation.metric.creation_error",
        "moderation.metric.reporting_error",
        "moderation.model.moderation_started",
        "moderation.model.moderation_completed",
        "moderation.model.pre_score_phase_started",
        "moderation.model.pre_score_phase_completed",
        "moderation.model.post_score_phase_started",
        "moderation.model.post_score_phase_completed",
        "moderation.model.config_error",
        "moderation.model.runtime_error",
        "moderation.model.scoring_started",
        "moderation.model.scoring_completed",
        "moderation.model.scoring_error"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "maximalFrequency": {
      "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification policy.",
      "maxLength": 100,
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The ID of the organization that owns the notification policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "channelId",
    "name",
    "relatedEntityType"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| active | boolean | false |  | Whether the notification policy is active or not. |
| channelId | string | true |  | The ID of the notification channel to be used to send the notification. |
| eventGroup | string | false |  | The group of the event that triggers the notification. |
| eventType | string | false |  | The type of the event that triggers the notification. |
| maximalFrequency | string,null | false |  | Maximal frequency between policy runs in ISO 8601 duration string. |
| name | string | true | maxLength: 100 | The name of the new notification policy. |
| orgId | string | false |  | The ID of the organization that owns the notification policy. |
| relatedEntityType | string | true |  | The type of the related entity. |

### Enumerated Values

| Property | Value |
| --- | --- |
| eventGroup | [secure_config.all, dataset.all, file.all, comment.all, invite_job.all, deployment_prediction_explanations_computation.all, model_deployments.critical_health, model_deployments.critical_frequent_health_change, model_deployments.frequent_health_change, model_deployments.health, model_deployments.retraining_policy, inference_endpoints.health, model_deployments.management_agent, model_deployments.management_agent_health, prediction_request.all, challenger_management.all, challenger_replay.all, model_deployments.all, project.all, perma_delete_project.all, users_delete.all, applications.all, model_version.stage_transitions, model_version.all, use_case.all, batch_predictions.all, change_requests.all, custom_job_run.all, custom_job_run.unsuccessful, insights_computation.all, notebook_schedule.all, monitoring.all] |
| eventType | [secure_config.created, secure_config.deleted, secure_config.shared, dataset.created, dataset.registered, dataset.deleted, datasets.deleted, datasetrelationship.created, dataset.shared, datasets.shared, file.created, file.registered, file.deleted, file.shared, comment.created, comment.updated, invite_job.completed, misc.asset_access_request, misc.webhook_connection_test, misc.webhook_resend, misc.email_verification, monitoring.spooler_channel_base, monitoring.spooler_channel_red, monitoring.spooler_channel_green, monitoring.external_model_nan_predictions, management.deploymentInfo, model_deployments.None, model_deployments.deployment_sharing, model_deployments.model_replacement, prediction_request.None, prediction_request.failed, model_deployments.humility_rule, model_deployments.model_replacement_lifecycle, model_deployments.model_replacement_started, model_deployments.model_replacement_succeeded, model_deployments.model_replacement_failed, model_deployments.model_replacement_validation_warning, model_deployments.deployment_creation, model_deployments.deployment_deletion, model_deployments.service_health_yellow_from_green, model_deployments.service_health_yellow_from_red, model_deployments.service_health_red, model_deployments.data_drift_yellow_from_green, model_deployments.data_drift_yellow_from_red, model_deployments.data_drift_red, model_deployments.accuracy_yellow_from_green, model_deployments.accuracy_yellow_from_red, model_deployments.accuracy_red, model_deployments.health.fairness_health.green_to_yellow, model_deployments.health.fairness_health.red_to_yellow, model_deployments.health.fairness_health.red, model_deployments.health.custom_metrics_health.green_to_yellow, model_deployments.health.custom_metrics_health.red_to_yellow, model_deployments.health.custom_metrics_health.red, model_deployments.health.base.green, model_deployments.service_health_green, model_deployments.data_drift_green, model_deployments.accuracy_green, model_deployments.health.fairness_health.green, model_deployments.health.custom_metrics_health.green, model_deployments.retraining_policy_run_started, model_deployments.retraining_policy_run_succeeded, model_deployments.retraining_policy_run_failed, model_deployments.challenger_scoring_success, model_deployments.challenger_scoring_data_warning, model_deployments.challenger_scoring_failure, model_deployments.challenger_scoring_started, model_deployments.challenger_model_validation_warning, model_deployments.challenger_model_created, model_deployments.challenger_model_deleted, model_deployments.actuals_upload_failed, model_deployments.actuals_upload_warning, model_deployments.training_data_baseline_calculation_started, model_deployments.training_data_baseline_calculation_completed, model_deployments.training_data_baseline_failed, model_deployments.custom_model_deployment_creation_started, model_deployments.custom_model_deployment_creation_completed, model_deployments.custom_model_deployment_creation_failed, model_deployments.custom_model_deployment_secure_config_failure, model_deployments.deployment_prediction_explanations_preview_job_submitted, model_deployments.deployment_prediction_explanations_preview_job_completed, model_deployments.deployment_prediction_explanations_preview_job_failed, model_deployments.custom_model_deployment_activated, model_deployments.custom_model_deployment_activation_failed, model_deployments.custom_model_deployment_deactivated, model_deployments.custom_model_deployment_deactivation_failed, model_deployments.prediction_processing_rate_limit_reached, model_deployments.prediction_data_processing_rate_limit_reached, model_deployments.prediction_data_processing_rate_limit_warning, model_deployments.actuals_processing_rate_limit_reached, model_deployments.actuals_processing_rate_limit_warning, model_deployments.deployment_monitoring_data_cleared, model_deployments.deployment_launch_started, model_deployments.deployment_launch_succeeded, model_deployments.deployment_launch_failed, model_deployments.deployment_shutdown_started, model_deployments.deployment_shutdown_succeeded, model_deployments.deployment_shutdown_failed, model_deployments.endpoint_update_started, model_deployments.endpoint_update_succeeded, model_deployments.endpoint_update_failed, model_deployments.management_agent_service_health_green, model_deployments.management_agent_service_health_yellow, model_deployments.management_agent_service_health_red, model_deployments.management_agent_service_health_unknown, model_deployments.predictions_missing_association_id, model_deployments.prediction_result_rows_cleand_up, model_deployments.batch_deleted, model_deployments.batch_creation_limit_reached, model_deployments.batch_creation_limit_exceeded, model_deployments.batch_not_found, model_deployments.predictions_encountered_for_locked_batch, model_deployments.predictions_encountered_for_deleted_batch, model_deployments.scheduled_report_generated, model_deployments.predictions_timeliness_health_red, model_deployments.actuals_timeliness_health_red, model_deployments.service_health_still_red, model_deployments.data_drift_still_red, model_deployments.accuracy_still_red, model_deployments.health.fairness_health.still_red, model_deployments.health.custom_metrics_health.still_red, model_deployments.predictions_timeliness_health_still_red, model_deployments.actuals_timeliness_health_still_red, model_deployments.service_health_still_yellow, model_deployments.data_drift_still_yellow, model_deployments.accuracy_still_yellow, model_deployments.health.fairness_health.still_yellow, model_deployments.health.custom_metrics_health.still_yellow, model_deployments.prediction_payload_parsing_failure, model_deployments.deployment_inference_server_creation_started, model_deployments.deployment_inference_server_creation_failed, model_deployments.deployment_inference_server_creation_completed, model_deployments.deployment_inference_server_deletion, model_deployments.deployment_inference_server_idle_stopped, model_deployments.deployment_inference_server_maintenance_started, entity_notification_policy_template.shared, notification_channel_template.shared, project.created, project.deleted, project.shared, autopilot.complete, autopilot.started, autostart.failure, perma_delete_project.success, perma_delete_project.failure, users_delete.preview_started, users_delete.preview_completed, users_delete.preview_failed, users_delete.started, users_delete.completed, users_delete.failed, application.created, application.shared, model_version.added, model_version.stage_transition_from_registered_to_development, model_version.stage_transition_from_registered_to_staging, model_version.stage_transition_from_registered_to_production, model_version.stage_transition_from_registered_to_archived, model_version.stage_transition_from_development_to_registered, model_version.stage_transition_from_development_to_staging, model_version.stage_transition_from_development_to_production, model_version.stage_transition_from_development_to_archived, model_version.stage_transition_from_staging_to_registered, model_version.stage_transition_from_staging_to_development, model_version.stage_transition_from_staging_to_production, model_version.stage_transition_from_staging_to_archived, model_version.stage_transition_from_production_to_registered, model_version.stage_transition_from_production_to_development, model_version.stage_transition_from_production_to_staging, model_version.stage_transition_from_production_to_archived, model_version.stage_transition_from_archived_to_registered, model_version.stage_transition_from_archived_to_development, model_version.stage_transition_from_archived_to_production, model_version.stage_transition_from_archived_to_staging, use_case.shared, batch_predictions.success, batch_predictions.failed, batch_predictions.scheduler.auto_disabled, change_request.cancelled, change_request.created, change_request.deployment_approval_requested, change_request.resolved, change_request.proposed_changes_updated, change_request.pending, change_request.commenting_review_added, change_request.approving_review_added, change_request.changes_requesting_review_added, custom_job_run.success, custom_job_run.failed, custom_job_run.interrupted, custom_job_run.cancelled, prediction_explanations_computation.None, prediction_explanations_computation.prediction_explanations_preview_job_submitted, prediction_explanations_computation.prediction_explanations_preview_job_completed, prediction_explanations_computation.prediction_explanations_preview_job_failed, monitoring.rate_limit_enforced, notebook_schedule.created, notebook_schedule.failure, notebook_schedule.completed, abstract, moderation.metric.creation_error, moderation.metric.reporting_error, moderation.model.moderation_started, moderation.model.moderation_completed, moderation.model.pre_score_phase_started, moderation.model.pre_score_phase_completed, moderation.model.post_score_phase_started, moderation.model.post_score_phase_completed, moderation.model.config_error, moderation.model.runtime_error, moderation.model.scoring_started, moderation.model.scoring_completed, moderation.model.scoring_error] |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

## EntityNotificationPolicyTemplateRelatedPoliciesListResponse

```
{
  "properties": {
    "count": {
      "description": "The number of entity policies returned.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "The entity notification policies.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the notification policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedEntityId": {
            "description": "The id of related entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedEntityName": {
            "description": "The name of related entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedEntityType": {
            "description": "The type of the related entity.",
            "enum": [
              "deployment",
              "Deployment",
              "DEPLOYMENT",
              "customjob",
              "Customjob",
              "CUSTOMJOB"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name",
          "relatedEntityId",
          "relatedEntityName",
          "relatedEntityType"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "The total number of entity policies that satisfy the query.",
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| count | integer | true |  | The number of entity policies returned. |
| data | [EntityNotificationPolicyTemplateRelatedPolicyResponse] | true | maxItems: 1000 | The entity notification policies. |
| next | string,null | true |  | The URL pointing to the next page. |
| previous | string,null | true |  | The URL pointing to the previous page. |
| totalCount | integer | true |  | The total number of entity policies that satisfy the query. |

## EntityNotificationPolicyTemplateRelatedPolicyResponse

```
{
  "properties": {
    "id": {
      "description": "The ID of the policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the notification policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityId": {
      "description": "The id of related entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityName": {
      "description": "The name of related entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "id",
    "name",
    "relatedEntityId",
    "relatedEntityName",
    "relatedEntityType"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| id | string | true |  | The ID of the policy. |
| name | string | true |  | The name of the notification policy. |
| relatedEntityId | string | true |  | The id of related entity. |
| relatedEntityName | string | true |  | The name of related entity. |
| relatedEntityType | string | true |  | The type of the related entity. |

### Enumerated Values

| Property | Value |
| --- | --- |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

## EntityNotificationPolicyTemplateResponse

```
{
  "properties": {
    "active": {
      "description": "Defines if the notification policy is active or not.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "channel": {
      "description": "The notification channel information used to send the notification.",
      "properties": {
        "channelType": {
          "description": "The type of the new notification channel.",
          "enum": [
            "DataRobotCustomJob",
            "DataRobotGroup",
            "DataRobotUser",
            "Database",
            "Email",
            "InApp",
            "InsightsComputations",
            "MSTeams",
            "Slack",
            "Webhook"
          ],
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "contentType": {
          "description": "The content type of the messages of the new notification channel.",
          "enum": [
            "application/json",
            "application/x-www-form-urlencoded"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "createdAt": {
          "description": "The date of the notification channel creation.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "customHeaders": {
          "description": "Custom headers and their values to be sent in the new notification channel.",
          "items": {
            "properties": {
              "name": {
                "description": "The name of the header.",
                "type": "string"
              },
              "value": {
                "description": "The value of the header.",
                "type": "string"
              }
            },
            "required": [
              "name",
              "value"
            ],
            "type": "object"
          },
          "maxItems": 100,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "drEntities": {
          "description": "The ids of DataRobot Users or Group for DataRobotUser or DataRobotGroup channel types.",
          "items": {
            "properties": {
              "id": {
                "description": "The id of DataRobot entity.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "name": {
                "description": "The name of the entity.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "id",
              "name"
            ],
            "type": "object"
          },
          "maxItems": 100,
          "minItems": 1,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "emailAddress": {
          "description": "The email address to be used in the new notification channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "id": {
          "description": "The ID of the notification channel.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "languageCode": {
          "description": "The preferred language code.",
          "enum": [
            "en",
            "es_419",
            "fr",
            "ja",
            "ko",
            "ptBR"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "name": {
          "description": "The name of the new notification channel.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "orgId": {
          "description": "The ID of the organization that the notification channel belongs to.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "payloadUrl": {
          "description": "The payload URL of the new notification channel.",
          "format": "uri",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "relatedEntityId": {
          "description": "The id of related entity.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "relatedEntityType": {
          "description": "Type of related entity.",
          "enum": [
            "deployment",
            "Deployment",
            "DEPLOYMENT",
            "customjob",
            "Customjob",
            "CUSTOMJOB"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "secretToken": {
          "description": "Secret token to be used for new notification channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "uid": {
          "description": "The identifier of the user who created the channel.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "updatedAt": {
          "description": "The date when the channel was updated.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "validateSsl": {
          "description": "Whether to validate SSL for the notification channel.",
          "type": [
            "boolean",
            "null"
          ],
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "channelType",
        "contentType",
        "createdAt",
        "customHeaders",
        "emailAddress",
        "id",
        "languageCode",
        "name",
        "orgId",
        "payloadUrl",
        "secretToken",
        "uid",
        "updatedAt",
        "validateSsl"
      ],
      "type": "object"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "channelScope": {
      "description": "Scope of the channel.",
      "enum": [
        "organization",
        "Organization",
        "ORGANIZATION",
        "entity",
        "Entity",
        "ENTITY",
        "template",
        "Template",
        "TEMPLATE"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "created": {
      "description": "The date when the policy was created.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "User that created template.",
      "properties": {
        "firstName": {
          "description": "First Name.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "lastName": {
          "description": "Last Name.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "username": {
          "description": "Username.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "firstName",
        "lastName",
        "username"
      ],
      "type": "object"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "properties": {
        "events": {
          "description": "The events included in this group.",
          "items": {
            "description": "The type of the event that triggers the notification.",
            "properties": {
              "id": {
                "description": "The ID of the event type.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event type.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "label"
            ],
            "type": "object"
          },
          "maxItems": 1000,
          "type": "array"
        },
        "id": {
          "description": "The ID of the event group.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event group.",
          "type": "string"
        }
      },
      "required": [
        "events",
        "id",
        "label"
      ],
      "type": "object"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "properties": {
        "id": {
          "description": "The ID of the event type.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event type.",
          "type": "string"
        }
      },
      "required": [
        "id",
        "label"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "lastTriggered": {
      "description": "The date when the last notification with the policy was triggered.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "maximalFrequency": {
      "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the notification policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The ID of the organization that owns the notification policy.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedPoliciesCount": {
      "description": "The total number of entity policies that are using this template.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "role": {
      "description": "User role on entity.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "uid": {
      "description": "The identifier of the user who created the policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "updatedAt": {
      "description": "The date when the policy was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "active",
    "channel",
    "channelId",
    "created",
    "createdBy",
    "eventGroup",
    "eventType",
    "id",
    "lastTriggered",
    "name",
    "orgId",
    "relatedEntityType",
    "relatedPoliciesCount",
    "role",
    "uid",
    "updatedAt"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| active | boolean | true |  | Defines if the notification policy is active or not. |
| channel | EntityNotificationChannel | true |  | The notification channel information used to send the notification. |
| channelId | string | true |  | The ID of the notification channel to be used to send the notification. |
| channelScope | string | false |  | Scope of the channel. |
| created | string,null(date-time) | true |  | The date when the policy was created. |
| createdBy | CreatedByResponse | true |  | User that created template. |
| eventGroup | EventGroup | true |  | The group of the event that triggers the notification. |
| eventType | EventType | true |  | The type of the event that triggers the notification. |
| id | string | true |  | The ID of the policy. |
| lastTriggered | string,null(date-time) | true |  | The date when the last notification with the policy was triggered. |
| maximalFrequency | string,null | false |  | Maximal frequency between policy runs in ISO 8601 duration string. |
| name | string | true |  | The name of the notification policy. |
| orgId | string,null | true |  | The ID of the organization that owns the notification policy. |
| relatedEntityType | string | true |  | The type of the related entity. |
| relatedPoliciesCount | integer | true |  | The total number of entity policies that are using this template. |
| role | string,null | true |  | User role on entity. |
| uid | string | true |  | The identifier of the user who created the policy. |
| updatedAt | string,null(date-time) | true |  | The date when the policy was updated. |

### Enumerated Values

| Property | Value |
| --- | --- |
| channelScope | [organization, Organization, ORGANIZATION, entity, Entity, ENTITY, template, Template, TEMPLATE] |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

## EntityNotificationPolicyTemplateUpdate

```
{
  "properties": {
    "active": {
      "description": "Whether the notification policy is active or not.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "enum": [
        "secure_config.all",
        "dataset.all",
        "file.all",
        "comment.all",
        "invite_job.all",
        "deployment_prediction_explanations_computation.all",
        "model_deployments.critical_health",
        "model_deployments.critical_frequent_health_change",
        "model_deployments.frequent_health_change",
        "model_deployments.health",
        "model_deployments.retraining_policy",
        "inference_endpoints.health",
        "model_deployments.management_agent",
        "model_deployments.management_agent_health",
        "prediction_request.all",
        "challenger_management.all",
        "challenger_replay.all",
        "model_deployments.all",
        "project.all",
        "perma_delete_project.all",
        "users_delete.all",
        "applications.all",
        "model_version.stage_transitions",
        "model_version.all",
        "use_case.all",
        "batch_predictions.all",
        "change_requests.all",
        "custom_job_run.all",
        "custom_job_run.unsuccessful",
        "insights_computation.all",
        "notebook_schedule.all",
        "monitoring.all"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "enum": [
        "secure_config.created",
        "secure_config.deleted",
        "secure_config.shared",
        "dataset.created",
        "dataset.registered",
        "dataset.deleted",
        "datasets.deleted",
        "datasetrelationship.created",
        "dataset.shared",
        "datasets.shared",
        "file.created",
        "file.registered",
        "file.deleted",
        "file.shared",
        "comment.created",
        "comment.updated",
        "invite_job.completed",
        "misc.asset_access_request",
        "misc.webhook_connection_test",
        "misc.webhook_resend",
        "misc.email_verification",
        "monitoring.spooler_channel_base",
        "monitoring.spooler_channel_red",
        "monitoring.spooler_channel_green",
        "monitoring.external_model_nan_predictions",
        "management.deploymentInfo",
        "model_deployments.None",
        "model_deployments.deployment_sharing",
        "model_deployments.model_replacement",
        "prediction_request.None",
        "prediction_request.failed",
        "model_deployments.humility_rule",
        "model_deployments.model_replacement_lifecycle",
        "model_deployments.model_replacement_started",
        "model_deployments.model_replacement_succeeded",
        "model_deployments.model_replacement_failed",
        "model_deployments.model_replacement_validation_warning",
        "model_deployments.deployment_creation",
        "model_deployments.deployment_deletion",
        "model_deployments.service_health_yellow_from_green",
        "model_deployments.service_health_yellow_from_red",
        "model_deployments.service_health_red",
        "model_deployments.data_drift_yellow_from_green",
        "model_deployments.data_drift_yellow_from_red",
        "model_deployments.data_drift_red",
        "model_deployments.accuracy_yellow_from_green",
        "model_deployments.accuracy_yellow_from_red",
        "model_deployments.accuracy_red",
        "model_deployments.health.fairness_health.green_to_yellow",
        "model_deployments.health.fairness_health.red_to_yellow",
        "model_deployments.health.fairness_health.red",
        "model_deployments.health.custom_metrics_health.green_to_yellow",
        "model_deployments.health.custom_metrics_health.red_to_yellow",
        "model_deployments.health.custom_metrics_health.red",
        "model_deployments.health.base.green",
        "model_deployments.service_health_green",
        "model_deployments.data_drift_green",
        "model_deployments.accuracy_green",
        "model_deployments.health.fairness_health.green",
        "model_deployments.health.custom_metrics_health.green",
        "model_deployments.retraining_policy_run_started",
        "model_deployments.retraining_policy_run_succeeded",
        "model_deployments.retraining_policy_run_failed",
        "model_deployments.challenger_scoring_success",
        "model_deployments.challenger_scoring_data_warning",
        "model_deployments.challenger_scoring_failure",
        "model_deployments.challenger_scoring_started",
        "model_deployments.challenger_model_validation_warning",
        "model_deployments.challenger_model_created",
        "model_deployments.challenger_model_deleted",
        "model_deployments.actuals_upload_failed",
        "model_deployments.actuals_upload_warning",
        "model_deployments.training_data_baseline_calculation_started",
        "model_deployments.training_data_baseline_calculation_completed",
        "model_deployments.training_data_baseline_failed",
        "model_deployments.custom_model_deployment_creation_started",
        "model_deployments.custom_model_deployment_creation_completed",
        "model_deployments.custom_model_deployment_creation_failed",
        "model_deployments.custom_model_deployment_secure_config_failure",
        "model_deployments.deployment_prediction_explanations_preview_job_submitted",
        "model_deployments.deployment_prediction_explanations_preview_job_completed",
        "model_deployments.deployment_prediction_explanations_preview_job_failed",
        "model_deployments.custom_model_deployment_activated",
        "model_deployments.custom_model_deployment_activation_failed",
        "model_deployments.custom_model_deployment_deactivated",
        "model_deployments.custom_model_deployment_deactivation_failed",
        "model_deployments.prediction_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_warning",
        "model_deployments.actuals_processing_rate_limit_reached",
        "model_deployments.actuals_processing_rate_limit_warning",
        "model_deployments.deployment_monitoring_data_cleared",
        "model_deployments.deployment_launch_started",
        "model_deployments.deployment_launch_succeeded",
        "model_deployments.deployment_launch_failed",
        "model_deployments.deployment_shutdown_started",
        "model_deployments.deployment_shutdown_succeeded",
        "model_deployments.deployment_shutdown_failed",
        "model_deployments.endpoint_update_started",
        "model_deployments.endpoint_update_succeeded",
        "model_deployments.endpoint_update_failed",
        "model_deployments.management_agent_service_health_green",
        "model_deployments.management_agent_service_health_yellow",
        "model_deployments.management_agent_service_health_red",
        "model_deployments.management_agent_service_health_unknown",
        "model_deployments.predictions_missing_association_id",
        "model_deployments.prediction_result_rows_cleand_up",
        "model_deployments.batch_deleted",
        "model_deployments.batch_creation_limit_reached",
        "model_deployments.batch_creation_limit_exceeded",
        "model_deployments.batch_not_found",
        "model_deployments.predictions_encountered_for_locked_batch",
        "model_deployments.predictions_encountered_for_deleted_batch",
        "model_deployments.scheduled_report_generated",
        "model_deployments.predictions_timeliness_health_red",
        "model_deployments.actuals_timeliness_health_red",
        "model_deployments.service_health_still_red",
        "model_deployments.data_drift_still_red",
        "model_deployments.accuracy_still_red",
        "model_deployments.health.fairness_health.still_red",
        "model_deployments.health.custom_metrics_health.still_red",
        "model_deployments.predictions_timeliness_health_still_red",
        "model_deployments.actuals_timeliness_health_still_red",
        "model_deployments.service_health_still_yellow",
        "model_deployments.data_drift_still_yellow",
        "model_deployments.accuracy_still_yellow",
        "model_deployments.health.fairness_health.still_yellow",
        "model_deployments.health.custom_metrics_health.still_yellow",
        "model_deployments.prediction_payload_parsing_failure",
        "model_deployments.deployment_inference_server_creation_started",
        "model_deployments.deployment_inference_server_creation_failed",
        "model_deployments.deployment_inference_server_creation_completed",
        "model_deployments.deployment_inference_server_deletion",
        "model_deployments.deployment_inference_server_idle_stopped",
        "model_deployments.deployment_inference_server_maintenance_started",
        "entity_notification_policy_template.shared",
        "notification_channel_template.shared",
        "project.created",
        "project.deleted",
        "project.shared",
        "autopilot.complete",
        "autopilot.started",
        "autostart.failure",
        "perma_delete_project.success",
        "perma_delete_project.failure",
        "users_delete.preview_started",
        "users_delete.preview_completed",
        "users_delete.preview_failed",
        "users_delete.started",
        "users_delete.completed",
        "users_delete.failed",
        "application.created",
        "application.shared",
        "model_version.added",
        "model_version.stage_transition_from_registered_to_development",
        "model_version.stage_transition_from_registered_to_staging",
        "model_version.stage_transition_from_registered_to_production",
        "model_version.stage_transition_from_registered_to_archived",
        "model_version.stage_transition_from_development_to_registered",
        "model_version.stage_transition_from_development_to_staging",
        "model_version.stage_transition_from_development_to_production",
        "model_version.stage_transition_from_development_to_archived",
        "model_version.stage_transition_from_staging_to_registered",
        "model_version.stage_transition_from_staging_to_development",
        "model_version.stage_transition_from_staging_to_production",
        "model_version.stage_transition_from_staging_to_archived",
        "model_version.stage_transition_from_production_to_registered",
        "model_version.stage_transition_from_production_to_development",
        "model_version.stage_transition_from_production_to_staging",
        "model_version.stage_transition_from_production_to_archived",
        "model_version.stage_transition_from_archived_to_registered",
        "model_version.stage_transition_from_archived_to_development",
        "model_version.stage_transition_from_archived_to_production",
        "model_version.stage_transition_from_archived_to_staging",
        "use_case.shared",
        "batch_predictions.success",
        "batch_predictions.failed",
        "batch_predictions.scheduler.auto_disabled",
        "change_request.cancelled",
        "change_request.created",
        "change_request.deployment_approval_requested",
        "change_request.resolved",
        "change_request.proposed_changes_updated",
        "change_request.pending",
        "change_request.commenting_review_added",
        "change_request.approving_review_added",
        "change_request.changes_requesting_review_added",
        "custom_job_run.success",
        "custom_job_run.failed",
        "custom_job_run.interrupted",
        "custom_job_run.cancelled",
        "prediction_explanations_computation.None",
        "prediction_explanations_computation.prediction_explanations_preview_job_submitted",
        "prediction_explanations_computation.prediction_explanations_preview_job_completed",
        "prediction_explanations_computation.prediction_explanations_preview_job_failed",
        "monitoring.rate_limit_enforced",
        "notebook_schedule.created",
        "notebook_schedule.failure",
        "notebook_schedule.completed",
        "abstract",
        "moderation.metric.creation_error",
        "moderation.metric.reporting_error",
        "moderation.model.moderation_started",
        "moderation.model.moderation_completed",
        "moderation.model.pre_score_phase_started",
        "moderation.model.pre_score_phase_completed",
        "moderation.model.post_score_phase_started",
        "moderation.model.post_score_phase_completed",
        "moderation.model.config_error",
        "moderation.model.runtime_error",
        "moderation.model.scoring_started",
        "moderation.model.scoring_completed",
        "moderation.model.scoring_error"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "maximalFrequency": {
      "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the notification policy.",
      "maxLength": 100,
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| active | boolean | false |  | Whether the notification policy is active or not. |
| channelId | string | false |  | The ID of the notification channel to be used to send the notification. |
| eventGroup | string | false |  | The group of the event that triggers the notification. |
| eventType | string | false |  | The type of the event that triggers the notification. |
| maximalFrequency | string,null | false |  | Maximal frequency between policy runs in ISO 8601 duration string. |
| name | string | false | maxLength: 100 | The name of the notification policy. |

### Enumerated Values

| Property | Value |
| --- | --- |
| eventGroup | [secure_config.all, dataset.all, file.all, comment.all, invite_job.all, deployment_prediction_explanations_computation.all, model_deployments.critical_health, model_deployments.critical_frequent_health_change, model_deployments.frequent_health_change, model_deployments.health, model_deployments.retraining_policy, inference_endpoints.health, model_deployments.management_agent, model_deployments.management_agent_health, prediction_request.all, challenger_management.all, challenger_replay.all, model_deployments.all, project.all, perma_delete_project.all, users_delete.all, applications.all, model_version.stage_transitions, model_version.all, use_case.all, batch_predictions.all, change_requests.all, custom_job_run.all, custom_job_run.unsuccessful, insights_computation.all, notebook_schedule.all, monitoring.all] |
| eventType | [secure_config.created, secure_config.deleted, secure_config.shared, dataset.created, dataset.registered, dataset.deleted, datasets.deleted, datasetrelationship.created, dataset.shared, datasets.shared, file.created, file.registered, file.deleted, file.shared, comment.created, comment.updated, invite_job.completed, misc.asset_access_request, misc.webhook_connection_test, misc.webhook_resend, misc.email_verification, monitoring.spooler_channel_base, monitoring.spooler_channel_red, monitoring.spooler_channel_green, monitoring.external_model_nan_predictions, management.deploymentInfo, model_deployments.None, model_deployments.deployment_sharing, model_deployments.model_replacement, prediction_request.None, prediction_request.failed, model_deployments.humility_rule, model_deployments.model_replacement_lifecycle, model_deployments.model_replacement_started, model_deployments.model_replacement_succeeded, model_deployments.model_replacement_failed, model_deployments.model_replacement_validation_warning, model_deployments.deployment_creation, model_deployments.deployment_deletion, model_deployments.service_health_yellow_from_green, model_deployments.service_health_yellow_from_red, model_deployments.service_health_red, model_deployments.data_drift_yellow_from_green, model_deployments.data_drift_yellow_from_red, model_deployments.data_drift_red, model_deployments.accuracy_yellow_from_green, model_deployments.accuracy_yellow_from_red, model_deployments.accuracy_red, model_deployments.health.fairness_health.green_to_yellow, model_deployments.health.fairness_health.red_to_yellow, model_deployments.health.fairness_health.red, model_deployments.health.custom_metrics_health.green_to_yellow, model_deployments.health.custom_metrics_health.red_to_yellow, model_deployments.health.custom_metrics_health.red, model_deployments.health.base.green, model_deployments.service_health_green, model_deployments.data_drift_green, model_deployments.accuracy_green, model_deployments.health.fairness_health.green, model_deployments.health.custom_metrics_health.green, model_deployments.retraining_policy_run_started, model_deployments.retraining_policy_run_succeeded, model_deployments.retraining_policy_run_failed, model_deployments.challenger_scoring_success, model_deployments.challenger_scoring_data_warning, model_deployments.challenger_scoring_failure, model_deployments.challenger_scoring_started, model_deployments.challenger_model_validation_warning, model_deployments.challenger_model_created, model_deployments.challenger_model_deleted, model_deployments.actuals_upload_failed, model_deployments.actuals_upload_warning, model_deployments.training_data_baseline_calculation_started, model_deployments.training_data_baseline_calculation_completed, model_deployments.training_data_baseline_failed, model_deployments.custom_model_deployment_creation_started, model_deployments.custom_model_deployment_creation_completed, model_deployments.custom_model_deployment_creation_failed, model_deployments.custom_model_deployment_secure_config_failure, model_deployments.deployment_prediction_explanations_preview_job_submitted, model_deployments.deployment_prediction_explanations_preview_job_completed, model_deployments.deployment_prediction_explanations_preview_job_failed, model_deployments.custom_model_deployment_activated, model_deployments.custom_model_deployment_activation_failed, model_deployments.custom_model_deployment_deactivated, model_deployments.custom_model_deployment_deactivation_failed, model_deployments.prediction_processing_rate_limit_reached, model_deployments.prediction_data_processing_rate_limit_reached, model_deployments.prediction_data_processing_rate_limit_warning, model_deployments.actuals_processing_rate_limit_reached, model_deployments.actuals_processing_rate_limit_warning, model_deployments.deployment_monitoring_data_cleared, model_deployments.deployment_launch_started, model_deployments.deployment_launch_succeeded, model_deployments.deployment_launch_failed, model_deployments.deployment_shutdown_started, model_deployments.deployment_shutdown_succeeded, model_deployments.deployment_shutdown_failed, model_deployments.endpoint_update_started, model_deployments.endpoint_update_succeeded, model_deployments.endpoint_update_failed, model_deployments.management_agent_service_health_green, model_deployments.management_agent_service_health_yellow, model_deployments.management_agent_service_health_red, model_deployments.management_agent_service_health_unknown, model_deployments.predictions_missing_association_id, model_deployments.prediction_result_rows_cleand_up, model_deployments.batch_deleted, model_deployments.batch_creation_limit_reached, model_deployments.batch_creation_limit_exceeded, model_deployments.batch_not_found, model_deployments.predictions_encountered_for_locked_batch, model_deployments.predictions_encountered_for_deleted_batch, model_deployments.scheduled_report_generated, model_deployments.predictions_timeliness_health_red, model_deployments.actuals_timeliness_health_red, model_deployments.service_health_still_red, model_deployments.data_drift_still_red, model_deployments.accuracy_still_red, model_deployments.health.fairness_health.still_red, model_deployments.health.custom_metrics_health.still_red, model_deployments.predictions_timeliness_health_still_red, model_deployments.actuals_timeliness_health_still_red, model_deployments.service_health_still_yellow, model_deployments.data_drift_still_yellow, model_deployments.accuracy_still_yellow, model_deployments.health.fairness_health.still_yellow, model_deployments.health.custom_metrics_health.still_yellow, model_deployments.prediction_payload_parsing_failure, model_deployments.deployment_inference_server_creation_started, model_deployments.deployment_inference_server_creation_failed, model_deployments.deployment_inference_server_creation_completed, model_deployments.deployment_inference_server_deletion, model_deployments.deployment_inference_server_idle_stopped, model_deployments.deployment_inference_server_maintenance_started, entity_notification_policy_template.shared, notification_channel_template.shared, project.created, project.deleted, project.shared, autopilot.complete, autopilot.started, autostart.failure, perma_delete_project.success, perma_delete_project.failure, users_delete.preview_started, users_delete.preview_completed, users_delete.preview_failed, users_delete.started, users_delete.completed, users_delete.failed, application.created, application.shared, model_version.added, model_version.stage_transition_from_registered_to_development, model_version.stage_transition_from_registered_to_staging, model_version.stage_transition_from_registered_to_production, model_version.stage_transition_from_registered_to_archived, model_version.stage_transition_from_development_to_registered, model_version.stage_transition_from_development_to_staging, model_version.stage_transition_from_development_to_production, model_version.stage_transition_from_development_to_archived, model_version.stage_transition_from_staging_to_registered, model_version.stage_transition_from_staging_to_development, model_version.stage_transition_from_staging_to_production, model_version.stage_transition_from_staging_to_archived, model_version.stage_transition_from_production_to_registered, model_version.stage_transition_from_production_to_development, model_version.stage_transition_from_production_to_staging, model_version.stage_transition_from_production_to_archived, model_version.stage_transition_from_archived_to_registered, model_version.stage_transition_from_archived_to_development, model_version.stage_transition_from_archived_to_production, model_version.stage_transition_from_archived_to_staging, use_case.shared, batch_predictions.success, batch_predictions.failed, batch_predictions.scheduler.auto_disabled, change_request.cancelled, change_request.created, change_request.deployment_approval_requested, change_request.resolved, change_request.proposed_changes_updated, change_request.pending, change_request.commenting_review_added, change_request.approving_review_added, change_request.changes_requesting_review_added, custom_job_run.success, custom_job_run.failed, custom_job_run.interrupted, custom_job_run.cancelled, prediction_explanations_computation.None, prediction_explanations_computation.prediction_explanations_preview_job_submitted, prediction_explanations_computation.prediction_explanations_preview_job_completed, prediction_explanations_computation.prediction_explanations_preview_job_failed, monitoring.rate_limit_enforced, notebook_schedule.created, notebook_schedule.failure, notebook_schedule.completed, abstract, moderation.metric.creation_error, moderation.metric.reporting_error, moderation.model.moderation_started, moderation.model.moderation_completed, moderation.model.pre_score_phase_started, moderation.model.pre_score_phase_completed, moderation.model.post_score_phase_started, moderation.model.post_score_phase_completed, moderation.model.config_error, moderation.model.runtime_error, moderation.model.scoring_started, moderation.model.scoring_completed, moderation.model.scoring_error] |

## EntityNotificationPolicyUpdate

```
{
  "properties": {
    "active": {
      "description": "Whether the notification policy is active or not.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "channelScope": {
      "description": "Scope of the channel.",
      "enum": [
        "organization",
        "Organization",
        "ORGANIZATION",
        "entity",
        "Entity",
        "ENTITY",
        "template",
        "Template",
        "TEMPLATE"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "enum": [
        "secure_config.all",
        "dataset.all",
        "file.all",
        "comment.all",
        "invite_job.all",
        "deployment_prediction_explanations_computation.all",
        "model_deployments.critical_health",
        "model_deployments.critical_frequent_health_change",
        "model_deployments.frequent_health_change",
        "model_deployments.health",
        "model_deployments.retraining_policy",
        "inference_endpoints.health",
        "model_deployments.management_agent",
        "model_deployments.management_agent_health",
        "prediction_request.all",
        "challenger_management.all",
        "challenger_replay.all",
        "model_deployments.all",
        "project.all",
        "perma_delete_project.all",
        "users_delete.all",
        "applications.all",
        "model_version.stage_transitions",
        "model_version.all",
        "use_case.all",
        "batch_predictions.all",
        "change_requests.all",
        "custom_job_run.all",
        "custom_job_run.unsuccessful",
        "insights_computation.all",
        "notebook_schedule.all",
        "monitoring.all"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "enum": [
        "secure_config.created",
        "secure_config.deleted",
        "secure_config.shared",
        "dataset.created",
        "dataset.registered",
        "dataset.deleted",
        "datasets.deleted",
        "datasetrelationship.created",
        "dataset.shared",
        "datasets.shared",
        "file.created",
        "file.registered",
        "file.deleted",
        "file.shared",
        "comment.created",
        "comment.updated",
        "invite_job.completed",
        "misc.asset_access_request",
        "misc.webhook_connection_test",
        "misc.webhook_resend",
        "misc.email_verification",
        "monitoring.spooler_channel_base",
        "monitoring.spooler_channel_red",
        "monitoring.spooler_channel_green",
        "monitoring.external_model_nan_predictions",
        "management.deploymentInfo",
        "model_deployments.None",
        "model_deployments.deployment_sharing",
        "model_deployments.model_replacement",
        "prediction_request.None",
        "prediction_request.failed",
        "model_deployments.humility_rule",
        "model_deployments.model_replacement_lifecycle",
        "model_deployments.model_replacement_started",
        "model_deployments.model_replacement_succeeded",
        "model_deployments.model_replacement_failed",
        "model_deployments.model_replacement_validation_warning",
        "model_deployments.deployment_creation",
        "model_deployments.deployment_deletion",
        "model_deployments.service_health_yellow_from_green",
        "model_deployments.service_health_yellow_from_red",
        "model_deployments.service_health_red",
        "model_deployments.data_drift_yellow_from_green",
        "model_deployments.data_drift_yellow_from_red",
        "model_deployments.data_drift_red",
        "model_deployments.accuracy_yellow_from_green",
        "model_deployments.accuracy_yellow_from_red",
        "model_deployments.accuracy_red",
        "model_deployments.health.fairness_health.green_to_yellow",
        "model_deployments.health.fairness_health.red_to_yellow",
        "model_deployments.health.fairness_health.red",
        "model_deployments.health.custom_metrics_health.green_to_yellow",
        "model_deployments.health.custom_metrics_health.red_to_yellow",
        "model_deployments.health.custom_metrics_health.red",
        "model_deployments.health.base.green",
        "model_deployments.service_health_green",
        "model_deployments.data_drift_green",
        "model_deployments.accuracy_green",
        "model_deployments.health.fairness_health.green",
        "model_deployments.health.custom_metrics_health.green",
        "model_deployments.retraining_policy_run_started",
        "model_deployments.retraining_policy_run_succeeded",
        "model_deployments.retraining_policy_run_failed",
        "model_deployments.challenger_scoring_success",
        "model_deployments.challenger_scoring_data_warning",
        "model_deployments.challenger_scoring_failure",
        "model_deployments.challenger_scoring_started",
        "model_deployments.challenger_model_validation_warning",
        "model_deployments.challenger_model_created",
        "model_deployments.challenger_model_deleted",
        "model_deployments.actuals_upload_failed",
        "model_deployments.actuals_upload_warning",
        "model_deployments.training_data_baseline_calculation_started",
        "model_deployments.training_data_baseline_calculation_completed",
        "model_deployments.training_data_baseline_failed",
        "model_deployments.custom_model_deployment_creation_started",
        "model_deployments.custom_model_deployment_creation_completed",
        "model_deployments.custom_model_deployment_creation_failed",
        "model_deployments.custom_model_deployment_secure_config_failure",
        "model_deployments.deployment_prediction_explanations_preview_job_submitted",
        "model_deployments.deployment_prediction_explanations_preview_job_completed",
        "model_deployments.deployment_prediction_explanations_preview_job_failed",
        "model_deployments.custom_model_deployment_activated",
        "model_deployments.custom_model_deployment_activation_failed",
        "model_deployments.custom_model_deployment_deactivated",
        "model_deployments.custom_model_deployment_deactivation_failed",
        "model_deployments.prediction_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_warning",
        "model_deployments.actuals_processing_rate_limit_reached",
        "model_deployments.actuals_processing_rate_limit_warning",
        "model_deployments.deployment_monitoring_data_cleared",
        "model_deployments.deployment_launch_started",
        "model_deployments.deployment_launch_succeeded",
        "model_deployments.deployment_launch_failed",
        "model_deployments.deployment_shutdown_started",
        "model_deployments.deployment_shutdown_succeeded",
        "model_deployments.deployment_shutdown_failed",
        "model_deployments.endpoint_update_started",
        "model_deployments.endpoint_update_succeeded",
        "model_deployments.endpoint_update_failed",
        "model_deployments.management_agent_service_health_green",
        "model_deployments.management_agent_service_health_yellow",
        "model_deployments.management_agent_service_health_red",
        "model_deployments.management_agent_service_health_unknown",
        "model_deployments.predictions_missing_association_id",
        "model_deployments.prediction_result_rows_cleand_up",
        "model_deployments.batch_deleted",
        "model_deployments.batch_creation_limit_reached",
        "model_deployments.batch_creation_limit_exceeded",
        "model_deployments.batch_not_found",
        "model_deployments.predictions_encountered_for_locked_batch",
        "model_deployments.predictions_encountered_for_deleted_batch",
        "model_deployments.scheduled_report_generated",
        "model_deployments.predictions_timeliness_health_red",
        "model_deployments.actuals_timeliness_health_red",
        "model_deployments.service_health_still_red",
        "model_deployments.data_drift_still_red",
        "model_deployments.accuracy_still_red",
        "model_deployments.health.fairness_health.still_red",
        "model_deployments.health.custom_metrics_health.still_red",
        "model_deployments.predictions_timeliness_health_still_red",
        "model_deployments.actuals_timeliness_health_still_red",
        "model_deployments.service_health_still_yellow",
        "model_deployments.data_drift_still_yellow",
        "model_deployments.accuracy_still_yellow",
        "model_deployments.health.fairness_health.still_yellow",
        "model_deployments.health.custom_metrics_health.still_yellow",
        "model_deployments.prediction_payload_parsing_failure",
        "model_deployments.deployment_inference_server_creation_started",
        "model_deployments.deployment_inference_server_creation_failed",
        "model_deployments.deployment_inference_server_creation_completed",
        "model_deployments.deployment_inference_server_deletion",
        "model_deployments.deployment_inference_server_idle_stopped",
        "model_deployments.deployment_inference_server_maintenance_started",
        "entity_notification_policy_template.shared",
        "notification_channel_template.shared",
        "project.created",
        "project.deleted",
        "project.shared",
        "autopilot.complete",
        "autopilot.started",
        "autostart.failure",
        "perma_delete_project.success",
        "perma_delete_project.failure",
        "users_delete.preview_started",
        "users_delete.preview_completed",
        "users_delete.preview_failed",
        "users_delete.started",
        "users_delete.completed",
        "users_delete.failed",
        "application.created",
        "application.shared",
        "model_version.added",
        "model_version.stage_transition_from_registered_to_development",
        "model_version.stage_transition_from_registered_to_staging",
        "model_version.stage_transition_from_registered_to_production",
        "model_version.stage_transition_from_registered_to_archived",
        "model_version.stage_transition_from_development_to_registered",
        "model_version.stage_transition_from_development_to_staging",
        "model_version.stage_transition_from_development_to_production",
        "model_version.stage_transition_from_development_to_archived",
        "model_version.stage_transition_from_staging_to_registered",
        "model_version.stage_transition_from_staging_to_development",
        "model_version.stage_transition_from_staging_to_production",
        "model_version.stage_transition_from_staging_to_archived",
        "model_version.stage_transition_from_production_to_registered",
        "model_version.stage_transition_from_production_to_development",
        "model_version.stage_transition_from_production_to_staging",
        "model_version.stage_transition_from_production_to_archived",
        "model_version.stage_transition_from_archived_to_registered",
        "model_version.stage_transition_from_archived_to_development",
        "model_version.stage_transition_from_archived_to_production",
        "model_version.stage_transition_from_archived_to_staging",
        "use_case.shared",
        "batch_predictions.success",
        "batch_predictions.failed",
        "batch_predictions.scheduler.auto_disabled",
        "change_request.cancelled",
        "change_request.created",
        "change_request.deployment_approval_requested",
        "change_request.resolved",
        "change_request.proposed_changes_updated",
        "change_request.pending",
        "change_request.commenting_review_added",
        "change_request.approving_review_added",
        "change_request.changes_requesting_review_added",
        "custom_job_run.success",
        "custom_job_run.failed",
        "custom_job_run.interrupted",
        "custom_job_run.cancelled",
        "prediction_explanations_computation.None",
        "prediction_explanations_computation.prediction_explanations_preview_job_submitted",
        "prediction_explanations_computation.prediction_explanations_preview_job_completed",
        "prediction_explanations_computation.prediction_explanations_preview_job_failed",
        "monitoring.rate_limit_enforced",
        "notebook_schedule.created",
        "notebook_schedule.failure",
        "notebook_schedule.completed",
        "abstract",
        "moderation.metric.creation_error",
        "moderation.metric.reporting_error",
        "moderation.model.moderation_started",
        "moderation.model.moderation_completed",
        "moderation.model.pre_score_phase_started",
        "moderation.model.pre_score_phase_completed",
        "moderation.model.post_score_phase_started",
        "moderation.model.post_score_phase_completed",
        "moderation.model.config_error",
        "moderation.model.runtime_error",
        "moderation.model.scoring_started",
        "moderation.model.scoring_completed",
        "moderation.model.scoring_error"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "maximalFrequency": {
      "description": "Maximal frequency between policy runs in ISO 8601 duration string.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the notification policy.",
      "maxLength": 100,
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| active | boolean | false |  | Whether the notification policy is active or not. |
| channelId | string | false |  | The ID of the notification channel to be used to send the notification. |
| channelScope | string | false |  | Scope of the channel. |
| eventGroup | string | false |  | The group of the event that triggers the notification. |
| eventType | string | false |  | The type of the event that triggers the notification. |
| maximalFrequency | string,null | false |  | Maximal frequency between policy runs in ISO 8601 duration string. |
| name | string | false | maxLength: 100 | The name of the notification policy. |

### Enumerated Values

| Property | Value |
| --- | --- |
| channelScope | [organization, Organization, ORGANIZATION, entity, Entity, ENTITY, template, Template, TEMPLATE] |
| eventGroup | [secure_config.all, dataset.all, file.all, comment.all, invite_job.all, deployment_prediction_explanations_computation.all, model_deployments.critical_health, model_deployments.critical_frequent_health_change, model_deployments.frequent_health_change, model_deployments.health, model_deployments.retraining_policy, inference_endpoints.health, model_deployments.management_agent, model_deployments.management_agent_health, prediction_request.all, challenger_management.all, challenger_replay.all, model_deployments.all, project.all, perma_delete_project.all, users_delete.all, applications.all, model_version.stage_transitions, model_version.all, use_case.all, batch_predictions.all, change_requests.all, custom_job_run.all, custom_job_run.unsuccessful, insights_computation.all, notebook_schedule.all, monitoring.all] |
| eventType | [secure_config.created, secure_config.deleted, secure_config.shared, dataset.created, dataset.registered, dataset.deleted, datasets.deleted, datasetrelationship.created, dataset.shared, datasets.shared, file.created, file.registered, file.deleted, file.shared, comment.created, comment.updated, invite_job.completed, misc.asset_access_request, misc.webhook_connection_test, misc.webhook_resend, misc.email_verification, monitoring.spooler_channel_base, monitoring.spooler_channel_red, monitoring.spooler_channel_green, monitoring.external_model_nan_predictions, management.deploymentInfo, model_deployments.None, model_deployments.deployment_sharing, model_deployments.model_replacement, prediction_request.None, prediction_request.failed, model_deployments.humility_rule, model_deployments.model_replacement_lifecycle, model_deployments.model_replacement_started, model_deployments.model_replacement_succeeded, model_deployments.model_replacement_failed, model_deployments.model_replacement_validation_warning, model_deployments.deployment_creation, model_deployments.deployment_deletion, model_deployments.service_health_yellow_from_green, model_deployments.service_health_yellow_from_red, model_deployments.service_health_red, model_deployments.data_drift_yellow_from_green, model_deployments.data_drift_yellow_from_red, model_deployments.data_drift_red, model_deployments.accuracy_yellow_from_green, model_deployments.accuracy_yellow_from_red, model_deployments.accuracy_red, model_deployments.health.fairness_health.green_to_yellow, model_deployments.health.fairness_health.red_to_yellow, model_deployments.health.fairness_health.red, model_deployments.health.custom_metrics_health.green_to_yellow, model_deployments.health.custom_metrics_health.red_to_yellow, model_deployments.health.custom_metrics_health.red, model_deployments.health.base.green, model_deployments.service_health_green, model_deployments.data_drift_green, model_deployments.accuracy_green, model_deployments.health.fairness_health.green, model_deployments.health.custom_metrics_health.green, model_deployments.retraining_policy_run_started, model_deployments.retraining_policy_run_succeeded, model_deployments.retraining_policy_run_failed, model_deployments.challenger_scoring_success, model_deployments.challenger_scoring_data_warning, model_deployments.challenger_scoring_failure, model_deployments.challenger_scoring_started, model_deployments.challenger_model_validation_warning, model_deployments.challenger_model_created, model_deployments.challenger_model_deleted, model_deployments.actuals_upload_failed, model_deployments.actuals_upload_warning, model_deployments.training_data_baseline_calculation_started, model_deployments.training_data_baseline_calculation_completed, model_deployments.training_data_baseline_failed, model_deployments.custom_model_deployment_creation_started, model_deployments.custom_model_deployment_creation_completed, model_deployments.custom_model_deployment_creation_failed, model_deployments.custom_model_deployment_secure_config_failure, model_deployments.deployment_prediction_explanations_preview_job_submitted, model_deployments.deployment_prediction_explanations_preview_job_completed, model_deployments.deployment_prediction_explanations_preview_job_failed, model_deployments.custom_model_deployment_activated, model_deployments.custom_model_deployment_activation_failed, model_deployments.custom_model_deployment_deactivated, model_deployments.custom_model_deployment_deactivation_failed, model_deployments.prediction_processing_rate_limit_reached, model_deployments.prediction_data_processing_rate_limit_reached, model_deployments.prediction_data_processing_rate_limit_warning, model_deployments.actuals_processing_rate_limit_reached, model_deployments.actuals_processing_rate_limit_warning, model_deployments.deployment_monitoring_data_cleared, model_deployments.deployment_launch_started, model_deployments.deployment_launch_succeeded, model_deployments.deployment_launch_failed, model_deployments.deployment_shutdown_started, model_deployments.deployment_shutdown_succeeded, model_deployments.deployment_shutdown_failed, model_deployments.endpoint_update_started, model_deployments.endpoint_update_succeeded, model_deployments.endpoint_update_failed, model_deployments.management_agent_service_health_green, model_deployments.management_agent_service_health_yellow, model_deployments.management_agent_service_health_red, model_deployments.management_agent_service_health_unknown, model_deployments.predictions_missing_association_id, model_deployments.prediction_result_rows_cleand_up, model_deployments.batch_deleted, model_deployments.batch_creation_limit_reached, model_deployments.batch_creation_limit_exceeded, model_deployments.batch_not_found, model_deployments.predictions_encountered_for_locked_batch, model_deployments.predictions_encountered_for_deleted_batch, model_deployments.scheduled_report_generated, model_deployments.predictions_timeliness_health_red, model_deployments.actuals_timeliness_health_red, model_deployments.service_health_still_red, model_deployments.data_drift_still_red, model_deployments.accuracy_still_red, model_deployments.health.fairness_health.still_red, model_deployments.health.custom_metrics_health.still_red, model_deployments.predictions_timeliness_health_still_red, model_deployments.actuals_timeliness_health_still_red, model_deployments.service_health_still_yellow, model_deployments.data_drift_still_yellow, model_deployments.accuracy_still_yellow, model_deployments.health.fairness_health.still_yellow, model_deployments.health.custom_metrics_health.still_yellow, model_deployments.prediction_payload_parsing_failure, model_deployments.deployment_inference_server_creation_started, model_deployments.deployment_inference_server_creation_failed, model_deployments.deployment_inference_server_creation_completed, model_deployments.deployment_inference_server_deletion, model_deployments.deployment_inference_server_idle_stopped, model_deployments.deployment_inference_server_maintenance_started, entity_notification_policy_template.shared, notification_channel_template.shared, project.created, project.deleted, project.shared, autopilot.complete, autopilot.started, autostart.failure, perma_delete_project.success, perma_delete_project.failure, users_delete.preview_started, users_delete.preview_completed, users_delete.preview_failed, users_delete.started, users_delete.completed, users_delete.failed, application.created, application.shared, model_version.added, model_version.stage_transition_from_registered_to_development, model_version.stage_transition_from_registered_to_staging, model_version.stage_transition_from_registered_to_production, model_version.stage_transition_from_registered_to_archived, model_version.stage_transition_from_development_to_registered, model_version.stage_transition_from_development_to_staging, model_version.stage_transition_from_development_to_production, model_version.stage_transition_from_development_to_archived, model_version.stage_transition_from_staging_to_registered, model_version.stage_transition_from_staging_to_development, model_version.stage_transition_from_staging_to_production, model_version.stage_transition_from_staging_to_archived, model_version.stage_transition_from_production_to_registered, model_version.stage_transition_from_production_to_development, model_version.stage_transition_from_production_to_staging, model_version.stage_transition_from_production_to_archived, model_version.stage_transition_from_archived_to_registered, model_version.stage_transition_from_archived_to_development, model_version.stage_transition_from_archived_to_production, model_version.stage_transition_from_archived_to_staging, use_case.shared, batch_predictions.success, batch_predictions.failed, batch_predictions.scheduler.auto_disabled, change_request.cancelled, change_request.created, change_request.deployment_approval_requested, change_request.resolved, change_request.proposed_changes_updated, change_request.pending, change_request.commenting_review_added, change_request.approving_review_added, change_request.changes_requesting_review_added, custom_job_run.success, custom_job_run.failed, custom_job_run.interrupted, custom_job_run.cancelled, prediction_explanations_computation.None, prediction_explanations_computation.prediction_explanations_preview_job_submitted, prediction_explanations_computation.prediction_explanations_preview_job_completed, prediction_explanations_computation.prediction_explanations_preview_job_failed, monitoring.rate_limit_enforced, notebook_schedule.created, notebook_schedule.failure, notebook_schedule.completed, abstract, moderation.metric.creation_error, moderation.metric.reporting_error, moderation.model.moderation_started, moderation.model.moderation_completed, moderation.model.pre_score_phase_started, moderation.model.pre_score_phase_completed, moderation.model.post_score_phase_started, moderation.model.post_score_phase_completed, moderation.model.config_error, moderation.model.runtime_error, moderation.model.scoring_started, moderation.model.scoring_completed, moderation.model.scoring_error] |

## EventGroup

```
{
  "description": "The group of the event that triggers the notification.",
  "properties": {
    "events": {
      "description": "The events included in this group.",
      "items": {
        "description": "The type of the event that triggers the notification.",
        "properties": {
          "id": {
            "description": "The ID of the event type.",
            "type": "string"
          },
          "label": {
            "description": "The display name of the event type.",
            "type": "string"
          }
        },
        "required": [
          "id",
          "label"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array"
    },
    "id": {
      "description": "The ID of the event group.",
      "type": "string"
    },
    "label": {
      "description": "The display name of the event group.",
      "type": "string"
    }
  },
  "required": [
    "events",
    "id",
    "label"
  ],
  "type": "object"
}
```

The group of the event that triggers the notification.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| events | [EventType] | true | maxItems: 1000 | The events included in this group. |
| id | string | true |  | The ID of the event group. |
| label | string | true |  | The display name of the event group. |

## EventGroupResponse

```
{
  "properties": {
    "events": {
      "description": "The event types belonging to the group.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "id": {
      "description": "The group ID.",
      "type": "string"
    },
    "label": {
      "description": "The group name for display.",
      "type": "string"
    },
    "requireMaxFrequency": {
      "description": "Indicates if a group requires max frequency setting.",
      "type": "boolean"
    }
  },
  "required": [
    "events",
    "id",
    "label",
    "requireMaxFrequency"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| events | [string] | true |  | The event types belonging to the group. |
| id | string | true |  | The group ID. |
| label | string | true |  | The group name for display. |
| requireMaxFrequency | boolean | true |  | Indicates if a group requires max frequency setting. |

## EventResponse

```
{
  "properties": {
    "id": {
      "description": "The event type as an ID.",
      "type": "string"
    },
    "label": {
      "description": "The event type for display.",
      "type": "string"
    },
    "requireMaxFrequency": {
      "description": "Indicates if an event requires max frequency setting.",
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "label",
    "requireMaxFrequency"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| id | string | true |  | The event type as an ID. |
| label | string | true |  | The event type for display. |
| requireMaxFrequency | boolean | true |  | Indicates if an event requires max frequency setting. |

## EventType

```
{
  "description": "The type of the event that triggers the notification.",
  "properties": {
    "id": {
      "description": "The ID of the event type.",
      "type": "string"
    },
    "label": {
      "description": "The display name of the event type.",
      "type": "string"
    }
  },
  "required": [
    "id",
    "label"
  ],
  "type": "object"
}
```

The type of the event that triggers the notification.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| id | string | true |  | The ID of the event type. |
| label | string | true |  | The display name of the event type. |

## ExternalNaNPredictionsEventData

```
{
  "description": "The external NaN predictions event payload.",
  "properties": {
    "count": {
      "description": "The number of NaN predictions by the external model.",
      "exclusiveMinimum": 0,
      "type": "integer"
    },
    "modelId": {
      "default": null,
      "description": "The identifier of the model.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "count",
    "modelId"
  ],
  "type": "object"
}
```

The external NaN predictions event payload.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| count | integer | true |  | The number of NaN predictions by the external model. |
| modelId | string,null | true |  | The identifier of the model. |

## FailedInviteData

```
{
  "description": "Details about why the invite failed.",
  "properties": {
    "email": {
      "description": "The email address of the invited user.",
      "type": "string"
    },
    "errorMessage": {
      "description": "The error message explaining why the invite failed.",
      "type": "string"
    },
    "userId": {
      "description": "The ID of the user.",
      "type": "string"
    }
  },
  "required": [
    "email",
    "errorMessage",
    "userId"
  ],
  "type": "object",
  "x-versionadded": "v2.39"
}
```

Details about why the invite failed.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| email | string | true |  | The email address of the invited user. |
| errorMessage | string | true |  | The error message explaining why the invite failed. |
| userId | string | true |  | The ID of the user. |

## GrantAccessControlWithId

```
{
  "properties": {
    "id": {
      "description": "The ID of the recipient.",
      "type": "string"
    },
    "role": {
      "description": "The role of the recipient on this entity.",
      "enum": [
        "ADMIN",
        "CONSUMER",
        "DATA_SCIENTIST",
        "EDITOR",
        "NO_ROLE",
        "OBSERVER",
        "OWNER",
        "READ_ONLY",
        "READ_WRITE",
        "USER"
      ],
      "type": "string"
    },
    "shareRecipientType": {
      "description": "Describes the recipient type — one of user, group, organization, or externalApplication.",
      "enum": [
        "user",
        "group",
        "organization",
        "externalApplication"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "role",
    "shareRecipientType"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| id | string | true |  | The ID of the recipient. |
| role | string | true |  | The role of the recipient on this entity. |
| shareRecipientType | string | true |  | Describes the recipient type — one of user, group, organization, or externalApplication. |

### Enumerated Values

| Property | Value |
| --- | --- |
| role | [ADMIN, CONSUMER, DATA_SCIENTIST, EDITOR, NO_ROLE, OBSERVER, OWNER, READ_ONLY, READ_WRITE, USER] |
| shareRecipientType | [user, group, organization, externalApplication] |

## GrantAccessControlWithUsername

```
{
  "properties": {
    "role": {
      "description": "The role of the recipient on this entity.",
      "enum": [
        "ADMIN",
        "CONSUMER",
        "DATA_SCIENTIST",
        "EDITOR",
        "NO_ROLE",
        "OBSERVER",
        "OWNER",
        "READ_ONLY",
        "READ_WRITE",
        "USER"
      ],
      "type": "string"
    },
    "shareRecipientType": {
      "description": "Describes the recipient type — one of user, group, organization, or externalApplication.",
      "enum": [
        "user",
        "group",
        "organization",
        "externalApplication"
      ],
      "type": "string"
    },
    "username": {
      "description": "Username of the user to update the access role for.",
      "type": "string"
    }
  },
  "required": [
    "role",
    "shareRecipientType",
    "username"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| role | string | true |  | The role of the recipient on this entity. |
| shareRecipientType | string | true |  | Describes the recipient type — one of user, group, organization, or externalApplication. |
| username | string | true |  | Username of the user to update the access role for. |

### Enumerated Values

| Property | Value |
| --- | --- |
| role | [ADMIN, CONSUMER, DATA_SCIENTIST, EDITOR, NO_ROLE, OBSERVER, OWNER, READ_ONLY, READ_WRITE, USER] |
| shareRecipientType | [user, group, organization, externalApplication] |

## InviteJobNotificationData

```
{
  "properties": {
    "failedInvites": {
      "description": "Failed invites.",
      "items": {
        "description": "Details about why the invite failed.",
        "properties": {
          "email": {
            "description": "The email address of the invited user.",
            "type": "string"
          },
          "errorMessage": {
            "description": "The error message explaining why the invite failed.",
            "type": "string"
          },
          "userId": {
            "description": "The ID of the user.",
            "type": "string"
          }
        },
        "required": [
          "email",
          "errorMessage",
          "userId"
        ],
        "type": "object",
        "x-versionadded": "v2.39"
      },
      "maxItems": 20,
      "type": "array"
    },
    "jobId": {
      "description": "The ID of the invite job.",
      "type": [
        "string",
        "null"
      ]
    },
    "statusId": {
      "description": "The ID of the invite job status.",
      "type": "string",
      "x-versionadded": "v2.40"
    },
    "successfulInvites": {
      "description": "Successful invites.",
      "items": {
        "description": "Details about the successful invite.",
        "properties": {
          "email": {
            "description": "The email address of the invited user.",
            "type": "string"
          },
          "userId": {
            "description": "The ID of the user.",
            "type": "string"
          }
        },
        "required": [
          "email",
          "userId"
        ],
        "type": "object",
        "x-versionadded": "v2.39"
      },
      "maxItems": 20,
      "type": "array"
    }
  },
  "required": [
    "failedInvites",
    "jobId",
    "statusId",
    "successfulInvites"
  ],
  "type": "object",
  "x-versionadded": "v2.39"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| failedInvites | [FailedInviteData] | true | maxItems: 20 | Failed invites. |
| jobId | string,null | true |  | The ID of the invite job. |
| statusId | string | true |  | The ID of the invite job status. |
| successfulInvites | [SuccessfulInviteData] | true | maxItems: 20 | Successful invites. |

## ModerationData

```
{
  "description": "The moderation event information.",
  "properties": {
    "guardName": {
      "description": "Name or label of the guard.",
      "maxLength": 255,
      "type": "string"
    },
    "metricName": {
      "description": "Name or label of the metric.",
      "maxLength": 255,
      "type": "string"
    }
  },
  "required": [
    "guardName",
    "metricName"
  ],
  "type": "object",
  "x-versionadded": "v2.35"
}
```

The moderation event information.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| guardName | string | true | maxLength: 255 | Name or label of the guard. |
| metricName | string | true | maxLength: 255 | Name or label of the metric. |

## NotificationChannel

```
{
  "description": "The notification channel information used to send the notification.",
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "description": "The date of the notification channel creation.",
      "format": "date-time",
      "type": "string"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": [
        "string",
        "null"
      ]
    },
    "id": {
      "description": "The ID of the notification channel.",
      "type": "string"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "name": {
      "description": "The name of the new notification channel.",
      "type": "string"
    },
    "orgId": {
      "description": "The ID of the organization that the notification channel belongs to.",
      "type": [
        "string",
        "null"
      ]
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": [
        "string",
        "null"
      ]
    },
    "uid": {
      "description": "The identifier of the user who created the channel.",
      "type": [
        "string",
        "null"
      ]
    },
    "updatedAt": {
      "description": "The date when the channel was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "validateSsl": {
      "description": "Whether to validate SSL for the notification channel.",
      "type": [
        "boolean",
        "null"
      ]
    }
  },
  "required": [
    "channelType",
    "contentType",
    "createdAt",
    "customHeaders",
    "emailAddress",
    "id",
    "languageCode",
    "name",
    "orgId",
    "payloadUrl",
    "secretToken",
    "uid",
    "updatedAt",
    "validateSsl"
  ],
  "type": "object"
}
```

The notification channel information used to send the notification.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| channelType | string | true |  | The type of the new notification channel. |
| contentType | string,null | true |  | The content type of the messages of the new notification channel. |
| createdAt | string(date-time) | true |  | The date of the notification channel creation. |
| customHeaders | [CustomerHeader] | true | maxItems: 100 | Custom headers and their values to be sent in the new notification channel. |
| emailAddress | string,null | true |  | The email address to be used in the new notification channel. |
| id | string | true |  | The ID of the notification channel. |
| languageCode | string,null | true |  | The preferred language code. |
| name | string | true |  | The name of the new notification channel. |
| orgId | string,null | true |  | The ID of the organization that the notification channel belongs to. |
| payloadUrl | string,null(uri) | true |  | The payload URL of the new notification channel. |
| secretToken | string,null | true |  | Secret token to be used for new notification channel. |
| uid | string,null | true |  | The identifier of the user who created the channel. |
| updatedAt | string,null(date-time) | true |  | The date when the channel was updated. |
| validateSsl | boolean,null | true |  | Whether to validate SSL for the notification channel. |

### Enumerated Values

| Property | Value |
| --- | --- |
| channelType | [Database, Email, InApp, InsightsComputations, MSTeams, Slack, Webhook] |
| contentType | [application/json, application/x-www-form-urlencoded] |
| languageCode | [en, es_419, fr, ja, ko, ptBR] |

## NotificationChannelCreate

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": "string"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": "string"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": "string"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "maxLength": 100,
      "type": "string"
    },
    "orgId": {
      "description": "The id of organization that notification channel belongs to.",
      "type": "string"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": "string"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": "string"
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": "boolean"
    },
    "verificationCode": {
      "description": "Required if the channel type is Email.",
      "type": "string"
    }
  },
  "required": [
    "channelType",
    "name"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| channelType | string | true |  | The type of the new notification channel. |
| contentType | string | false |  | The content type of the messages of the new notification channel. |
| customHeaders | [CustomerHeader] | false | maxItems: 100 | Custom headers and their values to be sent in the new notification channel. |
| emailAddress | string | false |  | The email address to be used in the new notification channel. |
| languageCode | string | false |  | The preferred language code. |
| name | string | true | maxLength: 100 | The name of the new notification channel. |
| orgId | string | false |  | The id of organization that notification channel belongs to. |
| payloadUrl | string(uri) | false |  | The payload URL of the new notification channel. |
| secretToken | string | false |  | Secret token to be used for new notification channel. |
| validateSsl | boolean | false |  | Defines if validate ssl or not in the notification channel. |
| verificationCode | string | false |  | Required if the channel type is Email. |

### Enumerated Values

| Property | Value |
| --- | --- |
| channelType | [Database, Email, InApp, InsightsComputations, MSTeams, Slack, Webhook] |
| contentType | [application/json, application/x-www-form-urlencoded] |
| languageCode | [en, es_419, fr, ja, ko, ptBR] |

## NotificationChannelResponse

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "description": "The date of the notification channel creation.",
      "format": "date-time",
      "type": "string"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": [
        "string",
        "null"
      ]
    },
    "id": {
      "description": "The ID of the notification channel.",
      "type": "string"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "lastNotificationAt": {
      "description": "The timestamp of the last notification sent to the channel.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "name": {
      "description": "The name of the new notification channel.",
      "type": "string"
    },
    "orgId": {
      "description": "The id of organization that notification channel belongs to.",
      "type": [
        "string",
        "null"
      ]
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "policyCount": {
      "description": "The count of policies assigned to the channel.",
      "type": "integer"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": [
        "string",
        "null"
      ]
    },
    "uid": {
      "description": "The identifier of the user who created the channel.",
      "type": [
        "string",
        "null"
      ]
    },
    "updatedAt": {
      "description": "The date when the channel was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": [
        "boolean",
        "null"
      ]
    }
  },
  "required": [
    "channelType",
    "contentType",
    "createdAt",
    "customHeaders",
    "emailAddress",
    "id",
    "languageCode",
    "lastNotificationAt",
    "name",
    "orgId",
    "payloadUrl",
    "policyCount",
    "secretToken",
    "uid",
    "updatedAt",
    "validateSsl"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| channelType | string | true |  | The type of the new notification channel. |
| contentType | string,null | true |  | The content type of the messages of the new notification channel. |
| createdAt | string(date-time) | true |  | The date of the notification channel creation. |
| customHeaders | [CustomerHeader] | true | maxItems: 100 | Custom headers and their values to be sent in the new notification channel. |
| emailAddress | string,null | true |  | The email address to be used in the new notification channel. |
| id | string | true |  | The ID of the notification channel. |
| languageCode | string,null | true |  | The preferred language code. |
| lastNotificationAt | string,null(date-time) | true |  | The timestamp of the last notification sent to the channel. |
| name | string | true |  | The name of the new notification channel. |
| orgId | string,null | true |  | The id of organization that notification channel belongs to. |
| payloadUrl | string,null(uri) | true |  | The payload URL of the new notification channel. |
| policyCount | integer | true |  | The count of policies assigned to the channel. |
| secretToken | string,null | true |  | Secret token to be used for new notification channel. |
| uid | string,null | true |  | The identifier of the user who created the channel. |
| updatedAt | string,null(date-time) | true |  | The date when the channel was updated. |
| validateSsl | boolean,null | true |  | Defines if validate ssl or not in the notification channel. |

### Enumerated Values

| Property | Value |
| --- | --- |
| channelType | [Database, Email, InApp, InsightsComputations, MSTeams, Slack, Webhook] |
| contentType | [application/json, application/x-www-form-urlencoded] |
| languageCode | [en, es_419, fr, ja, ko, ptBR] |

## NotificationChannelTempPolicyTemplateResponse

```
{
  "properties": {
    "id": {
      "description": "The ID of the policy template.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the notification policy template.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity template.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "id",
    "name",
    "relatedEntityType"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| id | string | true |  | The ID of the policy template. |
| name | string | true |  | The name of the notification policy template. |
| relatedEntityType | string | true |  | The type of the related entity template. |

### Enumerated Values

| Property | Value |
| --- | --- |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

## NotificationChannelTemplateCreate

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "DataRobotCustomJob",
        "DataRobotGroup",
        "DataRobotUser",
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "drEntities": {
      "description": "The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the DataRobot entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "maxLength": 100,
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The id of organization that notification channel belongs to.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "verificationCode": {
      "description": "Required if the channel type is Email.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "channelType",
    "name"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| channelType | string | true |  | The type of the new notification channel. |
| contentType | string | false |  | The content type of the messages of the new notification channel. |
| customHeaders | [CustomerHeader] | false | maxItems: 100 | Custom headers and their values to be sent in the new notification channel. |
| drEntities | [DREntity] | false | maxItems: 100minItems: 1 | The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types. |
| emailAddress | string | false |  | The email address to be used in the new notification channel. |
| languageCode | string | false |  | The preferred language code. |
| name | string | true | maxLength: 100 | The name of the new notification channel. |
| orgId | string | false |  | The id of organization that notification channel belongs to. |
| payloadUrl | string(uri) | false |  | The payload URL of the new notification channel. |
| secretToken | string | false |  | Secret token to be used for new notification channel. |
| validateSsl | boolean | false |  | Defines if validate ssl or not in the notification channel. |
| verificationCode | string | false |  | Required if the channel type is Email. |

### Enumerated Values

| Property | Value |
| --- | --- |
| channelType | [DataRobotCustomJob, DataRobotGroup, DataRobotUser, Database, Email, InApp, InsightsComputations, MSTeams, Slack, Webhook] |
| contentType | [application/json, application/x-www-form-urlencoded] |
| languageCode | [en, es_419, fr, ja, ko, ptBR] |

## NotificationChannelTemplateRelatedPoliciesListResponse

```
{
  "properties": {
    "count": {
      "description": "The number of entity policies returned.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "The entity notification policies.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the notification policy.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedEntityId": {
            "description": "The id of related entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedEntityName": {
            "description": "The name of related entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedEntityType": {
            "description": "The type of the related entity.",
            "enum": [
              "deployment",
              "Deployment",
              "DEPLOYMENT",
              "customjob",
              "Customjob",
              "CUSTOMJOB"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name",
          "relatedEntityId",
          "relatedEntityName",
          "relatedEntityType"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "The total number of entity policies that satisfy the query.",
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| count | integer | true |  | The number of entity policies returned. |
| data | [NotificationChannelTemplateRelatedPolicyResponse] | true | maxItems: 1000 | The entity notification policies. |
| next | string,null | true |  | The URL pointing to the next page. |
| previous | string,null | true |  | The URL pointing to the previous page. |
| totalCount | integer | true |  | The total number of entity policies that satisfy the query. |

## NotificationChannelTemplateRelatedPolicyResponse

```
{
  "properties": {
    "id": {
      "description": "The ID of the policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the notification policy.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityId": {
      "description": "The id of related entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityName": {
      "description": "The name of related entity.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "relatedEntityType": {
      "description": "The type of the related entity.",
      "enum": [
        "deployment",
        "Deployment",
        "DEPLOYMENT",
        "customjob",
        "Customjob",
        "CUSTOMJOB"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "id",
    "name",
    "relatedEntityId",
    "relatedEntityName",
    "relatedEntityType"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| id | string | true |  | The ID of the policy. |
| name | string | true |  | The name of the notification policy. |
| relatedEntityId | string | true |  | The id of related entity. |
| relatedEntityName | string | true |  | The name of related entity. |
| relatedEntityType | string | true |  | The type of the related entity. |

### Enumerated Values

| Property | Value |
| --- | --- |
| relatedEntityType | [deployment, Deployment, DEPLOYMENT, customjob, Customjob, CUSTOMJOB] |

## NotificationChannelTemplateRelatedPolicyTemplateListResponse

```
{
  "properties": {
    "count": {
      "description": "The number of entity policies returned.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "The entity notification policy template.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the policy template.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the notification policy template.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "relatedEntityType": {
            "description": "The type of the related entity template.",
            "enum": [
              "deployment",
              "Deployment",
              "DEPLOYMENT",
              "customjob",
              "Customjob",
              "CUSTOMJOB"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name",
          "relatedEntityType"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "The total number of entity policies that satisfy the query.",
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| count | integer | true |  | The number of entity policies returned. |
| data | [NotificationChannelTempPolicyTemplateResponse] | true | maxItems: 1000 | The entity notification policy template. |
| next | string,null | true |  | The URL pointing to the next page. |
| previous | string,null | true |  | The URL pointing to the previous page. |
| totalCount | integer | true |  | The total number of entity policies that satisfy the query. |

## NotificationChannelTemplateResponse

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "DataRobotCustomJob",
        "DataRobotGroup",
        "DataRobotUser",
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "createdAt": {
      "description": "The date of the notification channel creation.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "The user who created the template.",
      "properties": {
        "firstName": {
          "description": "First Name.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "lastName": {
          "description": "Last Name.",
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "username": {
          "description": "Username.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "firstName",
        "lastName",
        "username"
      ],
      "type": "object"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "drEntities": {
      "description": "The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the DataRobot entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "id": {
      "description": "The ID of the notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "lastNotificationAt": {
      "description": "The timestamp of the last notification sent to the channel.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "orgId": {
      "description": "The id of organization that notification channel belongs to.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "policyCount": {
      "description": "The count of policies assigned to the channel.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "policyTemplatesCount": {
      "description": "The count of policy templates assigned to the channel.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "role": {
      "description": "User role on entity.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "uid": {
      "description": "The identifier of the user who created the channel.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "updatedAt": {
      "description": "The date when the channel was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": [
        "boolean",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "channelType",
    "contentType",
    "createdAt",
    "createdBy",
    "customHeaders",
    "emailAddress",
    "id",
    "languageCode",
    "lastNotificationAt",
    "name",
    "orgId",
    "payloadUrl",
    "policyCount",
    "policyTemplatesCount",
    "role",
    "secretToken",
    "uid",
    "updatedAt",
    "validateSsl"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| channelType | string | true |  | The type of the new notification channel. |
| contentType | string,null | true |  | The content type of the messages of the new notification channel. |
| createdAt | string(date-time) | true |  | The date of the notification channel creation. |
| createdBy | ChannelCreatedByResponse | true |  | The user who created the template. |
| customHeaders | [CustomerHeader] | true | maxItems: 100 | Custom headers and their values to be sent in the new notification channel. |
| drEntities | [DREntity] | false | maxItems: 100minItems: 1 | The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types. |
| emailAddress | string,null | true |  | The email address to be used in the new notification channel. |
| id | string | true |  | The ID of the notification channel. |
| languageCode | string,null | true |  | The preferred language code. |
| lastNotificationAt | string,null(date-time) | true |  | The timestamp of the last notification sent to the channel. |
| name | string | true |  | The name of the new notification channel. |
| orgId | string,null | true |  | The id of organization that notification channel belongs to. |
| payloadUrl | string,null(uri) | true |  | The payload URL of the new notification channel. |
| policyCount | integer | true |  | The count of policies assigned to the channel. |
| policyTemplatesCount | integer | true |  | The count of policy templates assigned to the channel. |
| role | string,null | true |  | User role on entity. |
| secretToken | string,null | true |  | Secret token to be used for new notification channel. |
| uid | string,null | true |  | The identifier of the user who created the channel. |
| updatedAt | string,null(date-time) | true |  | The date when the channel was updated. |
| validateSsl | boolean,null | true |  | Defines if validate ssl or not in the notification channel. |

### Enumerated Values

| Property | Value |
| --- | --- |
| channelType | [DataRobotCustomJob, DataRobotGroup, DataRobotUser, Database, Email, InApp, InsightsComputations, MSTeams, Slack, Webhook] |
| contentType | [application/json, application/x-www-form-urlencoded] |
| languageCode | [en, es_419, fr, ja, ko, ptBR] |

## NotificationChannelTemplatesListResponse

```
{
  "properties": {
    "count": {
      "description": "The number of channel templates returned.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "The notification channel templates.",
      "items": {
        "properties": {
          "channelType": {
            "description": "The type of the new notification channel.",
            "enum": [
              "DataRobotCustomJob",
              "DataRobotGroup",
              "DataRobotUser",
              "Database",
              "Email",
              "InApp",
              "InsightsComputations",
              "MSTeams",
              "Slack",
              "Webhook"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "contentType": {
            "description": "The content type of the messages of the new notification channel.",
            "enum": [
              "application/json",
              "application/x-www-form-urlencoded"
            ],
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "createdAt": {
            "description": "The date of the notification channel creation.",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "createdBy": {
            "description": "The user who created the template.",
            "properties": {
              "firstName": {
                "description": "First Name.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "lastName": {
                "description": "Last Name.",
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.33"
              },
              "username": {
                "description": "Username.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "firstName",
              "lastName",
              "username"
            ],
            "type": "object"
          },
          "customHeaders": {
            "description": "Custom headers and their values to be sent in the new notification channel.",
            "items": {
              "properties": {
                "name": {
                  "description": "The name of the header.",
                  "type": "string"
                },
                "value": {
                  "description": "The value of the header.",
                  "type": "string"
                }
              },
              "required": [
                "name",
                "value"
              ],
              "type": "object"
            },
            "maxItems": 100,
            "type": "array",
            "x-versionadded": "v2.33"
          },
          "drEntities": {
            "description": "The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.",
            "items": {
              "properties": {
                "id": {
                  "description": "The ID of the DataRobot entity.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                },
                "name": {
                  "description": "The name of the entity.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                }
              },
              "required": [
                "id",
                "name"
              ],
              "type": "object"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array",
            "x-versionadded": "v2.33"
          },
          "emailAddress": {
            "description": "The email address to be used in the new notification channel.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "id": {
            "description": "The ID of the notification channel.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "languageCode": {
            "description": "The preferred language code.",
            "enum": [
              "en",
              "es_419",
              "fr",
              "ja",
              "ko",
              "ptBR"
            ],
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "lastNotificationAt": {
            "description": "The timestamp of the last notification sent to the channel.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the new notification channel.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "orgId": {
            "description": "The id of organization that notification channel belongs to.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "payloadUrl": {
            "description": "The payload URL of the new notification channel.",
            "format": "uri",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "policyCount": {
            "description": "The count of policies assigned to the channel.",
            "type": "integer",
            "x-versionadded": "v2.33"
          },
          "policyTemplatesCount": {
            "description": "The count of policy templates assigned to the channel.",
            "type": "integer",
            "x-versionadded": "v2.33"
          },
          "role": {
            "description": "User role on entity.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "secretToken": {
            "description": "Secret token to be used for new notification channel.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "uid": {
            "description": "The identifier of the user who created the channel.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "updatedAt": {
            "description": "The date when the channel was updated.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "validateSsl": {
            "description": "Defines if  validate ssl or not in the notification channel.",
            "type": [
              "boolean",
              "null"
            ],
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "channelType",
          "contentType",
          "createdAt",
          "createdBy",
          "customHeaders",
          "emailAddress",
          "id",
          "languageCode",
          "lastNotificationAt",
          "name",
          "orgId",
          "payloadUrl",
          "policyCount",
          "policyTemplatesCount",
          "role",
          "secretToken",
          "uid",
          "updatedAt",
          "validateSsl"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "The total number of channel templates that satisfy the query.",
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| count | integer | true |  | The number of channel templates returned. |
| data | [NotificationChannelTemplateResponse] | true | maxItems: 1000 | The notification channel templates. |
| next | string,null | true |  | The URL pointing to the next page. |
| previous | string,null | true |  | The URL pointing to the previous page. |
| totalCount | integer | true |  | The total number of channel templates that satisfy the query. |

## NotificationChannelUpdate

```
{
  "properties": {
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": "string"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": "string"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": "string"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "maxLength": 100,
      "type": "string"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": "string"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": "string"
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": "boolean"
    },
    "verificationCode": {
      "description": "Required if the channel type is Email.",
      "type": "string"
    }
  },
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| contentType | string | false |  | The content type of the messages of the new notification channel. |
| customHeaders | [CustomerHeader] | false | maxItems: 100 | Custom headers and their values to be sent in the new notification channel. |
| emailAddress | string | false |  | The email address to be used in the new notification channel. |
| languageCode | string | false |  | The preferred language code. |
| name | string | false | maxLength: 100 | The name of the new notification channel. |
| payloadUrl | string(uri) | false |  | The payload URL of the new notification channel. |
| secretToken | string | false |  | Secret token to be used for new notification channel. |
| validateSsl | boolean | false |  | Defines if validate ssl or not in the notification channel. |
| verificationCode | string | false |  | Required if the channel type is Email. |

### Enumerated Values

| Property | Value |
| --- | --- |
| contentType | [application/json, application/x-www-form-urlencoded] |
| languageCode | [en, es_419, fr, ja, ko, ptBR] |

## NotificationChannelWithDREntityUpdate

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "DataRobotCustomJob",
        "DataRobotGroup",
        "DataRobotUser",
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "drEntities": {
      "description": "The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the DataRobot entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the entity.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "languageCode": {
      "description": "The preferred language code.",
      "enum": [
        "en",
        "es_419",
        "fr",
        "ja",
        "ko",
        "ptBR"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "maxLength": 100,
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "validateSsl": {
      "description": "Defines if  validate ssl or not in the notification channel.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "verificationCode": {
      "description": "Required if the channel type is Email.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| channelType | string | false |  | The type of the new notification channel. |
| contentType | string | false |  | The content type of the messages of the new notification channel. |
| customHeaders | [CustomerHeader] | false | maxItems: 100 | Custom headers and their values to be sent in the new notification channel. |
| drEntities | [DREntity] | false | maxItems: 100minItems: 1 | The IDs of the DataRobot Users, Group or Custom Job associated with the DataRobotUser, DataRobotGroup or DataRobotCustomJob channel types. |
| emailAddress | string | false |  | The email address to be used in the new notification channel. |
| languageCode | string | false |  | The preferred language code. |
| name | string | false | maxLength: 100 | The name of the new notification channel. |
| payloadUrl | string(uri) | false |  | The payload URL of the new notification channel. |
| secretToken | string | false |  | Secret token to be used for new notification channel. |
| validateSsl | boolean | false |  | Defines if validate ssl or not in the notification channel. |
| verificationCode | string | false |  | Required if the channel type is Email. |

### Enumerated Values

| Property | Value |
| --- | --- |
| channelType | [DataRobotCustomJob, DataRobotGroup, DataRobotUser, Database, Email, InApp, InsightsComputations, MSTeams, Slack, Webhook] |
| contentType | [application/json, application/x-www-form-urlencoded] |
| languageCode | [en, es_419, fr, ja, ko, ptBR] |

## NotificationChannelsListResponse

```
{
  "properties": {
    "count": {
      "description": "The number of channels returned.",
      "type": "integer"
    },
    "data": {
      "description": "The notification channels.",
      "items": {
        "properties": {
          "channelType": {
            "description": "The type of the new notification channel.",
            "enum": [
              "Database",
              "Email",
              "InApp",
              "InsightsComputations",
              "MSTeams",
              "Slack",
              "Webhook"
            ],
            "type": "string"
          },
          "contentType": {
            "description": "The content type of the messages of the new notification channel.",
            "enum": [
              "application/json",
              "application/x-www-form-urlencoded"
            ],
            "type": [
              "string",
              "null"
            ]
          },
          "createdAt": {
            "description": "The date of the notification channel creation.",
            "format": "date-time",
            "type": "string"
          },
          "customHeaders": {
            "description": "Custom headers and their values to be sent in the new notification channel.",
            "items": {
              "properties": {
                "name": {
                  "description": "The name of the header.",
                  "type": "string"
                },
                "value": {
                  "description": "The value of the header.",
                  "type": "string"
                }
              },
              "required": [
                "name",
                "value"
              ],
              "type": "object"
            },
            "maxItems": 100,
            "type": "array"
          },
          "emailAddress": {
            "description": "The email address to be used in the new notification channel.",
            "type": [
              "string",
              "null"
            ]
          },
          "id": {
            "description": "The ID of the notification channel.",
            "type": "string"
          },
          "languageCode": {
            "description": "The preferred language code.",
            "enum": [
              "en",
              "es_419",
              "fr",
              "ja",
              "ko",
              "ptBR"
            ],
            "type": [
              "string",
              "null"
            ]
          },
          "lastNotificationAt": {
            "description": "The timestamp of the last notification sent to the channel.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "name": {
            "description": "The name of the new notification channel.",
            "type": "string"
          },
          "orgId": {
            "description": "The id of organization that notification channel belongs to.",
            "type": [
              "string",
              "null"
            ]
          },
          "payloadUrl": {
            "description": "The payload URL of the new notification channel.",
            "format": "uri",
            "type": [
              "string",
              "null"
            ]
          },
          "policyCount": {
            "description": "The count of policies assigned to the channel.",
            "type": "integer"
          },
          "secretToken": {
            "description": "Secret token to be used for new notification channel.",
            "type": [
              "string",
              "null"
            ]
          },
          "uid": {
            "description": "The identifier of the user who created the channel.",
            "type": [
              "string",
              "null"
            ]
          },
          "updatedAt": {
            "description": "The date when the channel was updated.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "validateSsl": {
            "description": "Defines if  validate ssl or not in the notification channel.",
            "type": [
              "boolean",
              "null"
            ]
          }
        },
        "required": [
          "channelType",
          "contentType",
          "createdAt",
          "customHeaders",
          "emailAddress",
          "id",
          "languageCode",
          "lastNotificationAt",
          "name",
          "orgId",
          "payloadUrl",
          "policyCount",
          "secretToken",
          "uid",
          "updatedAt",
          "validateSsl"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ]
    },
    "totalCount": {
      "description": "The total number of channels that satisfy the query.",
      "type": "integer"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| count | integer | true |  | The number of channels returned. |
| data | [NotificationChannelResponse] | true | maxItems: 1000 | The notification channels. |
| next | string,null | true |  | The URL pointing to the next page. |
| previous | string,null | true |  | The URL pointing to the previous page. |
| totalCount | integer | true |  | The total number of channels that satisfy the query. |

## NotificationEmailChannelVerification

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "type": "string"
    },
    "emailAddress": {
      "description": "The email address of the recipient.",
      "type": "string"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "maxLength": 100,
      "type": "string"
    },
    "orgId": {
      "description": "The ID of the organization that the notification channel belongs to.",
      "type": "string"
    }
  },
  "required": [
    "channelType",
    "emailAddress",
    "name"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| channelType | string | true |  | The type of the new notification channel. |
| emailAddress | string | true |  | The email address of the recipient. |
| name | string | true | maxLength: 100 | The name of the new notification channel. |
| orgId | string | false |  | The ID of the organization that the notification channel belongs to. |

## NotificationEmailChannelVerificationResponse

```
{
  "properties": {
    "notificationId": {
      "description": "The response body is the JSON object with notification_id in it.",
      "type": "string"
    }
  },
  "required": [
    "notificationId"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| notificationId | string | true |  | The response body is the JSON object with notification_id in it. |

## NotificationEmailChannelVerificationStatus

```
{
  "properties": {
    "emailAddress": {
      "description": "The email address of the recipient.",
      "type": "string"
    },
    "verificationCode": {
      "description": "The user-entered verification code.",
      "type": "string"
    }
  },
  "required": [
    "emailAddress",
    "verificationCode"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| emailAddress | string | true |  | The email address of the recipient. |
| verificationCode | string | true |  | The user-entered verification code. |

## NotificationEmailChannelVerificationStatusResponse

```
{
  "properties": {
    "status": {
      "description": "The status shows whether the admin entered the correct 6-digit verification code.",
      "type": "boolean"
    }
  },
  "required": [
    "status"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| status | boolean | true |  | The status shows whether the admin entered the correct 6-digit verification code. |

## NotificationEventListResponse

```
{
  "properties": {
    "eventGroups": {
      "description": "The selectable event groups.",
      "items": {
        "properties": {
          "events": {
            "description": "The event types belonging to the group.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "id": {
            "description": "The group ID.",
            "type": "string"
          },
          "label": {
            "description": "The group name for display.",
            "type": "string"
          },
          "requireMaxFrequency": {
            "description": "Indicates if a group requires max frequency setting.",
            "type": "boolean"
          }
        },
        "required": [
          "events",
          "id",
          "label",
          "requireMaxFrequency"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "events": {
      "description": "The selectable individual events.",
      "items": {
        "properties": {
          "id": {
            "description": "The event type as an ID.",
            "type": "string"
          },
          "label": {
            "description": "The event type for display.",
            "type": "string"
          },
          "requireMaxFrequency": {
            "description": "Indicates if an event requires max frequency setting.",
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "label",
          "requireMaxFrequency"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "eventGroups",
    "events"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| eventGroups | [EventGroupResponse] | true |  | The selectable event groups. |
| events | [EventResponse] | true |  | The selectable individual events. |

## NotificationLog

```
{
  "description": "The notification log record.",
  "properties": {
    "channelId": {
      "description": "The ID of the channel that was used to send the notification.",
      "type": "string"
    },
    "channelScope": {
      "description": "The scope of the channel.",
      "enum": [
        "organization",
        "Organization",
        "ORGANIZATION",
        "entity",
        "Entity",
        "ENTITY",
        "template",
        "Template",
        "TEMPLATE"
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "emailSubject": {
      "description": "The email subject of the notification.",
      "type": [
        "string",
        "null"
      ]
    },
    "id": {
      "description": "The ID of the notification log.",
      "type": "string"
    },
    "parentNotificationId": {
      "description": "The ID of the parent notification.",
      "type": [
        "string",
        "null"
      ]
    },
    "policyId": {
      "description": "The ID of the policy that was used to send the notification.",
      "type": "string"
    },
    "request": {
      "description": "The request that was sent in the notification.",
      "type": [
        "string",
        "null"
      ]
    },
    "response": {
      "description": "The response that was received after sending the notification.",
      "type": [
        "string",
        "null"
      ]
    },
    "retryCount": {
      "description": "The number of attempts to send the notification.",
      "type": [
        "integer",
        "null"
      ]
    },
    "status": {
      "description": "The status of the notification.",
      "type": "string"
    },
    "timestamp": {
      "description": "The date when the notification was sent.",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "channelId",
    "channelScope",
    "emailSubject",
    "id",
    "parentNotificationId",
    "policyId",
    "request",
    "response",
    "retryCount",
    "status",
    "timestamp"
  ],
  "type": "object"
}
```

The notification log record.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| channelId | string | true |  | The ID of the channel that was used to send the notification. |
| channelScope | string,null | true |  | The scope of the channel. |
| emailSubject | string,null | true |  | The email subject of the notification. |
| id | string | true |  | The ID of the notification log. |
| parentNotificationId | string,null | true |  | The ID of the parent notification. |
| policyId | string | true |  | The ID of the policy that was used to send the notification. |
| request | string,null | true |  | The request that was sent in the notification. |
| response | string,null | true |  | The response that was received after sending the notification. |
| retryCount | integer,null | true |  | The number of attempts to send the notification. |
| status | string | true |  | The status of the notification. |
| timestamp | string(date-time) | true |  | The date when the notification was sent. |

### Enumerated Values

| Property | Value |
| --- | --- |
| channelScope | [organization, Organization, ORGANIZATION, entity, Entity, ENTITY, template, Template, TEMPLATE] |

## NotificationLogListDataResponse

```
{
  "properties": {
    "channelId": {
      "description": "The ID of the channel that was used to send the notification.",
      "type": "string"
    },
    "channelScope": {
      "description": "The scope of the channel.",
      "enum": [
        "organization",
        "Organization",
        "ORGANIZATION",
        "entity",
        "Entity",
        "ENTITY",
        "template",
        "Template",
        "TEMPLATE"
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "emailSubject": {
      "description": "The email subject.",
      "type": "string"
    },
    "id": {
      "description": "The ID of the notification log.",
      "type": "string"
    },
    "parentNotificationId": {
      "description": "The ID of the parent notification",
      "type": [
        "string",
        "null"
      ]
    },
    "policyId": {
      "description": "The ID of the policy that was used to send the notification.",
      "type": "string"
    },
    "request": {
      "description": "The request that was sent in the notification.",
      "properties": {
        "body": {
          "description": "The body of the request.",
          "type": "string"
        },
        "headers": {
          "description": "The headers of the request.",
          "type": "string"
        },
        "url": {
          "description": "The URL of the request.",
          "format": "uri",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "body",
        "headers",
        "url"
      ],
      "type": "object"
    },
    "response": {
      "description": "The response that was received after sending the notification.",
      "properties": {
        "body": {
          "description": "The body of the response.",
          "type": "string"
        },
        "duration": {
          "description": "The duration.",
          "type": "integer"
        },
        "headers": {
          "description": "The headers of the response.",
          "type": "string"
        },
        "statusCode": {
          "description": "The status code of the response.",
          "type": "string"
        }
      },
      "required": [
        "body",
        "duration",
        "headers",
        "statusCode"
      ],
      "type": "object"
    },
    "retryCount": {
      "description": "The count of retries while sending the notification.",
      "type": "integer"
    },
    "status": {
      "description": "The status of the notification.",
      "type": [
        "string",
        "null"
      ]
    },
    "timestamp": {
      "description": "The date and time when the notification was sent.",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "channelId",
    "channelScope",
    "emailSubject",
    "id",
    "parentNotificationId",
    "policyId",
    "request",
    "response",
    "retryCount",
    "status",
    "timestamp"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| channelId | string | true |  | The ID of the channel that was used to send the notification. |
| channelScope | string,null | true |  | The scope of the channel. |
| emailSubject | string | true |  | The email subject. |
| id | string | true |  | The ID of the notification log. |
| parentNotificationId | string,null | true |  | The ID of the parent notification |
| policyId | string | true |  | The ID of the policy that was used to send the notification. |
| request | RequestNotification | true |  | The request that was sent in the notification. |
| response | ResponseNotification | true |  | The response that was received after sending the notification. |
| retryCount | integer | true |  | The count of retries while sending the notification. |
| status | string,null | true |  | The status of the notification. |
| timestamp | string(date-time) | true |  | The date and time when the notification was sent. |

### Enumerated Values

| Property | Value |
| --- | --- |
| channelScope | [organization, Organization, ORGANIZATION, entity, Entity, ENTITY, template, Template, TEMPLATE] |

## NotificationLogListResponse

```
{
  "properties": {
    "count": {
      "description": "The number of items returned on this page.",
      "type": "integer"
    },
    "data": {
      "description": "The array of notification logs.",
      "items": {
        "properties": {
          "channelId": {
            "description": "The ID of the channel that was used to send the notification.",
            "type": "string"
          },
          "channelScope": {
            "description": "The scope of the channel.",
            "enum": [
              "organization",
              "Organization",
              "ORGANIZATION",
              "entity",
              "Entity",
              "ENTITY",
              "template",
              "Template",
              "TEMPLATE"
            ],
            "type": [
              "string",
              "null"
            ]
          },
          "emailSubject": {
            "description": "The email subject.",
            "type": "string"
          },
          "id": {
            "description": "The ID of the notification log.",
            "type": "string"
          },
          "parentNotificationId": {
            "description": "The ID of the parent notification",
            "type": [
              "string",
              "null"
            ]
          },
          "policyId": {
            "description": "The ID of the policy that was used to send the notification.",
            "type": "string"
          },
          "request": {
            "description": "The request that was sent in the notification.",
            "properties": {
              "body": {
                "description": "The body of the request.",
                "type": "string"
              },
              "headers": {
                "description": "The headers of the request.",
                "type": "string"
              },
              "url": {
                "description": "The URL of the request.",
                "format": "uri",
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "body",
              "headers",
              "url"
            ],
            "type": "object"
          },
          "response": {
            "description": "The response that was received after sending the notification.",
            "properties": {
              "body": {
                "description": "The body of the response.",
                "type": "string"
              },
              "duration": {
                "description": "The duration.",
                "type": "integer"
              },
              "headers": {
                "description": "The headers of the response.",
                "type": "string"
              },
              "statusCode": {
                "description": "The status code of the response.",
                "type": "string"
              }
            },
            "required": [
              "body",
              "duration",
              "headers",
              "statusCode"
            ],
            "type": "object"
          },
          "retryCount": {
            "description": "The count of retries while sending the notification.",
            "type": "integer"
          },
          "status": {
            "description": "The status of the notification.",
            "type": [
              "string",
              "null"
            ]
          },
          "timestamp": {
            "description": "The date and time when the notification was sent.",
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "channelId",
          "channelScope",
          "emailSubject",
          "id",
          "parentNotificationId",
          "policyId",
          "request",
          "response",
          "retryCount",
          "status",
          "timestamp"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "next": {
      "description": "The URL of the next page (if null, there is no next page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL of the previous page (if null, there is no previous page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "totalCount": {
      "description": "The total number of notifications.",
      "type": "integer"
    }
  },
  "required": [
    "data",
    "next",
    "previous"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| count | integer | false |  | The number of items returned on this page. |
| data | [NotificationLogListDataResponse] | true |  | The array of notification logs. |
| next | string,null(uri) | true |  | The URL of the next page (if null, there is no next page). |
| previous | string,null(uri) | true |  | The URL of the previous page (if null, there is no previous page). |
| totalCount | integer | false |  | The total number of notifications. |

## NotificationPoliciesListResponse

```
{
  "properties": {
    "count": {
      "description": "The number of policies returned.",
      "type": "integer"
    },
    "data": {
      "description": "The notification policies.",
      "items": {
        "properties": {
          "active": {
            "description": "Defines if the notification policy is active or not.",
            "type": "boolean"
          },
          "channel": {
            "description": "The notification channel information used to send the notification.",
            "properties": {
              "channelType": {
                "description": "The type of the new notification channel.",
                "enum": [
                  "Database",
                  "Email",
                  "InApp",
                  "InsightsComputations",
                  "MSTeams",
                  "Slack",
                  "Webhook"
                ],
                "type": "string"
              },
              "contentType": {
                "description": "The content type of the messages of the new notification channel.",
                "enum": [
                  "application/json",
                  "application/x-www-form-urlencoded"
                ],
                "type": [
                  "string",
                  "null"
                ]
              },
              "createdAt": {
                "description": "The date of the notification channel creation.",
                "format": "date-time",
                "type": "string"
              },
              "customHeaders": {
                "description": "Custom headers and their values to be sent in the new notification channel.",
                "items": {
                  "properties": {
                    "name": {
                      "description": "The name of the header.",
                      "type": "string"
                    },
                    "value": {
                      "description": "The value of the header.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "name",
                    "value"
                  ],
                  "type": "object"
                },
                "maxItems": 100,
                "type": "array"
              },
              "emailAddress": {
                "description": "The email address to be used in the new notification channel.",
                "type": [
                  "string",
                  "null"
                ]
              },
              "id": {
                "description": "The ID of the notification channel.",
                "type": "string"
              },
              "languageCode": {
                "description": "The preferred language code.",
                "enum": [
                  "en",
                  "es_419",
                  "fr",
                  "ja",
                  "ko",
                  "ptBR"
                ],
                "type": [
                  "string",
                  "null"
                ]
              },
              "name": {
                "description": "The name of the new notification channel.",
                "type": "string"
              },
              "orgId": {
                "description": "The ID of the organization that the notification channel belongs to.",
                "type": [
                  "string",
                  "null"
                ]
              },
              "payloadUrl": {
                "description": "The payload URL of the new notification channel.",
                "format": "uri",
                "type": [
                  "string",
                  "null"
                ]
              },
              "secretToken": {
                "description": "Secret token to be used for new notification channel.",
                "type": [
                  "string",
                  "null"
                ]
              },
              "uid": {
                "description": "The identifier of the user who created the channel.",
                "type": [
                  "string",
                  "null"
                ]
              },
              "updatedAt": {
                "description": "The date when the channel was updated.",
                "format": "date-time",
                "type": [
                  "string",
                  "null"
                ]
              },
              "validateSsl": {
                "description": "Whether to validate SSL for the notification channel.",
                "type": [
                  "boolean",
                  "null"
                ]
              }
            },
            "required": [
              "channelType",
              "contentType",
              "createdAt",
              "customHeaders",
              "emailAddress",
              "id",
              "languageCode",
              "name",
              "orgId",
              "payloadUrl",
              "secretToken",
              "uid",
              "updatedAt",
              "validateSsl"
            ],
            "type": "object"
          },
          "channelId": {
            "description": "The ID of the notification channel to be used to send the notification.",
            "type": "string"
          },
          "created": {
            "description": "The date when the policy was created.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "eventGroup": {
            "description": "The group of the event that triggers the notification.",
            "properties": {
              "events": {
                "description": "The events included in this group.",
                "items": {
                  "description": "The type of the event that triggers the notification.",
                  "properties": {
                    "id": {
                      "description": "The ID of the event type.",
                      "type": "string"
                    },
                    "label": {
                      "description": "The display name of the event type.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "label"
                  ],
                  "type": "object"
                },
                "maxItems": 1000,
                "type": "array"
              },
              "id": {
                "description": "The ID of the event group.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event group.",
                "type": "string"
              }
            },
            "required": [
              "events",
              "id",
              "label"
            ],
            "type": "object"
          },
          "eventType": {
            "description": "The type of the event that triggers the notification.",
            "properties": {
              "id": {
                "description": "The ID of the event type.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event type.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "label"
            ],
            "type": "object"
          },
          "id": {
            "description": "The ID of the policy.",
            "type": "string"
          },
          "lastTriggered": {
            "description": "The date when the last notification with the policy was triggered.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "name": {
            "description": "The name of the notification policy.",
            "type": "string"
          },
          "orgId": {
            "description": "The ID of the organization that owns the notification policy.",
            "type": [
              "string",
              "null"
            ]
          },
          "uid": {
            "description": "The identifier of the user who created the policy.",
            "type": "string"
          },
          "updatedAt": {
            "description": "The date when the policy was updated.",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "active",
          "channel",
          "channelId",
          "created",
          "eventGroup",
          "eventType",
          "id",
          "lastTriggered",
          "name",
          "orgId",
          "uid",
          "updatedAt"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ]
    },
    "totalCount": {
      "description": "The total number of policies that satisfy the query.",
      "type": "integer"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| count | integer | true |  | The number of policies returned. |
| data | [NotificationPolicyResponse] | true | maxItems: 1000 | The notification policies. |
| next | string,null | true |  | The URL pointing to the next page. |
| previous | string,null | true |  | The URL pointing to the previous page. |
| totalCount | integer | true |  | The total number of policies that satisfy the query. |

## NotificationPolicyCreate

```
{
  "properties": {
    "active": {
      "description": "Whether the notification policy is active or not.",
      "type": "boolean"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "enum": [
        "secure_config.all",
        "dataset.all",
        "file.all",
        "comment.all",
        "invite_job.all",
        "deployment_prediction_explanations_computation.all",
        "model_deployments.critical_health",
        "model_deployments.critical_frequent_health_change",
        "model_deployments.frequent_health_change",
        "model_deployments.health",
        "model_deployments.retraining_policy",
        "inference_endpoints.health",
        "model_deployments.management_agent",
        "model_deployments.management_agent_health",
        "prediction_request.all",
        "challenger_management.all",
        "challenger_replay.all",
        "model_deployments.all",
        "project.all",
        "perma_delete_project.all",
        "users_delete.all",
        "applications.all",
        "model_version.stage_transitions",
        "model_version.all",
        "use_case.all",
        "batch_predictions.all",
        "change_requests.all",
        "custom_job_run.all",
        "custom_job_run.unsuccessful",
        "insights_computation.all",
        "notebook_schedule.all",
        "monitoring.all"
      ],
      "type": "string"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "enum": [
        "secure_config.created",
        "secure_config.deleted",
        "secure_config.shared",
        "dataset.created",
        "dataset.registered",
        "dataset.deleted",
        "datasets.deleted",
        "datasetrelationship.created",
        "dataset.shared",
        "datasets.shared",
        "file.created",
        "file.registered",
        "file.deleted",
        "file.shared",
        "comment.created",
        "comment.updated",
        "invite_job.completed",
        "misc.asset_access_request",
        "misc.webhook_connection_test",
        "misc.webhook_resend",
        "misc.email_verification",
        "monitoring.spooler_channel_base",
        "monitoring.spooler_channel_red",
        "monitoring.spooler_channel_green",
        "monitoring.external_model_nan_predictions",
        "management.deploymentInfo",
        "model_deployments.None",
        "model_deployments.deployment_sharing",
        "model_deployments.model_replacement",
        "prediction_request.None",
        "prediction_request.failed",
        "model_deployments.humility_rule",
        "model_deployments.model_replacement_lifecycle",
        "model_deployments.model_replacement_started",
        "model_deployments.model_replacement_succeeded",
        "model_deployments.model_replacement_failed",
        "model_deployments.model_replacement_validation_warning",
        "model_deployments.deployment_creation",
        "model_deployments.deployment_deletion",
        "model_deployments.service_health_yellow_from_green",
        "model_deployments.service_health_yellow_from_red",
        "model_deployments.service_health_red",
        "model_deployments.data_drift_yellow_from_green",
        "model_deployments.data_drift_yellow_from_red",
        "model_deployments.data_drift_red",
        "model_deployments.accuracy_yellow_from_green",
        "model_deployments.accuracy_yellow_from_red",
        "model_deployments.accuracy_red",
        "model_deployments.health.fairness_health.green_to_yellow",
        "model_deployments.health.fairness_health.red_to_yellow",
        "model_deployments.health.fairness_health.red",
        "model_deployments.health.custom_metrics_health.green_to_yellow",
        "model_deployments.health.custom_metrics_health.red_to_yellow",
        "model_deployments.health.custom_metrics_health.red",
        "model_deployments.health.base.green",
        "model_deployments.service_health_green",
        "model_deployments.data_drift_green",
        "model_deployments.accuracy_green",
        "model_deployments.health.fairness_health.green",
        "model_deployments.health.custom_metrics_health.green",
        "model_deployments.retraining_policy_run_started",
        "model_deployments.retraining_policy_run_succeeded",
        "model_deployments.retraining_policy_run_failed",
        "model_deployments.challenger_scoring_success",
        "model_deployments.challenger_scoring_data_warning",
        "model_deployments.challenger_scoring_failure",
        "model_deployments.challenger_scoring_started",
        "model_deployments.challenger_model_validation_warning",
        "model_deployments.challenger_model_created",
        "model_deployments.challenger_model_deleted",
        "model_deployments.actuals_upload_failed",
        "model_deployments.actuals_upload_warning",
        "model_deployments.training_data_baseline_calculation_started",
        "model_deployments.training_data_baseline_calculation_completed",
        "model_deployments.training_data_baseline_failed",
        "model_deployments.custom_model_deployment_creation_started",
        "model_deployments.custom_model_deployment_creation_completed",
        "model_deployments.custom_model_deployment_creation_failed",
        "model_deployments.custom_model_deployment_secure_config_failure",
        "model_deployments.deployment_prediction_explanations_preview_job_submitted",
        "model_deployments.deployment_prediction_explanations_preview_job_completed",
        "model_deployments.deployment_prediction_explanations_preview_job_failed",
        "model_deployments.custom_model_deployment_activated",
        "model_deployments.custom_model_deployment_activation_failed",
        "model_deployments.custom_model_deployment_deactivated",
        "model_deployments.custom_model_deployment_deactivation_failed",
        "model_deployments.prediction_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_warning",
        "model_deployments.actuals_processing_rate_limit_reached",
        "model_deployments.actuals_processing_rate_limit_warning",
        "model_deployments.deployment_monitoring_data_cleared",
        "model_deployments.deployment_launch_started",
        "model_deployments.deployment_launch_succeeded",
        "model_deployments.deployment_launch_failed",
        "model_deployments.deployment_shutdown_started",
        "model_deployments.deployment_shutdown_succeeded",
        "model_deployments.deployment_shutdown_failed",
        "model_deployments.endpoint_update_started",
        "model_deployments.endpoint_update_succeeded",
        "model_deployments.endpoint_update_failed",
        "model_deployments.management_agent_service_health_green",
        "model_deployments.management_agent_service_health_yellow",
        "model_deployments.management_agent_service_health_red",
        "model_deployments.management_agent_service_health_unknown",
        "model_deployments.predictions_missing_association_id",
        "model_deployments.prediction_result_rows_cleand_up",
        "model_deployments.batch_deleted",
        "model_deployments.batch_creation_limit_reached",
        "model_deployments.batch_creation_limit_exceeded",
        "model_deployments.batch_not_found",
        "model_deployments.predictions_encountered_for_locked_batch",
        "model_deployments.predictions_encountered_for_deleted_batch",
        "model_deployments.scheduled_report_generated",
        "model_deployments.predictions_timeliness_health_red",
        "model_deployments.actuals_timeliness_health_red",
        "model_deployments.service_health_still_red",
        "model_deployments.data_drift_still_red",
        "model_deployments.accuracy_still_red",
        "model_deployments.health.fairness_health.still_red",
        "model_deployments.health.custom_metrics_health.still_red",
        "model_deployments.predictions_timeliness_health_still_red",
        "model_deployments.actuals_timeliness_health_still_red",
        "model_deployments.service_health_still_yellow",
        "model_deployments.data_drift_still_yellow",
        "model_deployments.accuracy_still_yellow",
        "model_deployments.health.fairness_health.still_yellow",
        "model_deployments.health.custom_metrics_health.still_yellow",
        "model_deployments.prediction_payload_parsing_failure",
        "model_deployments.deployment_inference_server_creation_started",
        "model_deployments.deployment_inference_server_creation_failed",
        "model_deployments.deployment_inference_server_creation_completed",
        "model_deployments.deployment_inference_server_deletion",
        "model_deployments.deployment_inference_server_idle_stopped",
        "model_deployments.deployment_inference_server_maintenance_started",
        "entity_notification_policy_template.shared",
        "notification_channel_template.shared",
        "project.created",
        "project.deleted",
        "project.shared",
        "autopilot.complete",
        "autopilot.started",
        "autostart.failure",
        "perma_delete_project.success",
        "perma_delete_project.failure",
        "users_delete.preview_started",
        "users_delete.preview_completed",
        "users_delete.preview_failed",
        "users_delete.started",
        "users_delete.completed",
        "users_delete.failed",
        "application.created",
        "application.shared",
        "model_version.added",
        "model_version.stage_transition_from_registered_to_development",
        "model_version.stage_transition_from_registered_to_staging",
        "model_version.stage_transition_from_registered_to_production",
        "model_version.stage_transition_from_registered_to_archived",
        "model_version.stage_transition_from_development_to_registered",
        "model_version.stage_transition_from_development_to_staging",
        "model_version.stage_transition_from_development_to_production",
        "model_version.stage_transition_from_development_to_archived",
        "model_version.stage_transition_from_staging_to_registered",
        "model_version.stage_transition_from_staging_to_development",
        "model_version.stage_transition_from_staging_to_production",
        "model_version.stage_transition_from_staging_to_archived",
        "model_version.stage_transition_from_production_to_registered",
        "model_version.stage_transition_from_production_to_development",
        "model_version.stage_transition_from_production_to_staging",
        "model_version.stage_transition_from_production_to_archived",
        "model_version.stage_transition_from_archived_to_registered",
        "model_version.stage_transition_from_archived_to_development",
        "model_version.stage_transition_from_archived_to_production",
        "model_version.stage_transition_from_archived_to_staging",
        "use_case.shared",
        "batch_predictions.success",
        "batch_predictions.failed",
        "batch_predictions.scheduler.auto_disabled",
        "change_request.cancelled",
        "change_request.created",
        "change_request.deployment_approval_requested",
        "change_request.resolved",
        "change_request.proposed_changes_updated",
        "change_request.pending",
        "change_request.commenting_review_added",
        "change_request.approving_review_added",
        "change_request.changes_requesting_review_added",
        "custom_job_run.success",
        "custom_job_run.failed",
        "custom_job_run.interrupted",
        "custom_job_run.cancelled",
        "prediction_explanations_computation.None",
        "prediction_explanations_computation.prediction_explanations_preview_job_submitted",
        "prediction_explanations_computation.prediction_explanations_preview_job_completed",
        "prediction_explanations_computation.prediction_explanations_preview_job_failed",
        "monitoring.rate_limit_enforced",
        "notebook_schedule.created",
        "notebook_schedule.failure",
        "notebook_schedule.completed",
        "abstract",
        "moderation.metric.creation_error",
        "moderation.metric.reporting_error",
        "moderation.model.moderation_started",
        "moderation.model.moderation_completed",
        "moderation.model.pre_score_phase_started",
        "moderation.model.pre_score_phase_completed",
        "moderation.model.post_score_phase_started",
        "moderation.model.post_score_phase_completed",
        "moderation.model.config_error",
        "moderation.model.runtime_error",
        "moderation.model.scoring_started",
        "moderation.model.scoring_completed",
        "moderation.model.scoring_error"
      ],
      "type": "string"
    },
    "name": {
      "description": "The name of the new notification policy.",
      "maxLength": 100,
      "type": "string"
    },
    "orgId": {
      "description": "The ID of the organization that owns the notification policy.",
      "type": "string"
    }
  },
  "required": [
    "channelId",
    "name"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| active | boolean | false |  | Whether the notification policy is active or not. |
| channelId | string | true |  | The ID of the notification channel to be used to send the notification. |
| eventGroup | string | false |  | The group of the event that triggers the notification. |
| eventType | string | false |  | The type of the event that triggers the notification. |
| name | string | true | maxLength: 100 | The name of the new notification policy. |
| orgId | string | false |  | The ID of the organization that owns the notification policy. |

### Enumerated Values

| Property | Value |
| --- | --- |
| eventGroup | [secure_config.all, dataset.all, file.all, comment.all, invite_job.all, deployment_prediction_explanations_computation.all, model_deployments.critical_health, model_deployments.critical_frequent_health_change, model_deployments.frequent_health_change, model_deployments.health, model_deployments.retraining_policy, inference_endpoints.health, model_deployments.management_agent, model_deployments.management_agent_health, prediction_request.all, challenger_management.all, challenger_replay.all, model_deployments.all, project.all, perma_delete_project.all, users_delete.all, applications.all, model_version.stage_transitions, model_version.all, use_case.all, batch_predictions.all, change_requests.all, custom_job_run.all, custom_job_run.unsuccessful, insights_computation.all, notebook_schedule.all, monitoring.all] |
| eventType | [secure_config.created, secure_config.deleted, secure_config.shared, dataset.created, dataset.registered, dataset.deleted, datasets.deleted, datasetrelationship.created, dataset.shared, datasets.shared, file.created, file.registered, file.deleted, file.shared, comment.created, comment.updated, invite_job.completed, misc.asset_access_request, misc.webhook_connection_test, misc.webhook_resend, misc.email_verification, monitoring.spooler_channel_base, monitoring.spooler_channel_red, monitoring.spooler_channel_green, monitoring.external_model_nan_predictions, management.deploymentInfo, model_deployments.None, model_deployments.deployment_sharing, model_deployments.model_replacement, prediction_request.None, prediction_request.failed, model_deployments.humility_rule, model_deployments.model_replacement_lifecycle, model_deployments.model_replacement_started, model_deployments.model_replacement_succeeded, model_deployments.model_replacement_failed, model_deployments.model_replacement_validation_warning, model_deployments.deployment_creation, model_deployments.deployment_deletion, model_deployments.service_health_yellow_from_green, model_deployments.service_health_yellow_from_red, model_deployments.service_health_red, model_deployments.data_drift_yellow_from_green, model_deployments.data_drift_yellow_from_red, model_deployments.data_drift_red, model_deployments.accuracy_yellow_from_green, model_deployments.accuracy_yellow_from_red, model_deployments.accuracy_red, model_deployments.health.fairness_health.green_to_yellow, model_deployments.health.fairness_health.red_to_yellow, model_deployments.health.fairness_health.red, model_deployments.health.custom_metrics_health.green_to_yellow, model_deployments.health.custom_metrics_health.red_to_yellow, model_deployments.health.custom_metrics_health.red, model_deployments.health.base.green, model_deployments.service_health_green, model_deployments.data_drift_green, model_deployments.accuracy_green, model_deployments.health.fairness_health.green, model_deployments.health.custom_metrics_health.green, model_deployments.retraining_policy_run_started, model_deployments.retraining_policy_run_succeeded, model_deployments.retraining_policy_run_failed, model_deployments.challenger_scoring_success, model_deployments.challenger_scoring_data_warning, model_deployments.challenger_scoring_failure, model_deployments.challenger_scoring_started, model_deployments.challenger_model_validation_warning, model_deployments.challenger_model_created, model_deployments.challenger_model_deleted, model_deployments.actuals_upload_failed, model_deployments.actuals_upload_warning, model_deployments.training_data_baseline_calculation_started, model_deployments.training_data_baseline_calculation_completed, model_deployments.training_data_baseline_failed, model_deployments.custom_model_deployment_creation_started, model_deployments.custom_model_deployment_creation_completed, model_deployments.custom_model_deployment_creation_failed, model_deployments.custom_model_deployment_secure_config_failure, model_deployments.deployment_prediction_explanations_preview_job_submitted, model_deployments.deployment_prediction_explanations_preview_job_completed, model_deployments.deployment_prediction_explanations_preview_job_failed, model_deployments.custom_model_deployment_activated, model_deployments.custom_model_deployment_activation_failed, model_deployments.custom_model_deployment_deactivated, model_deployments.custom_model_deployment_deactivation_failed, model_deployments.prediction_processing_rate_limit_reached, model_deployments.prediction_data_processing_rate_limit_reached, model_deployments.prediction_data_processing_rate_limit_warning, model_deployments.actuals_processing_rate_limit_reached, model_deployments.actuals_processing_rate_limit_warning, model_deployments.deployment_monitoring_data_cleared, model_deployments.deployment_launch_started, model_deployments.deployment_launch_succeeded, model_deployments.deployment_launch_failed, model_deployments.deployment_shutdown_started, model_deployments.deployment_shutdown_succeeded, model_deployments.deployment_shutdown_failed, model_deployments.endpoint_update_started, model_deployments.endpoint_update_succeeded, model_deployments.endpoint_update_failed, model_deployments.management_agent_service_health_green, model_deployments.management_agent_service_health_yellow, model_deployments.management_agent_service_health_red, model_deployments.management_agent_service_health_unknown, model_deployments.predictions_missing_association_id, model_deployments.prediction_result_rows_cleand_up, model_deployments.batch_deleted, model_deployments.batch_creation_limit_reached, model_deployments.batch_creation_limit_exceeded, model_deployments.batch_not_found, model_deployments.predictions_encountered_for_locked_batch, model_deployments.predictions_encountered_for_deleted_batch, model_deployments.scheduled_report_generated, model_deployments.predictions_timeliness_health_red, model_deployments.actuals_timeliness_health_red, model_deployments.service_health_still_red, model_deployments.data_drift_still_red, model_deployments.accuracy_still_red, model_deployments.health.fairness_health.still_red, model_deployments.health.custom_metrics_health.still_red, model_deployments.predictions_timeliness_health_still_red, model_deployments.actuals_timeliness_health_still_red, model_deployments.service_health_still_yellow, model_deployments.data_drift_still_yellow, model_deployments.accuracy_still_yellow, model_deployments.health.fairness_health.still_yellow, model_deployments.health.custom_metrics_health.still_yellow, model_deployments.prediction_payload_parsing_failure, model_deployments.deployment_inference_server_creation_started, model_deployments.deployment_inference_server_creation_failed, model_deployments.deployment_inference_server_creation_completed, model_deployments.deployment_inference_server_deletion, model_deployments.deployment_inference_server_idle_stopped, model_deployments.deployment_inference_server_maintenance_started, entity_notification_policy_template.shared, notification_channel_template.shared, project.created, project.deleted, project.shared, autopilot.complete, autopilot.started, autostart.failure, perma_delete_project.success, perma_delete_project.failure, users_delete.preview_started, users_delete.preview_completed, users_delete.preview_failed, users_delete.started, users_delete.completed, users_delete.failed, application.created, application.shared, model_version.added, model_version.stage_transition_from_registered_to_development, model_version.stage_transition_from_registered_to_staging, model_version.stage_transition_from_registered_to_production, model_version.stage_transition_from_registered_to_archived, model_version.stage_transition_from_development_to_registered, model_version.stage_transition_from_development_to_staging, model_version.stage_transition_from_development_to_production, model_version.stage_transition_from_development_to_archived, model_version.stage_transition_from_staging_to_registered, model_version.stage_transition_from_staging_to_development, model_version.stage_transition_from_staging_to_production, model_version.stage_transition_from_staging_to_archived, model_version.stage_transition_from_production_to_registered, model_version.stage_transition_from_production_to_development, model_version.stage_transition_from_production_to_staging, model_version.stage_transition_from_production_to_archived, model_version.stage_transition_from_archived_to_registered, model_version.stage_transition_from_archived_to_development, model_version.stage_transition_from_archived_to_production, model_version.stage_transition_from_archived_to_staging, use_case.shared, batch_predictions.success, batch_predictions.failed, batch_predictions.scheduler.auto_disabled, change_request.cancelled, change_request.created, change_request.deployment_approval_requested, change_request.resolved, change_request.proposed_changes_updated, change_request.pending, change_request.commenting_review_added, change_request.approving_review_added, change_request.changes_requesting_review_added, custom_job_run.success, custom_job_run.failed, custom_job_run.interrupted, custom_job_run.cancelled, prediction_explanations_computation.None, prediction_explanations_computation.prediction_explanations_preview_job_submitted, prediction_explanations_computation.prediction_explanations_preview_job_completed, prediction_explanations_computation.prediction_explanations_preview_job_failed, monitoring.rate_limit_enforced, notebook_schedule.created, notebook_schedule.failure, notebook_schedule.completed, abstract, moderation.metric.creation_error, moderation.metric.reporting_error, moderation.model.moderation_started, moderation.model.moderation_completed, moderation.model.pre_score_phase_started, moderation.model.pre_score_phase_completed, moderation.model.post_score_phase_started, moderation.model.post_score_phase_completed, moderation.model.config_error, moderation.model.runtime_error, moderation.model.scoring_started, moderation.model.scoring_completed, moderation.model.scoring_error] |

## NotificationPolicyMuteCreate

```
{
  "properties": {
    "entityId": {
      "description": "The ID of the entity to mute the notification for.",
      "type": "string"
    },
    "policyId": {
      "description": "The ID of the policy to mute notification for.",
      "type": "string"
    }
  },
  "required": [
    "entityId",
    "policyId"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| entityId | string | true |  | The ID of the entity to mute the notification for. |
| policyId | string | true |  | The ID of the policy to mute notification for. |

## NotificationPolicyMuteListResponse

```
{
  "properties": {
    "count": {
      "description": "The number of items returned on this page.",
      "type": "integer"
    },
    "data": {
      "description": "The list of notification policy mutes.",
      "items": {
        "properties": {
          "entityId": {
            "description": "The ID of the entity to mute the notification for.",
            "type": "string"
          },
          "id": {
            "description": "The ID of the notification policy mute.",
            "type": "string"
          },
          "policyId": {
            "description": "The ID of the policy to mute notification for.",
            "type": "string"
          },
          "uid": {
            "description": "The UID of the notification policy mute.",
            "type": "string"
          }
        },
        "required": [
          "entityId",
          "id",
          "policyId",
          "uid"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array"
    },
    "next": {
      "description": "The URL pointing to the next page (if null, there is no next page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL pointing to the previous page (if null, there is no previous page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "totalCount": {
      "description": "The total number of items returned by the query.",
      "type": "integer"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| count | integer | true |  | The number of items returned on this page. |
| data | [NotificationPolicyMuteResponse] | true | maxItems: 100 | The list of notification policy mutes. |
| next | string,null(uri) | true |  | The URL pointing to the next page (if null, there is no next page). |
| previous | string,null(uri) | true |  | The URL pointing to the previous page (if null, there is no previous page). |
| totalCount | integer | true |  | The total number of items returned by the query. |

## NotificationPolicyMuteResponse

```
{
  "properties": {
    "entityId": {
      "description": "The ID of the entity to mute the notification for.",
      "type": "string"
    },
    "id": {
      "description": "The ID of the notification policy mute.",
      "type": "string"
    },
    "policyId": {
      "description": "The ID of the policy to mute notification for.",
      "type": "string"
    },
    "uid": {
      "description": "The UID of the notification policy mute.",
      "type": "string"
    }
  },
  "required": [
    "entityId",
    "id",
    "policyId",
    "uid"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| entityId | string | true |  | The ID of the entity to mute the notification for. |
| id | string | true |  | The ID of the notification policy mute. |
| policyId | string | true |  | The ID of the policy to mute notification for. |
| uid | string | true |  | The UID of the notification policy mute. |

## NotificationPolicyResponse

```
{
  "properties": {
    "active": {
      "description": "Defines if the notification policy is active or not.",
      "type": "boolean"
    },
    "channel": {
      "description": "The notification channel information used to send the notification.",
      "properties": {
        "channelType": {
          "description": "The type of the new notification channel.",
          "enum": [
            "Database",
            "Email",
            "InApp",
            "InsightsComputations",
            "MSTeams",
            "Slack",
            "Webhook"
          ],
          "type": "string"
        },
        "contentType": {
          "description": "The content type of the messages of the new notification channel.",
          "enum": [
            "application/json",
            "application/x-www-form-urlencoded"
          ],
          "type": [
            "string",
            "null"
          ]
        },
        "createdAt": {
          "description": "The date of the notification channel creation.",
          "format": "date-time",
          "type": "string"
        },
        "customHeaders": {
          "description": "Custom headers and their values to be sent in the new notification channel.",
          "items": {
            "properties": {
              "name": {
                "description": "The name of the header.",
                "type": "string"
              },
              "value": {
                "description": "The value of the header.",
                "type": "string"
              }
            },
            "required": [
              "name",
              "value"
            ],
            "type": "object"
          },
          "maxItems": 100,
          "type": "array"
        },
        "emailAddress": {
          "description": "The email address to be used in the new notification channel.",
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "description": "The ID of the notification channel.",
          "type": "string"
        },
        "languageCode": {
          "description": "The preferred language code.",
          "enum": [
            "en",
            "es_419",
            "fr",
            "ja",
            "ko",
            "ptBR"
          ],
          "type": [
            "string",
            "null"
          ]
        },
        "name": {
          "description": "The name of the new notification channel.",
          "type": "string"
        },
        "orgId": {
          "description": "The ID of the organization that the notification channel belongs to.",
          "type": [
            "string",
            "null"
          ]
        },
        "payloadUrl": {
          "description": "The payload URL of the new notification channel.",
          "format": "uri",
          "type": [
            "string",
            "null"
          ]
        },
        "secretToken": {
          "description": "Secret token to be used for new notification channel.",
          "type": [
            "string",
            "null"
          ]
        },
        "uid": {
          "description": "The identifier of the user who created the channel.",
          "type": [
            "string",
            "null"
          ]
        },
        "updatedAt": {
          "description": "The date when the channel was updated.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "validateSsl": {
          "description": "Whether to validate SSL for the notification channel.",
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "required": [
        "channelType",
        "contentType",
        "createdAt",
        "customHeaders",
        "emailAddress",
        "id",
        "languageCode",
        "name",
        "orgId",
        "payloadUrl",
        "secretToken",
        "uid",
        "updatedAt",
        "validateSsl"
      ],
      "type": "object"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string"
    },
    "created": {
      "description": "The date when the policy was created.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "properties": {
        "events": {
          "description": "The events included in this group.",
          "items": {
            "description": "The type of the event that triggers the notification.",
            "properties": {
              "id": {
                "description": "The ID of the event type.",
                "type": "string"
              },
              "label": {
                "description": "The display name of the event type.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "label"
            ],
            "type": "object"
          },
          "maxItems": 1000,
          "type": "array"
        },
        "id": {
          "description": "The ID of the event group.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event group.",
          "type": "string"
        }
      },
      "required": [
        "events",
        "id",
        "label"
      ],
      "type": "object"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "properties": {
        "id": {
          "description": "The ID of the event type.",
          "type": "string"
        },
        "label": {
          "description": "The display name of the event type.",
          "type": "string"
        }
      },
      "required": [
        "id",
        "label"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the policy.",
      "type": "string"
    },
    "lastTriggered": {
      "description": "The date when the last notification with the policy was triggered.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "name": {
      "description": "The name of the notification policy.",
      "type": "string"
    },
    "orgId": {
      "description": "The ID of the organization that owns the notification policy.",
      "type": [
        "string",
        "null"
      ]
    },
    "uid": {
      "description": "The identifier of the user who created the policy.",
      "type": "string"
    },
    "updatedAt": {
      "description": "The date when the policy was updated.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "active",
    "channel",
    "channelId",
    "created",
    "eventGroup",
    "eventType",
    "id",
    "lastTriggered",
    "name",
    "orgId",
    "uid",
    "updatedAt"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| active | boolean | true |  | Defines if the notification policy is active or not. |
| channel | NotificationChannel | true |  | The notification channel information used to send the notification. |
| channelId | string | true |  | The ID of the notification channel to be used to send the notification. |
| created | string,null(date-time) | true |  | The date when the policy was created. |
| eventGroup | EventGroup | true |  | The group of the event that triggers the notification. |
| eventType | EventType | true |  | The type of the event that triggers the notification. |
| id | string | true |  | The ID of the policy. |
| lastTriggered | string,null(date-time) | true |  | The date when the last notification with the policy was triggered. |
| name | string | true |  | The name of the notification policy. |
| orgId | string,null | true |  | The ID of the organization that owns the notification policy. |
| uid | string | true |  | The identifier of the user who created the policy. |
| updatedAt | string,null(date-time) | true |  | The date when the policy was updated. |

## NotificationPolicyUpdate

```
{
  "properties": {
    "active": {
      "description": "Whether the notification policy is active or not.",
      "type": "boolean"
    },
    "channelId": {
      "description": "The ID of the notification channel to be used to send the notification.",
      "type": "string"
    },
    "eventGroup": {
      "description": "The group of the event that triggers the notification.",
      "enum": [
        "secure_config.all",
        "dataset.all",
        "file.all",
        "comment.all",
        "invite_job.all",
        "deployment_prediction_explanations_computation.all",
        "model_deployments.critical_health",
        "model_deployments.critical_frequent_health_change",
        "model_deployments.frequent_health_change",
        "model_deployments.health",
        "model_deployments.retraining_policy",
        "inference_endpoints.health",
        "model_deployments.management_agent",
        "model_deployments.management_agent_health",
        "prediction_request.all",
        "challenger_management.all",
        "challenger_replay.all",
        "model_deployments.all",
        "project.all",
        "perma_delete_project.all",
        "users_delete.all",
        "applications.all",
        "model_version.stage_transitions",
        "model_version.all",
        "use_case.all",
        "batch_predictions.all",
        "change_requests.all",
        "custom_job_run.all",
        "custom_job_run.unsuccessful",
        "insights_computation.all",
        "notebook_schedule.all",
        "monitoring.all"
      ],
      "type": "string"
    },
    "eventType": {
      "description": "The type of the event that triggers the notification.",
      "enum": [
        "secure_config.created",
        "secure_config.deleted",
        "secure_config.shared",
        "dataset.created",
        "dataset.registered",
        "dataset.deleted",
        "datasets.deleted",
        "datasetrelationship.created",
        "dataset.shared",
        "datasets.shared",
        "file.created",
        "file.registered",
        "file.deleted",
        "file.shared",
        "comment.created",
        "comment.updated",
        "invite_job.completed",
        "misc.asset_access_request",
        "misc.webhook_connection_test",
        "misc.webhook_resend",
        "misc.email_verification",
        "monitoring.spooler_channel_base",
        "monitoring.spooler_channel_red",
        "monitoring.spooler_channel_green",
        "monitoring.external_model_nan_predictions",
        "management.deploymentInfo",
        "model_deployments.None",
        "model_deployments.deployment_sharing",
        "model_deployments.model_replacement",
        "prediction_request.None",
        "prediction_request.failed",
        "model_deployments.humility_rule",
        "model_deployments.model_replacement_lifecycle",
        "model_deployments.model_replacement_started",
        "model_deployments.model_replacement_succeeded",
        "model_deployments.model_replacement_failed",
        "model_deployments.model_replacement_validation_warning",
        "model_deployments.deployment_creation",
        "model_deployments.deployment_deletion",
        "model_deployments.service_health_yellow_from_green",
        "model_deployments.service_health_yellow_from_red",
        "model_deployments.service_health_red",
        "model_deployments.data_drift_yellow_from_green",
        "model_deployments.data_drift_yellow_from_red",
        "model_deployments.data_drift_red",
        "model_deployments.accuracy_yellow_from_green",
        "model_deployments.accuracy_yellow_from_red",
        "model_deployments.accuracy_red",
        "model_deployments.health.fairness_health.green_to_yellow",
        "model_deployments.health.fairness_health.red_to_yellow",
        "model_deployments.health.fairness_health.red",
        "model_deployments.health.custom_metrics_health.green_to_yellow",
        "model_deployments.health.custom_metrics_health.red_to_yellow",
        "model_deployments.health.custom_metrics_health.red",
        "model_deployments.health.base.green",
        "model_deployments.service_health_green",
        "model_deployments.data_drift_green",
        "model_deployments.accuracy_green",
        "model_deployments.health.fairness_health.green",
        "model_deployments.health.custom_metrics_health.green",
        "model_deployments.retraining_policy_run_started",
        "model_deployments.retraining_policy_run_succeeded",
        "model_deployments.retraining_policy_run_failed",
        "model_deployments.challenger_scoring_success",
        "model_deployments.challenger_scoring_data_warning",
        "model_deployments.challenger_scoring_failure",
        "model_deployments.challenger_scoring_started",
        "model_deployments.challenger_model_validation_warning",
        "model_deployments.challenger_model_created",
        "model_deployments.challenger_model_deleted",
        "model_deployments.actuals_upload_failed",
        "model_deployments.actuals_upload_warning",
        "model_deployments.training_data_baseline_calculation_started",
        "model_deployments.training_data_baseline_calculation_completed",
        "model_deployments.training_data_baseline_failed",
        "model_deployments.custom_model_deployment_creation_started",
        "model_deployments.custom_model_deployment_creation_completed",
        "model_deployments.custom_model_deployment_creation_failed",
        "model_deployments.custom_model_deployment_secure_config_failure",
        "model_deployments.deployment_prediction_explanations_preview_job_submitted",
        "model_deployments.deployment_prediction_explanations_preview_job_completed",
        "model_deployments.deployment_prediction_explanations_preview_job_failed",
        "model_deployments.custom_model_deployment_activated",
        "model_deployments.custom_model_deployment_activation_failed",
        "model_deployments.custom_model_deployment_deactivated",
        "model_deployments.custom_model_deployment_deactivation_failed",
        "model_deployments.prediction_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_reached",
        "model_deployments.prediction_data_processing_rate_limit_warning",
        "model_deployments.actuals_processing_rate_limit_reached",
        "model_deployments.actuals_processing_rate_limit_warning",
        "model_deployments.deployment_monitoring_data_cleared",
        "model_deployments.deployment_launch_started",
        "model_deployments.deployment_launch_succeeded",
        "model_deployments.deployment_launch_failed",
        "model_deployments.deployment_shutdown_started",
        "model_deployments.deployment_shutdown_succeeded",
        "model_deployments.deployment_shutdown_failed",
        "model_deployments.endpoint_update_started",
        "model_deployments.endpoint_update_succeeded",
        "model_deployments.endpoint_update_failed",
        "model_deployments.management_agent_service_health_green",
        "model_deployments.management_agent_service_health_yellow",
        "model_deployments.management_agent_service_health_red",
        "model_deployments.management_agent_service_health_unknown",
        "model_deployments.predictions_missing_association_id",
        "model_deployments.prediction_result_rows_cleand_up",
        "model_deployments.batch_deleted",
        "model_deployments.batch_creation_limit_reached",
        "model_deployments.batch_creation_limit_exceeded",
        "model_deployments.batch_not_found",
        "model_deployments.predictions_encountered_for_locked_batch",
        "model_deployments.predictions_encountered_for_deleted_batch",
        "model_deployments.scheduled_report_generated",
        "model_deployments.predictions_timeliness_health_red",
        "model_deployments.actuals_timeliness_health_red",
        "model_deployments.service_health_still_red",
        "model_deployments.data_drift_still_red",
        "model_deployments.accuracy_still_red",
        "model_deployments.health.fairness_health.still_red",
        "model_deployments.health.custom_metrics_health.still_red",
        "model_deployments.predictions_timeliness_health_still_red",
        "model_deployments.actuals_timeliness_health_still_red",
        "model_deployments.service_health_still_yellow",
        "model_deployments.data_drift_still_yellow",
        "model_deployments.accuracy_still_yellow",
        "model_deployments.health.fairness_health.still_yellow",
        "model_deployments.health.custom_metrics_health.still_yellow",
        "model_deployments.prediction_payload_parsing_failure",
        "model_deployments.deployment_inference_server_creation_started",
        "model_deployments.deployment_inference_server_creation_failed",
        "model_deployments.deployment_inference_server_creation_completed",
        "model_deployments.deployment_inference_server_deletion",
        "model_deployments.deployment_inference_server_idle_stopped",
        "model_deployments.deployment_inference_server_maintenance_started",
        "entity_notification_policy_template.shared",
        "notification_channel_template.shared",
        "project.created",
        "project.deleted",
        "project.shared",
        "autopilot.complete",
        "autopilot.started",
        "autostart.failure",
        "perma_delete_project.success",
        "perma_delete_project.failure",
        "users_delete.preview_started",
        "users_delete.preview_completed",
        "users_delete.preview_failed",
        "users_delete.started",
        "users_delete.completed",
        "users_delete.failed",
        "application.created",
        "application.shared",
        "model_version.added",
        "model_version.stage_transition_from_registered_to_development",
        "model_version.stage_transition_from_registered_to_staging",
        "model_version.stage_transition_from_registered_to_production",
        "model_version.stage_transition_from_registered_to_archived",
        "model_version.stage_transition_from_development_to_registered",
        "model_version.stage_transition_from_development_to_staging",
        "model_version.stage_transition_from_development_to_production",
        "model_version.stage_transition_from_development_to_archived",
        "model_version.stage_transition_from_staging_to_registered",
        "model_version.stage_transition_from_staging_to_development",
        "model_version.stage_transition_from_staging_to_production",
        "model_version.stage_transition_from_staging_to_archived",
        "model_version.stage_transition_from_production_to_registered",
        "model_version.stage_transition_from_production_to_development",
        "model_version.stage_transition_from_production_to_staging",
        "model_version.stage_transition_from_production_to_archived",
        "model_version.stage_transition_from_archived_to_registered",
        "model_version.stage_transition_from_archived_to_development",
        "model_version.stage_transition_from_archived_to_production",
        "model_version.stage_transition_from_archived_to_staging",
        "use_case.shared",
        "batch_predictions.success",
        "batch_predictions.failed",
        "batch_predictions.scheduler.auto_disabled",
        "change_request.cancelled",
        "change_request.created",
        "change_request.deployment_approval_requested",
        "change_request.resolved",
        "change_request.proposed_changes_updated",
        "change_request.pending",
        "change_request.commenting_review_added",
        "change_request.approving_review_added",
        "change_request.changes_requesting_review_added",
        "custom_job_run.success",
        "custom_job_run.failed",
        "custom_job_run.interrupted",
        "custom_job_run.cancelled",
        "prediction_explanations_computation.None",
        "prediction_explanations_computation.prediction_explanations_preview_job_submitted",
        "prediction_explanations_computation.prediction_explanations_preview_job_completed",
        "prediction_explanations_computation.prediction_explanations_preview_job_failed",
        "monitoring.rate_limit_enforced",
        "notebook_schedule.created",
        "notebook_schedule.failure",
        "notebook_schedule.completed",
        "abstract",
        "moderation.metric.creation_error",
        "moderation.metric.reporting_error",
        "moderation.model.moderation_started",
        "moderation.model.moderation_completed",
        "moderation.model.pre_score_phase_started",
        "moderation.model.pre_score_phase_completed",
        "moderation.model.post_score_phase_started",
        "moderation.model.post_score_phase_completed",
        "moderation.model.config_error",
        "moderation.model.runtime_error",
        "moderation.model.scoring_started",
        "moderation.model.scoring_completed",
        "moderation.model.scoring_error"
      ],
      "type": "string"
    },
    "name": {
      "description": "The name of the notification policy.",
      "maxLength": 100,
      "type": "string"
    }
  },
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| active | boolean | false |  | Whether the notification policy is active or not. |
| channelId | string | false |  | The ID of the notification channel to be used to send the notification. |
| eventGroup | string | false |  | The group of the event that triggers the notification. |
| eventType | string | false |  | The type of the event that triggers the notification. |
| name | string | false | maxLength: 100 | The name of the notification policy. |

### Enumerated Values

| Property | Value |
| --- | --- |
| eventGroup | [secure_config.all, dataset.all, file.all, comment.all, invite_job.all, deployment_prediction_explanations_computation.all, model_deployments.critical_health, model_deployments.critical_frequent_health_change, model_deployments.frequent_health_change, model_deployments.health, model_deployments.retraining_policy, inference_endpoints.health, model_deployments.management_agent, model_deployments.management_agent_health, prediction_request.all, challenger_management.all, challenger_replay.all, model_deployments.all, project.all, perma_delete_project.all, users_delete.all, applications.all, model_version.stage_transitions, model_version.all, use_case.all, batch_predictions.all, change_requests.all, custom_job_run.all, custom_job_run.unsuccessful, insights_computation.all, notebook_schedule.all, monitoring.all] |
| eventType | [secure_config.created, secure_config.deleted, secure_config.shared, dataset.created, dataset.registered, dataset.deleted, datasets.deleted, datasetrelationship.created, dataset.shared, datasets.shared, file.created, file.registered, file.deleted, file.shared, comment.created, comment.updated, invite_job.completed, misc.asset_access_request, misc.webhook_connection_test, misc.webhook_resend, misc.email_verification, monitoring.spooler_channel_base, monitoring.spooler_channel_red, monitoring.spooler_channel_green, monitoring.external_model_nan_predictions, management.deploymentInfo, model_deployments.None, model_deployments.deployment_sharing, model_deployments.model_replacement, prediction_request.None, prediction_request.failed, model_deployments.humility_rule, model_deployments.model_replacement_lifecycle, model_deployments.model_replacement_started, model_deployments.model_replacement_succeeded, model_deployments.model_replacement_failed, model_deployments.model_replacement_validation_warning, model_deployments.deployment_creation, model_deployments.deployment_deletion, model_deployments.service_health_yellow_from_green, model_deployments.service_health_yellow_from_red, model_deployments.service_health_red, model_deployments.data_drift_yellow_from_green, model_deployments.data_drift_yellow_from_red, model_deployments.data_drift_red, model_deployments.accuracy_yellow_from_green, model_deployments.accuracy_yellow_from_red, model_deployments.accuracy_red, model_deployments.health.fairness_health.green_to_yellow, model_deployments.health.fairness_health.red_to_yellow, model_deployments.health.fairness_health.red, model_deployments.health.custom_metrics_health.green_to_yellow, model_deployments.health.custom_metrics_health.red_to_yellow, model_deployments.health.custom_metrics_health.red, model_deployments.health.base.green, model_deployments.service_health_green, model_deployments.data_drift_green, model_deployments.accuracy_green, model_deployments.health.fairness_health.green, model_deployments.health.custom_metrics_health.green, model_deployments.retraining_policy_run_started, model_deployments.retraining_policy_run_succeeded, model_deployments.retraining_policy_run_failed, model_deployments.challenger_scoring_success, model_deployments.challenger_scoring_data_warning, model_deployments.challenger_scoring_failure, model_deployments.challenger_scoring_started, model_deployments.challenger_model_validation_warning, model_deployments.challenger_model_created, model_deployments.challenger_model_deleted, model_deployments.actuals_upload_failed, model_deployments.actuals_upload_warning, model_deployments.training_data_baseline_calculation_started, model_deployments.training_data_baseline_calculation_completed, model_deployments.training_data_baseline_failed, model_deployments.custom_model_deployment_creation_started, model_deployments.custom_model_deployment_creation_completed, model_deployments.custom_model_deployment_creation_failed, model_deployments.custom_model_deployment_secure_config_failure, model_deployments.deployment_prediction_explanations_preview_job_submitted, model_deployments.deployment_prediction_explanations_preview_job_completed, model_deployments.deployment_prediction_explanations_preview_job_failed, model_deployments.custom_model_deployment_activated, model_deployments.custom_model_deployment_activation_failed, model_deployments.custom_model_deployment_deactivated, model_deployments.custom_model_deployment_deactivation_failed, model_deployments.prediction_processing_rate_limit_reached, model_deployments.prediction_data_processing_rate_limit_reached, model_deployments.prediction_data_processing_rate_limit_warning, model_deployments.actuals_processing_rate_limit_reached, model_deployments.actuals_processing_rate_limit_warning, model_deployments.deployment_monitoring_data_cleared, model_deployments.deployment_launch_started, model_deployments.deployment_launch_succeeded, model_deployments.deployment_launch_failed, model_deployments.deployment_shutdown_started, model_deployments.deployment_shutdown_succeeded, model_deployments.deployment_shutdown_failed, model_deployments.endpoint_update_started, model_deployments.endpoint_update_succeeded, model_deployments.endpoint_update_failed, model_deployments.management_agent_service_health_green, model_deployments.management_agent_service_health_yellow, model_deployments.management_agent_service_health_red, model_deployments.management_agent_service_health_unknown, model_deployments.predictions_missing_association_id, model_deployments.prediction_result_rows_cleand_up, model_deployments.batch_deleted, model_deployments.batch_creation_limit_reached, model_deployments.batch_creation_limit_exceeded, model_deployments.batch_not_found, model_deployments.predictions_encountered_for_locked_batch, model_deployments.predictions_encountered_for_deleted_batch, model_deployments.scheduled_report_generated, model_deployments.predictions_timeliness_health_red, model_deployments.actuals_timeliness_health_red, model_deployments.service_health_still_red, model_deployments.data_drift_still_red, model_deployments.accuracy_still_red, model_deployments.health.fairness_health.still_red, model_deployments.health.custom_metrics_health.still_red, model_deployments.predictions_timeliness_health_still_red, model_deployments.actuals_timeliness_health_still_red, model_deployments.service_health_still_yellow, model_deployments.data_drift_still_yellow, model_deployments.accuracy_still_yellow, model_deployments.health.fairness_health.still_yellow, model_deployments.health.custom_metrics_health.still_yellow, model_deployments.prediction_payload_parsing_failure, model_deployments.deployment_inference_server_creation_started, model_deployments.deployment_inference_server_creation_failed, model_deployments.deployment_inference_server_creation_completed, model_deployments.deployment_inference_server_deletion, model_deployments.deployment_inference_server_idle_stopped, model_deployments.deployment_inference_server_maintenance_started, entity_notification_policy_template.shared, notification_channel_template.shared, project.created, project.deleted, project.shared, autopilot.complete, autopilot.started, autostart.failure, perma_delete_project.success, perma_delete_project.failure, users_delete.preview_started, users_delete.preview_completed, users_delete.preview_failed, users_delete.started, users_delete.completed, users_delete.failed, application.created, application.shared, model_version.added, model_version.stage_transition_from_registered_to_development, model_version.stage_transition_from_registered_to_staging, model_version.stage_transition_from_registered_to_production, model_version.stage_transition_from_registered_to_archived, model_version.stage_transition_from_development_to_registered, model_version.stage_transition_from_development_to_staging, model_version.stage_transition_from_development_to_production, model_version.stage_transition_from_development_to_archived, model_version.stage_transition_from_staging_to_registered, model_version.stage_transition_from_staging_to_development, model_version.stage_transition_from_staging_to_production, model_version.stage_transition_from_staging_to_archived, model_version.stage_transition_from_production_to_registered, model_version.stage_transition_from_production_to_development, model_version.stage_transition_from_production_to_staging, model_version.stage_transition_from_production_to_archived, model_version.stage_transition_from_archived_to_registered, model_version.stage_transition_from_archived_to_development, model_version.stage_transition_from_archived_to_production, model_version.stage_transition_from_archived_to_staging, use_case.shared, batch_predictions.success, batch_predictions.failed, batch_predictions.scheduler.auto_disabled, change_request.cancelled, change_request.created, change_request.deployment_approval_requested, change_request.resolved, change_request.proposed_changes_updated, change_request.pending, change_request.commenting_review_added, change_request.approving_review_added, change_request.changes_requesting_review_added, custom_job_run.success, custom_job_run.failed, custom_job_run.interrupted, custom_job_run.cancelled, prediction_explanations_computation.None, prediction_explanations_computation.prediction_explanations_preview_job_submitted, prediction_explanations_computation.prediction_explanations_preview_job_completed, prediction_explanations_computation.prediction_explanations_preview_job_failed, monitoring.rate_limit_enforced, notebook_schedule.created, notebook_schedule.failure, notebook_schedule.completed, abstract, moderation.metric.creation_error, moderation.metric.reporting_error, moderation.model.moderation_started, moderation.model.moderation_completed, moderation.model.pre_score_phase_started, moderation.model.pre_score_phase_completed, moderation.model.post_score_phase_started, moderation.model.post_score_phase_completed, moderation.model.config_error, moderation.model.runtime_error, moderation.model.scoring_started, moderation.model.scoring_completed, moderation.model.scoring_error] |

## NotificationResend

```
{
  "properties": {
    "notificationId": {
      "description": "The ID of the notification to resend.",
      "type": "string"
    }
  },
  "required": [
    "notificationId"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| notificationId | string | true |  | The ID of the notification to resend. |

## NotificationWebhookChannelStatusResponse

```
{
  "properties": {
    "notificationLog": {
      "description": "The notification log record.",
      "properties": {
        "channelId": {
          "description": "The ID of the channel that was used to send the notification.",
          "type": "string"
        },
        "channelScope": {
          "description": "The scope of the channel.",
          "enum": [
            "organization",
            "Organization",
            "ORGANIZATION",
            "entity",
            "Entity",
            "ENTITY",
            "template",
            "Template",
            "TEMPLATE"
          ],
          "type": [
            "string",
            "null"
          ]
        },
        "emailSubject": {
          "description": "The email subject of the notification.",
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "description": "The ID of the notification log.",
          "type": "string"
        },
        "parentNotificationId": {
          "description": "The ID of the parent notification.",
          "type": [
            "string",
            "null"
          ]
        },
        "policyId": {
          "description": "The ID of the policy that was used to send the notification.",
          "type": "string"
        },
        "request": {
          "description": "The request that was sent in the notification.",
          "type": [
            "string",
            "null"
          ]
        },
        "response": {
          "description": "The response that was received after sending the notification.",
          "type": [
            "string",
            "null"
          ]
        },
        "retryCount": {
          "description": "The number of attempts to send the notification.",
          "type": [
            "integer",
            "null"
          ]
        },
        "status": {
          "description": "The status of the notification.",
          "type": "string"
        },
        "timestamp": {
          "description": "The date when the notification was sent.",
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "channelId",
        "channelScope",
        "emailSubject",
        "id",
        "parentNotificationId",
        "policyId",
        "request",
        "response",
        "retryCount",
        "status",
        "timestamp"
      ],
      "type": "object"
    },
    "status": {
      "description": "The status of the test notification.",
      "type": "string"
    }
  },
  "required": [
    "notificationLog",
    "status"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| notificationLog | NotificationLog | true |  | The notification log record. |
| status | string | true |  | The status of the test notification. |

## NotificationWebhookChannelTestCreate

```
{
  "properties": {
    "channelType": {
      "description": "The type of the new notification channel.",
      "enum": [
        "Database",
        "Email",
        "InApp",
        "InsightsComputations",
        "MSTeams",
        "Slack",
        "Webhook"
      ],
      "type": "string"
    },
    "contentType": {
      "description": "The content type of the messages of the new notification channel.",
      "enum": [
        "application/json",
        "application/x-www-form-urlencoded"
      ],
      "type": "string"
    },
    "customHeaders": {
      "description": "Custom headers and their values to be sent in the new notification channel.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the header.",
            "type": "string"
          },
          "value": {
            "description": "The value of the header.",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "type": "array"
    },
    "emailAddress": {
      "description": "The email address to be used in the new notification channel.",
      "type": "string"
    },
    "name": {
      "description": "The name of the new notification channel.",
      "maxLength": 100,
      "type": "string"
    },
    "orgId": {
      "description": "The identifier of the organization that notification channel belongs to.",
      "type": "string"
    },
    "payloadUrl": {
      "description": "The payload URL of the new notification channel.",
      "format": "uri",
      "type": "string"
    },
    "secretToken": {
      "description": "Secret token to be used for new notification channel.",
      "type": "string"
    },
    "validateSsl": {
      "description": "Whether SSL will be validated in the notification channel.",
      "type": "boolean"
    }
  },
  "required": [
    "channelType",
    "name"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| channelType | string | true |  | The type of the new notification channel. |
| contentType | string | false |  | The content type of the messages of the new notification channel. |
| customHeaders | [CustomerHeader] | false | maxItems: 100 | Custom headers and their values to be sent in the new notification channel. |
| emailAddress | string | false |  | The email address to be used in the new notification channel. |
| name | string | true | maxLength: 100 | The name of the new notification channel. |
| orgId | string | false |  | The identifier of the organization that notification channel belongs to. |
| payloadUrl | string(uri) | false |  | The payload URL of the new notification channel. |
| secretToken | string | false |  | Secret token to be used for new notification channel. |
| validateSsl | boolean | false |  | Whether SSL will be validated in the notification channel. |

### Enumerated Values

| Property | Value |
| --- | --- |
| channelType | [Database, Email, InApp, InsightsComputations, MSTeams, Slack, Webhook] |
| contentType | [application/json, application/x-www-form-urlencoded] |

## NotificationWebhookChannelTestId

```
{
  "properties": {
    "notificationId": {
      "description": "The ID of the notification.",
      "type": "string"
    }
  },
  "required": [
    "notificationId"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| notificationId | string | true |  | The ID of the notification. |

## PredictionRemoteEventData

```
{
  "description": "Prediction event payload.",
  "properties": {
    "error_code": {
      "description": "The error code if any.",
      "type": [
        "string",
        "null"
      ]
    },
    "model_id": {
      "description": "The identifier of the model.",
      "type": [
        "string",
        "null"
      ]
    },
    "response_body": {
      "description": "The response body message of the prediction event.",
      "type": "string"
    },
    "status_code": {
      "description": "The response status code of the prediction event.",
      "type": "integer"
    },
    "user_id": {
      "description": "The identifier of the user that accesses the deployment.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "response_body",
    "status_code"
  ],
  "type": "object"
}
```

Prediction event payload.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| error_code | string,null | false |  | The error code if any. |
| model_id | string,null | false |  | The identifier of the model. |
| response_body | string | true |  | The response body message of the prediction event. |
| status_code | integer | true |  | The response status code of the prediction event. |
| user_id | string,null | false |  | The identifier of the user that accesses the deployment. |

## RemoteEventCreate

```
{
  "properties": {
    "data": {
      "description": "Event payload.",
      "properties": {
        "newModelId": {
          "description": "The identifier of the model after replacement.",
          "type": "string"
        },
        "oldModelId": {
          "description": "The identifier of the model before replacement.",
          "type": "string"
        },
        "reason": {
          "description": "The explanation on why the model has been replaced.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "deploymentId": {
      "description": "The identifier of the deployment associated with the event.",
      "type": "string"
    },
    "eventType": {
      "description": "The type of the event. Labels in all_lower_case are deprecated.",
      "enum": [
        "deploymentInfo",
        "externalNaNPredictions",
        "management.deploymentInfo",
        "model_deployments.accuracy_green",
        "model_deployments.accuracy_red",
        "model_deployments.accuracy_yellow_from_green",
        "model_deployments.data_drift_green",
        "model_deployments.data_drift_red",
        "model_deployments.data_drift_yellow_from_green",
        "model_deployments.model_replacement",
        "model_deployments.service_health_green",
        "model_deployments.service_health_red",
        "model_deployments.service_health_yellow_from_green",
        "moderationMetricCreationError",
        "moderationMetricReportingError",
        "moderationModelConfigError",
        "moderationModelModerationCompleted",
        "moderationModelModerationStarted",
        "moderationModelPostScorePhaseCompleted",
        "moderationModelPostScorePhaseStarted",
        "moderationModelPreScorePhaseCompleted",
        "moderationModelPreScorePhaseStarted",
        "moderationModelRuntimeError",
        "moderationModelScoringCompleted",
        "moderationModelScoringError",
        "moderationModelScoringStarted",
        "monitoring.external_model_nan_predictions",
        "monitoring.spooler_channel_green",
        "monitoring.spooler_channel_red",
        "predictionRequestFailed",
        "prediction_request.failed",
        "serviceHealthChangeGreen",
        "serviceHealthChangeRed",
        "serviceHealthChangeYellowFromGreen",
        "spoolerChannelGreen",
        "spoolerChannelRed"
      ],
      "type": "string"
    },
    "externalNanPredictionsData": {
      "description": "The external NaN predictions event payload.",
      "properties": {
        "count": {
          "description": "The number of NaN predictions by the external model.",
          "exclusiveMinimum": 0,
          "type": "integer"
        },
        "modelId": {
          "default": null,
          "description": "The identifier of the model.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "count",
        "modelId"
      ],
      "type": "object"
    },
    "message": {
      "description": "Descriptive message for health events.",
      "maxLength": 16384,
      "type": "string"
    },
    "moderationData": {
      "description": "The moderation event information.",
      "properties": {
        "guardName": {
          "description": "Name or label of the guard.",
          "maxLength": 255,
          "type": "string"
        },
        "metricName": {
          "description": "Name or label of the metric.",
          "maxLength": 255,
          "type": "string"
        }
      },
      "required": [
        "guardName",
        "metricName"
      ],
      "type": "object",
      "x-versionadded": "v2.35"
    },
    "orgId": {
      "description": "The identifier of the organization associated with the event.",
      "type": [
        "string",
        "null"
      ]
    },
    "predictionEnvironmentId": {
      "description": "The identifier of the prediction environment associated with the event.",
      "type": "string"
    },
    "predictionRequestData": {
      "description": "Prediction event payload.",
      "properties": {
        "error_code": {
          "description": "The error code if any.",
          "type": [
            "string",
            "null"
          ]
        },
        "model_id": {
          "description": "The identifier of the model.",
          "type": [
            "string",
            "null"
          ]
        },
        "response_body": {
          "description": "The response body message of the prediction event.",
          "type": "string"
        },
        "status_code": {
          "description": "The response status code of the prediction event.",
          "type": "integer"
        },
        "user_id": {
          "description": "The identifier of the user that accesses the deployment.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "response_body",
        "status_code"
      ],
      "type": "object"
    },
    "spoolerChannelData": {
      "description": "Spooler channel event payload.",
      "properties": {
        "name": {
          "description": "Name or label of the spooler channel.",
          "maxLength": 512,
          "type": "string"
        },
        "type": {
          "description": "Type of the spooler channel.",
          "enum": [
            "asyncMemory",
            "filesystem",
            "kafka",
            "memory",
            "pubSub",
            "rabbitMQ",
            "sqs"
          ],
          "type": "string"
        }
      },
      "required": [
        "name",
        "type"
      ],
      "type": "object"
    },
    "timestamp": {
      "description": "The time when the event occurred.",
      "format": "date-time",
      "type": "string"
    },
    "title": {
      "description": "The title of the event.",
      "maxLength": 512,
      "type": "string"
    }
  },
  "required": [
    "eventType",
    "timestamp"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| data | RemoteEventData | false |  | Event payload. |
| deploymentId | string | false |  | The identifier of the deployment associated with the event. |
| eventType | string | true |  | The type of the event. Labels in all_lower_case are deprecated. |
| externalNanPredictionsData | ExternalNaNPredictionsEventData | false |  | The external NaN predictions event payload. |
| message | string | false | maxLength: 16384 | Descriptive message for health events. |
| moderationData | ModerationData | false |  | The moderation event information. |
| orgId | string,null | false |  | The identifier of the organization associated with the event. |
| predictionEnvironmentId | string | false |  | The identifier of the prediction environment associated with the event. |
| predictionRequestData | PredictionRemoteEventData | false |  | Prediction event payload. |
| spoolerChannelData | SpoolerChannelEventData | false |  | Spooler channel event payload. |
| timestamp | string(date-time) | true |  | The time when the event occurred. |
| title | string | false | maxLength: 512 | The title of the event. |

### Enumerated Values

| Property | Value |
| --- | --- |
| eventType | [deploymentInfo, externalNaNPredictions, management.deploymentInfo, model_deployments.accuracy_green, model_deployments.accuracy_red, model_deployments.accuracy_yellow_from_green, model_deployments.data_drift_green, model_deployments.data_drift_red, model_deployments.data_drift_yellow_from_green, model_deployments.model_replacement, model_deployments.service_health_green, model_deployments.service_health_red, model_deployments.service_health_yellow_from_green, moderationMetricCreationError, moderationMetricReportingError, moderationModelConfigError, moderationModelModerationCompleted, moderationModelModerationStarted, moderationModelPostScorePhaseCompleted, moderationModelPostScorePhaseStarted, moderationModelPreScorePhaseCompleted, moderationModelPreScorePhaseStarted, moderationModelRuntimeError, moderationModelScoringCompleted, moderationModelScoringError, moderationModelScoringStarted, monitoring.external_model_nan_predictions, monitoring.spooler_channel_green, monitoring.spooler_channel_red, predictionRequestFailed, prediction_request.failed, serviceHealthChangeGreen, serviceHealthChangeRed, serviceHealthChangeYellowFromGreen, spoolerChannelGreen, spoolerChannelRed] |

## RemoteEventData

```
{
  "description": "Event payload.",
  "properties": {
    "newModelId": {
      "description": "The identifier of the model after replacement.",
      "type": "string"
    },
    "oldModelId": {
      "description": "The identifier of the model before replacement.",
      "type": "string"
    },
    "reason": {
      "description": "The explanation on why the model has been replaced.",
      "type": "string"
    }
  },
  "type": "object"
}
```

Event payload.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| newModelId | string | false |  | The identifier of the model after replacement. |
| oldModelId | string | false |  | The identifier of the model before replacement. |
| reason | string | false |  | The explanation on why the model has been replaced. |

## RequestNotification

```
{
  "description": "The request that was sent in the notification.",
  "properties": {
    "body": {
      "description": "The body of the request.",
      "type": "string"
    },
    "headers": {
      "description": "The headers of the request.",
      "type": "string"
    },
    "url": {
      "description": "The URL of the request.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "body",
    "headers",
    "url"
  ],
  "type": "object"
}
```

The request that was sent in the notification.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| body | string | true |  | The body of the request. |
| headers | string | true |  | The headers of the request. |
| url | string,null(uri) | true |  | The URL of the request. |

## ResponseNotification

```
{
  "description": "The response that was received after sending the notification.",
  "properties": {
    "body": {
      "description": "The body of the response.",
      "type": "string"
    },
    "duration": {
      "description": "The duration.",
      "type": "integer"
    },
    "headers": {
      "description": "The headers of the response.",
      "type": "string"
    },
    "statusCode": {
      "description": "The status code of the response.",
      "type": "string"
    }
  },
  "required": [
    "body",
    "duration",
    "headers",
    "statusCode"
  ],
  "type": "object"
}
```

The response that was received after sending the notification.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| body | string | true |  | The body of the response. |
| duration | integer | true |  | The duration. |
| headers | string | true |  | The headers of the response. |
| statusCode | string | true |  | The status code of the response. |

## SharedRolesUpdate

```
{
  "properties": {
    "operation": {
      "description": "Name of the action being taken. The only operation is 'updateRoles'.",
      "enum": [
        "updateRoles"
      ],
      "type": "string"
    },
    "roles": {
      "description": "Array of GrantAccessControl objects., up to maximum 100 objects.",
      "items": {
        "oneOf": [
          {
            "properties": {
              "role": {
                "description": "The role of the recipient on this entity.",
                "enum": [
                  "ADMIN",
                  "CONSUMER",
                  "DATA_SCIENTIST",
                  "EDITOR",
                  "NO_ROLE",
                  "OBSERVER",
                  "OWNER",
                  "READ_ONLY",
                  "READ_WRITE",
                  "USER"
                ],
                "type": "string"
              },
              "shareRecipientType": {
                "description": "Describes the recipient type — one of user, group, organization, or externalApplication.",
                "enum": [
                  "user",
                  "group",
                  "organization",
                  "externalApplication"
                ],
                "type": "string"
              },
              "username": {
                "description": "Username of the user to update the access role for.",
                "type": "string"
              }
            },
            "required": [
              "role",
              "shareRecipientType",
              "username"
            ],
            "type": "object"
          },
          {
            "properties": {
              "id": {
                "description": "The ID of the recipient.",
                "type": "string"
              },
              "role": {
                "description": "The role of the recipient on this entity.",
                "enum": [
                  "ADMIN",
                  "CONSUMER",
                  "DATA_SCIENTIST",
                  "EDITOR",
                  "NO_ROLE",
                  "OBSERVER",
                  "OWNER",
                  "READ_ONLY",
                  "READ_WRITE",
                  "USER"
                ],
                "type": "string"
              },
              "shareRecipientType": {
                "description": "Describes the recipient type — one of user, group, organization, or externalApplication.",
                "enum": [
                  "user",
                  "group",
                  "organization",
                  "externalApplication"
                ],
                "type": "string"
              }
            },
            "required": [
              "id",
              "role",
              "shareRecipientType"
            ],
            "type": "object"
          }
        ]
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array"
    }
  },
  "required": [
    "operation",
    "roles"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| operation | string | true |  | Name of the action being taken. The only operation is 'updateRoles'. |
| roles | [oneOf] | true | maxItems: 100minItems: 1 | Array of GrantAccessControl objects., up to maximum 100 objects. |

oneOf

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | GrantAccessControlWithUsername | false |  | none |

xor

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | GrantAccessControlWithId | false |  | none |

### Enumerated Values

| Property | Value |
| --- | --- |
| operation | updateRoles |

## SharingListV2Response

```
{
  "properties": {
    "count": {
      "description": "The number of items returned.",
      "type": "integer"
    },
    "data": {
      "description": "The access control list.",
      "items": {
        "properties": {
          "id": {
            "description": "The identifier of the recipient.",
            "type": "string"
          },
          "name": {
            "description": "The name of the recipient.",
            "type": "string"
          },
          "role": {
            "description": "The role of the recipient on this entity.",
            "enum": [
              "ADMIN",
              "CONSUMER",
              "DATA_SCIENTIST",
              "EDITOR",
              "OBSERVER",
              "OWNER",
              "READ_ONLY",
              "READ_WRITE",
              "USER"
            ],
            "type": "string"
          },
          "shareRecipientType": {
            "description": "The type of the recipient.",
            "enum": [
              "user",
              "group",
              "organization",
              "externalApplication"
            ],
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "role",
          "shareRecipientType"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array"
    },
    "next": {
      "description": "The URL pointing to the next page.",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL pointing to the previous page.",
      "type": [
        "string",
        "null"
      ]
    },
    "totalCount": {
      "description": "The total number of items matching the condition.",
      "type": "integer"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| count | integer | true |  | The number of items returned. |
| data | [AccessControlV2] | true | maxItems: 1000 | The access control list. |
| next | string,null | true |  | The URL pointing to the next page. |
| previous | string,null | true |  | The URL pointing to the previous page. |
| totalCount | integer | true |  | The total number of items matching the condition. |

## SpoolerChannelEventData

```
{
  "description": "Spooler channel event payload.",
  "properties": {
    "name": {
      "description": "Name or label of the spooler channel.",
      "maxLength": 512,
      "type": "string"
    },
    "type": {
      "description": "Type of the spooler channel.",
      "enum": [
        "asyncMemory",
        "filesystem",
        "kafka",
        "memory",
        "pubSub",
        "rabbitMQ",
        "sqs"
      ],
      "type": "string"
    }
  },
  "required": [
    "name",
    "type"
  ],
  "type": "object"
}
```

Spooler channel event payload.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| name | string | true | maxLength: 512 | Name or label of the spooler channel. |
| type | string | true |  | Type of the spooler channel. |

### Enumerated Values

| Property | Value |
| --- | --- |
| type | [asyncMemory, filesystem, kafka, memory, pubSub, rabbitMQ, sqs] |

## SuccessfulInviteData

```
{
  "description": "Details about the successful invite.",
  "properties": {
    "email": {
      "description": "The email address of the invited user.",
      "type": "string"
    },
    "userId": {
      "description": "The ID of the user.",
      "type": "string"
    }
  },
  "required": [
    "email",
    "userId"
  ],
  "type": "object",
  "x-versionadded": "v2.39"
}
```

Details about the successful invite.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| email | string | true |  | The email address of the invited user. |
| userId | string | true |  | The ID of the user. |

## UserNotificationListResponse

```
{
  "properties": {
    "count": {
      "description": "The number of items returned on this page.",
      "type": "integer"
    },
    "data": {
      "description": "The list of the user's notifications.",
      "items": {
        "properties": {
          "callerUser": {
            "description": "Details about the user who triggered the notification.",
            "properties": {
              "fullName": {
                "description": "User's full name.",
                "type": [
                  "string",
                  "null"
                ]
              },
              "gravatarHash": {
                "description": "User's gravatar hash.",
                "type": "string"
              },
              "inactive": {
                "description": "True if the user was deleted.",
                "type": "boolean"
              },
              "uid": {
                "description": "The ID of the user.",
                "type": "string"
              },
              "username": {
                "description": "The username of the user.",
                "type": "string"
              }
            },
            "required": [
              "uid"
            ],
            "type": "object"
          },
          "created": {
            "description": "The ISO 8601 formatted date and time when the notification was created.",
            "format": "date-time",
            "type": "string"
          },
          "data": {
            "description": "Notification type-specific metadata.",
            "oneOf": [
              {
                "properties": {
                  "failedInvites": {
                    "description": "Failed invites.",
                    "items": {
                      "description": "Details about why the invite failed.",
                      "properties": {
                        "email": {
                          "description": "The email address of the invited user.",
                          "type": "string"
                        },
                        "errorMessage": {
                          "description": "The error message explaining why the invite failed.",
                          "type": "string"
                        },
                        "userId": {
                          "description": "The ID of the user.",
                          "type": "string"
                        }
                      },
                      "required": [
                        "email",
                        "errorMessage",
                        "userId"
                      ],
                      "type": "object",
                      "x-versionadded": "v2.39"
                    },
                    "maxItems": 20,
                    "type": "array"
                  },
                  "jobId": {
                    "description": "The ID of the invite job.",
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "statusId": {
                    "description": "The ID of the invite job status.",
                    "type": "string",
                    "x-versionadded": "v2.40"
                  },
                  "successfulInvites": {
                    "description": "Successful invites.",
                    "items": {
                      "description": "Details about the successful invite.",
                      "properties": {
                        "email": {
                          "description": "The email address of the invited user.",
                          "type": "string"
                        },
                        "userId": {
                          "description": "The ID of the user.",
                          "type": "string"
                        }
                      },
                      "required": [
                        "email",
                        "userId"
                      ],
                      "type": "object",
                      "x-versionadded": "v2.39"
                    },
                    "maxItems": 20,
                    "type": "array"
                  }
                },
                "required": [
                  "failedInvites",
                  "jobId",
                  "statusId",
                  "successfulInvites"
                ],
                "type": "object",
                "x-versionadded": "v2.39"
              },
              {
                "type": "null"
              }
            ],
            "x-versionadded": "v2.39"
          },
          "description": {
            "description": "The notification description.",
            "type": [
              "string",
              "null"
            ]
          },
          "eventType": {
            "description": "The type of the notification.",
            "enum": [
              "autopilot.complete",
              "project.shared",
              "comment.created",
              "comment.updated",
              "model_deployments.service_health_red",
              "model_deployments.data_drift_red",
              "model_deployments.accuracy_red",
              "model_deployments.health.fairness_health.red",
              "model_deployments.health.custom_metrics_health.red",
              "model_deployments.predictions_timeliness_health_red",
              "model_deployments.actuals_timeliness_health_red",
              "misc.asset_access_request",
              "users_delete.preview_started",
              "users_delete.preview_completed",
              "users_delete.preview_failed",
              "perma_delete_project.failure",
              "perma_delete_project.success",
              "secure_config.shared",
              "entity_notification_policy_template.shared",
              "notification_channel_template.shared",
              "invite_job.completed"
            ],
            "type": "string"
          },
          "isRead": {
            "description": "True if the notification is already read.",
            "type": "boolean"
          },
          "link": {
            "description": "The call-to-action link for the notification.",
            "type": "string"
          },
          "pushNotificationSent": {
            "description": "True if the notification was also sent via push notifications.",
            "type": "boolean"
          },
          "relatedComment": {
            "description": "Details about the comment related to the notification.",
            "properties": {
              "commentId": {
                "description": "The ID of the comment.",
                "type": "string"
              },
              "commentLink": {
                "description": "The link to the comment.",
                "type": "string"
              },
              "entityId": {
                "description": "The ID of the commented entity.",
                "type": "string"
              },
              "entityType": {
                "description": "The type of the commented entity.",
                "enum": [
                  "useCase",
                  "model",
                  "catalog",
                  "experimentContainer",
                  "deployment",
                  "workloadDeployment",
                  "workload"
                ],
                "type": "string"
              },
              "inactive": {
                "description": "True if the comment was deleted.",
                "type": "boolean"
              }
            },
            "required": [
              "commentId",
              "entityId"
            ],
            "type": "object"
          },
          "relatedDeployment": {
            "description": "Details about the deployment related to the notification.",
            "properties": {
              "deploymentId": {
                "description": "The ID of the deployment.",
                "type": "string"
              },
              "deploymentName": {
                "description": "The deployment label.",
                "type": [
                  "string",
                  "null"
                ]
              },
              "deploymentUrl": {
                "description": "The link to the deployment.",
                "type": "string"
              },
              "inactive": {
                "description": "True if the deployment was deleted.",
                "type": "boolean"
              },
              "modelId": {
                "description": "The ID of the related model.",
                "type": [
                  "string",
                  "null"
                ]
              },
              "projectId": {
                "description": "The ID of the related project.",
                "type": [
                  "string",
                  "null"
                ]
              },
              "userId": {
                "description": "The ID of the related user.",
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "deploymentId"
            ],
            "type": "object"
          },
          "relatedProject": {
            "description": "Details about the project related to the notification.",
            "properties": {
              "inactive": {
                "description": "True if the project was deleted.",
                "type": "boolean"
              },
              "pid": {
                "description": "The ID of the project.",
                "type": "string"
              },
              "projectLink": {
                "description": "The link to the project.",
                "type": "string"
              },
              "projectName": {
                "description": "The project name.",
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "pid"
            ],
            "type": "object"
          },
          "relatedSecureConfig": {
            "description": "Details about the secure config related to the notification.",
            "properties": {
              "secureConfigLink": {
                "description": "The link to the secure config.",
                "type": "string"
              },
              "secureConfigName": {
                "description": "The name of the secure config.",
                "type": "string"
              },
              "secureConfigSchemaName": {
                "description": "The type UUID of the secure config.",
                "type": "string"
              },
              "secureConfigSchemaUuid": {
                "description": "The type name of the secure config.",
                "type": "string"
              },
              "secureConfigUuid": {
                "description": "The ID of the secure config.",
                "type": "string"
              }
            },
            "required": [
              "secureConfigLink",
              "secureConfigName",
              "secureConfigSchemaName",
              "secureConfigSchemaUuid",
              "secureConfigUuid"
            ],
            "type": "object"
          },
          "relatedUsersDelete": {
            "description": "Details about the users permanent delete.",
            "properties": {
              "reportId": {
                "description": "The ID of the user's permanent delete report.",
                "type": "string"
              },
              "statusId": {
                "description": "The ID of the user's delete status.",
                "type": "string"
              },
              "usersToDeleteCount": {
                "description": "The number of users that will be deleted.",
                "type": "string"
              }
            },
            "required": [
              "reportId",
              "statusId",
              "usersToDeleteCount"
            ],
            "type": "object"
          },
          "sharedUsers": {
            "description": "The list of the user details a resource was shared with.",
            "items": {
              "description": "Details about the user who triggered the notification.",
              "properties": {
                "fullName": {
                  "description": "User's full name.",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "gravatarHash": {
                  "description": "User's gravatar hash.",
                  "type": "string"
                },
                "inactive": {
                  "description": "True if the user was deleted.",
                  "type": "boolean"
                },
                "uid": {
                  "description": "The ID of the user.",
                  "type": "string"
                },
                "username": {
                  "description": "The username of the user.",
                  "type": "string"
                }
              },
              "required": [
                "uid"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "statusId": {
            "description": "The asynchronous job status ID.",
            "type": "string"
          },
          "title": {
            "description": "The notification title.",
            "type": [
              "string",
              "null"
            ]
          },
          "tooltip": {
            "description": "The notification tooltip.",
            "type": [
              "string",
              "null"
            ]
          },
          "updated": {
            "description": "The ISO 8601 formatted date and time when the notification was updated.",
            "format": "date-time",
            "type": "string"
          },
          "userNotificationId": {
            "description": "The ID of the notification.",
            "type": "string"
          }
        },
        "required": [
          "callerUser",
          "created",
          "description",
          "eventType",
          "isRead",
          "link",
          "pushNotificationSent",
          "title",
          "tooltip",
          "updated",
          "userNotificationId"
        ],
        "type": "object"
      },
      "maxItems": 1000,
      "type": "array"
    },
    "next": {
      "description": "The URL of the next page (if null, there is no next page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL of the previous page (if null, there is no previous page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "totalCount": {
      "description": "The total number of items across all pages.",
      "type": "integer"
    }
  },
  "required": [
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| count | integer | false |  | The number of items returned on this page. |
| data | [UserNotificationResponse] | true | maxItems: 1000 | The list of the user's notifications. |
| next | string,null(uri) | true |  | The URL of the next page (if null, there is no next page). |
| previous | string,null(uri) | true |  | The URL of the previous page (if null, there is no previous page). |
| totalCount | integer | true |  | The total number of items across all pages. |

## UserNotificationRelatedCommentResponse

```
{
  "description": "Details about the comment related to the notification.",
  "properties": {
    "commentId": {
      "description": "The ID of the comment.",
      "type": "string"
    },
    "commentLink": {
      "description": "The link to the comment.",
      "type": "string"
    },
    "entityId": {
      "description": "The ID of the commented entity.",
      "type": "string"
    },
    "entityType": {
      "description": "The type of the commented entity.",
      "enum": [
        "useCase",
        "model",
        "catalog",
        "experimentContainer",
        "deployment",
        "workloadDeployment",
        "workload"
      ],
      "type": "string"
    },
    "inactive": {
      "description": "True if the comment was deleted.",
      "type": "boolean"
    }
  },
  "required": [
    "commentId",
    "entityId"
  ],
  "type": "object"
}
```

Details about the comment related to the notification.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| commentId | string | true |  | The ID of the comment. |
| commentLink | string | false |  | The link to the comment. |
| entityId | string | true |  | The ID of the commented entity. |
| entityType | string | false |  | The type of the commented entity. |
| inactive | boolean | false |  | True if the comment was deleted. |

### Enumerated Values

| Property | Value |
| --- | --- |
| entityType | [useCase, model, catalog, experimentContainer, deployment, workloadDeployment, workload] |

## UserNotificationRelatedDeploymentResponse

```
{
  "description": "Details about the deployment related to the notification.",
  "properties": {
    "deploymentId": {
      "description": "The ID of the deployment.",
      "type": "string"
    },
    "deploymentName": {
      "description": "The deployment label.",
      "type": [
        "string",
        "null"
      ]
    },
    "deploymentUrl": {
      "description": "The link to the deployment.",
      "type": "string"
    },
    "inactive": {
      "description": "True if the deployment was deleted.",
      "type": "boolean"
    },
    "modelId": {
      "description": "The ID of the related model.",
      "type": [
        "string",
        "null"
      ]
    },
    "projectId": {
      "description": "The ID of the related project.",
      "type": [
        "string",
        "null"
      ]
    },
    "userId": {
      "description": "The ID of the related user.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "deploymentId"
  ],
  "type": "object"
}
```

Details about the deployment related to the notification.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| deploymentId | string | true |  | The ID of the deployment. |
| deploymentName | string,null | false |  | The deployment label. |
| deploymentUrl | string | false |  | The link to the deployment. |
| inactive | boolean | false |  | True if the deployment was deleted. |
| modelId | string,null | false |  | The ID of the related model. |
| projectId | string,null | false |  | The ID of the related project. |
| userId | string,null | false |  | The ID of the related user. |

## UserNotificationRelatedProjectResponse

```
{
  "description": "Details about the project related to the notification.",
  "properties": {
    "inactive": {
      "description": "True if the project was deleted.",
      "type": "boolean"
    },
    "pid": {
      "description": "The ID of the project.",
      "type": "string"
    },
    "projectLink": {
      "description": "The link to the project.",
      "type": "string"
    },
    "projectName": {
      "description": "The project name.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "pid"
  ],
  "type": "object"
}
```

Details about the project related to the notification.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| inactive | boolean | false |  | True if the project was deleted. |
| pid | string | true |  | The ID of the project. |
| projectLink | string | false |  | The link to the project. |
| projectName | string,null | false |  | The project name. |

## UserNotificationRelatedSecureConfigResponse

```
{
  "description": "Details about the secure config related to the notification.",
  "properties": {
    "secureConfigLink": {
      "description": "The link to the secure config.",
      "type": "string"
    },
    "secureConfigName": {
      "description": "The name of the secure config.",
      "type": "string"
    },
    "secureConfigSchemaName": {
      "description": "The type UUID of the secure config.",
      "type": "string"
    },
    "secureConfigSchemaUuid": {
      "description": "The type name of the secure config.",
      "type": "string"
    },
    "secureConfigUuid": {
      "description": "The ID of the secure config.",
      "type": "string"
    }
  },
  "required": [
    "secureConfigLink",
    "secureConfigName",
    "secureConfigSchemaName",
    "secureConfigSchemaUuid",
    "secureConfigUuid"
  ],
  "type": "object"
}
```

Details about the secure config related to the notification.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| secureConfigLink | string | true |  | The link to the secure config. |
| secureConfigName | string | true |  | The name of the secure config. |
| secureConfigSchemaName | string | true |  | The type UUID of the secure config. |
| secureConfigSchemaUuid | string | true |  | The type name of the secure config. |
| secureConfigUuid | string | true |  | The ID of the secure config. |

## UserNotificationRelatedUserResponse

```
{
  "description": "Details about the user who triggered the notification.",
  "properties": {
    "fullName": {
      "description": "User's full name.",
      "type": [
        "string",
        "null"
      ]
    },
    "gravatarHash": {
      "description": "User's gravatar hash.",
      "type": "string"
    },
    "inactive": {
      "description": "True if the user was deleted.",
      "type": "boolean"
    },
    "uid": {
      "description": "The ID of the user.",
      "type": "string"
    },
    "username": {
      "description": "The username of the user.",
      "type": "string"
    }
  },
  "required": [
    "uid"
  ],
  "type": "object"
}
```

Details about the user who triggered the notification.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| fullName | string,null | false |  | User's full name. |
| gravatarHash | string | false |  | User's gravatar hash. |
| inactive | boolean | false |  | True if the user was deleted. |
| uid | string | true |  | The ID of the user. |
| username | string | false |  | The username of the user. |

## UserNotificationRelatedUsersDeleteResponse

```
{
  "description": "Details about the users permanent delete.",
  "properties": {
    "reportId": {
      "description": "The ID of the user's permanent delete report.",
      "type": "string"
    },
    "statusId": {
      "description": "The ID of the user's delete status.",
      "type": "string"
    },
    "usersToDeleteCount": {
      "description": "The number of users that will be deleted.",
      "type": "string"
    }
  },
  "required": [
    "reportId",
    "statusId",
    "usersToDeleteCount"
  ],
  "type": "object"
}
```

Details about the users permanent delete.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| reportId | string | true |  | The ID of the user's permanent delete report. |
| statusId | string | true |  | The ID of the user's delete status. |
| usersToDeleteCount | string | true |  | The number of users that will be deleted. |

## UserNotificationResponse

```
{
  "properties": {
    "callerUser": {
      "description": "Details about the user who triggered the notification.",
      "properties": {
        "fullName": {
          "description": "User's full name.",
          "type": [
            "string",
            "null"
          ]
        },
        "gravatarHash": {
          "description": "User's gravatar hash.",
          "type": "string"
        },
        "inactive": {
          "description": "True if the user was deleted.",
          "type": "boolean"
        },
        "uid": {
          "description": "The ID of the user.",
          "type": "string"
        },
        "username": {
          "description": "The username of the user.",
          "type": "string"
        }
      },
      "required": [
        "uid"
      ],
      "type": "object"
    },
    "created": {
      "description": "The ISO 8601 formatted date and time when the notification was created.",
      "format": "date-time",
      "type": "string"
    },
    "data": {
      "description": "Notification type-specific metadata.",
      "oneOf": [
        {
          "properties": {
            "failedInvites": {
              "description": "Failed invites.",
              "items": {
                "description": "Details about why the invite failed.",
                "properties": {
                  "email": {
                    "description": "The email address of the invited user.",
                    "type": "string"
                  },
                  "errorMessage": {
                    "description": "The error message explaining why the invite failed.",
                    "type": "string"
                  },
                  "userId": {
                    "description": "The ID of the user.",
                    "type": "string"
                  }
                },
                "required": [
                  "email",
                  "errorMessage",
                  "userId"
                ],
                "type": "object",
                "x-versionadded": "v2.39"
              },
              "maxItems": 20,
              "type": "array"
            },
            "jobId": {
              "description": "The ID of the invite job.",
              "type": [
                "string",
                "null"
              ]
            },
            "statusId": {
              "description": "The ID of the invite job status.",
              "type": "string",
              "x-versionadded": "v2.40"
            },
            "successfulInvites": {
              "description": "Successful invites.",
              "items": {
                "description": "Details about the successful invite.",
                "properties": {
                  "email": {
                    "description": "The email address of the invited user.",
                    "type": "string"
                  },
                  "userId": {
                    "description": "The ID of the user.",
                    "type": "string"
                  }
                },
                "required": [
                  "email",
                  "userId"
                ],
                "type": "object",
                "x-versionadded": "v2.39"
              },
              "maxItems": 20,
              "type": "array"
            }
          },
          "required": [
            "failedInvites",
            "jobId",
            "statusId",
            "successfulInvites"
          ],
          "type": "object",
          "x-versionadded": "v2.39"
        },
        {
          "type": "null"
        }
      ],
      "x-versionadded": "v2.39"
    },
    "description": {
      "description": "The notification description.",
      "type": [
        "string",
        "null"
      ]
    },
    "eventType": {
      "description": "The type of the notification.",
      "enum": [
        "autopilot.complete",
        "project.shared",
        "comment.created",
        "comment.updated",
        "model_deployments.service_health_red",
        "model_deployments.data_drift_red",
        "model_deployments.accuracy_red",
        "model_deployments.health.fairness_health.red",
        "model_deployments.health.custom_metrics_health.red",
        "model_deployments.predictions_timeliness_health_red",
        "model_deployments.actuals_timeliness_health_red",
        "misc.asset_access_request",
        "users_delete.preview_started",
        "users_delete.preview_completed",
        "users_delete.preview_failed",
        "perma_delete_project.failure",
        "perma_delete_project.success",
        "secure_config.shared",
        "entity_notification_policy_template.shared",
        "notification_channel_template.shared",
        "invite_job.completed"
      ],
      "type": "string"
    },
    "isRead": {
      "description": "True if the notification is already read.",
      "type": "boolean"
    },
    "link": {
      "description": "The call-to-action link for the notification.",
      "type": "string"
    },
    "pushNotificationSent": {
      "description": "True if the notification was also sent via push notifications.",
      "type": "boolean"
    },
    "relatedComment": {
      "description": "Details about the comment related to the notification.",
      "properties": {
        "commentId": {
          "description": "The ID of the comment.",
          "type": "string"
        },
        "commentLink": {
          "description": "The link to the comment.",
          "type": "string"
        },
        "entityId": {
          "description": "The ID of the commented entity.",
          "type": "string"
        },
        "entityType": {
          "description": "The type of the commented entity.",
          "enum": [
            "useCase",
            "model",
            "catalog",
            "experimentContainer",
            "deployment",
            "workloadDeployment",
            "workload"
          ],
          "type": "string"
        },
        "inactive": {
          "description": "True if the comment was deleted.",
          "type": "boolean"
        }
      },
      "required": [
        "commentId",
        "entityId"
      ],
      "type": "object"
    },
    "relatedDeployment": {
      "description": "Details about the deployment related to the notification.",
      "properties": {
        "deploymentId": {
          "description": "The ID of the deployment.",
          "type": "string"
        },
        "deploymentName": {
          "description": "The deployment label.",
          "type": [
            "string",
            "null"
          ]
        },
        "deploymentUrl": {
          "description": "The link to the deployment.",
          "type": "string"
        },
        "inactive": {
          "description": "True if the deployment was deleted.",
          "type": "boolean"
        },
        "modelId": {
          "description": "The ID of the related model.",
          "type": [
            "string",
            "null"
          ]
        },
        "projectId": {
          "description": "The ID of the related project.",
          "type": [
            "string",
            "null"
          ]
        },
        "userId": {
          "description": "The ID of the related user.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "deploymentId"
      ],
      "type": "object"
    },
    "relatedProject": {
      "description": "Details about the project related to the notification.",
      "properties": {
        "inactive": {
          "description": "True if the project was deleted.",
          "type": "boolean"
        },
        "pid": {
          "description": "The ID of the project.",
          "type": "string"
        },
        "projectLink": {
          "description": "The link to the project.",
          "type": "string"
        },
        "projectName": {
          "description": "The project name.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "pid"
      ],
      "type": "object"
    },
    "relatedSecureConfig": {
      "description": "Details about the secure config related to the notification.",
      "properties": {
        "secureConfigLink": {
          "description": "The link to the secure config.",
          "type": "string"
        },
        "secureConfigName": {
          "description": "The name of the secure config.",
          "type": "string"
        },
        "secureConfigSchemaName": {
          "description": "The type UUID of the secure config.",
          "type": "string"
        },
        "secureConfigSchemaUuid": {
          "description": "The type name of the secure config.",
          "type": "string"
        },
        "secureConfigUuid": {
          "description": "The ID of the secure config.",
          "type": "string"
        }
      },
      "required": [
        "secureConfigLink",
        "secureConfigName",
        "secureConfigSchemaName",
        "secureConfigSchemaUuid",
        "secureConfigUuid"
      ],
      "type": "object"
    },
    "relatedUsersDelete": {
      "description": "Details about the users permanent delete.",
      "properties": {
        "reportId": {
          "description": "The ID of the user's permanent delete report.",
          "type": "string"
        },
        "statusId": {
          "description": "The ID of the user's delete status.",
          "type": "string"
        },
        "usersToDeleteCount": {
          "description": "The number of users that will be deleted.",
          "type": "string"
        }
      },
      "required": [
        "reportId",
        "statusId",
        "usersToDeleteCount"
      ],
      "type": "object"
    },
    "sharedUsers": {
      "description": "The list of the user details a resource was shared with.",
      "items": {
        "description": "Details about the user who triggered the notification.",
        "properties": {
          "fullName": {
            "description": "User's full name.",
            "type": [
              "string",
              "null"
            ]
          },
          "gravatarHash": {
            "description": "User's gravatar hash.",
            "type": "string"
          },
          "inactive": {
            "description": "True if the user was deleted.",
            "type": "boolean"
          },
          "uid": {
            "description": "The ID of the user.",
            "type": "string"
          },
          "username": {
            "description": "The username of the user.",
            "type": "string"
          }
        },
        "required": [
          "uid"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "statusId": {
      "description": "The asynchronous job status ID.",
      "type": "string"
    },
    "title": {
      "description": "The notification title.",
      "type": [
        "string",
        "null"
      ]
    },
    "tooltip": {
      "description": "The notification tooltip.",
      "type": [
        "string",
        "null"
      ]
    },
    "updated": {
      "description": "The ISO 8601 formatted date and time when the notification was updated.",
      "format": "date-time",
      "type": "string"
    },
    "userNotificationId": {
      "description": "The ID of the notification.",
      "type": "string"
    }
  },
  "required": [
    "callerUser",
    "created",
    "description",
    "eventType",
    "isRead",
    "link",
    "pushNotificationSent",
    "title",
    "tooltip",
    "updated",
    "userNotificationId"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| callerUser | UserNotificationRelatedUserResponse | true |  | Details about the user who triggered the notification. |
| created | string(date-time) | true |  | The ISO 8601 formatted date and time when the notification was created. |
| data | any | false |  | Notification type-specific metadata. |

oneOf

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | InviteJobNotificationData | false |  | none |

xor

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | null | false |  | none |

continued

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| description | string,null | true |  | The notification description. |
| eventType | string | true |  | The type of the notification. |
| isRead | boolean | true |  | True if the notification is already read. |
| link | string | true |  | The call-to-action link for the notification. |
| pushNotificationSent | boolean | true |  | True if the notification was also sent via push notifications. |
| relatedComment | UserNotificationRelatedCommentResponse | false |  | Details about the comment related to the notification. |
| relatedDeployment | UserNotificationRelatedDeploymentResponse | false |  | Details about the deployment related to the notification. |
| relatedProject | UserNotificationRelatedProjectResponse | false |  | Details about the project related to the notification. |
| relatedSecureConfig | UserNotificationRelatedSecureConfigResponse | false |  | Details about the secure config related to the notification. |
| relatedUsersDelete | UserNotificationRelatedUsersDeleteResponse | false |  | Details about the users permanent delete. |
| sharedUsers | [UserNotificationRelatedUserResponse] | false |  | The list of the user details a resource was shared with. |
| statusId | string | false |  | The asynchronous job status ID. |
| title | string,null | true |  | The notification title. |
| tooltip | string,null | true |  | The notification tooltip. |
| updated | string(date-time) | true |  | The ISO 8601 formatted date and time when the notification was updated. |
| userNotificationId | string | true |  | The ID of the notification. |

### Enumerated Values

| Property | Value |
| --- | --- |
| eventType | [autopilot.complete, project.shared, comment.created, comment.updated, model_deployments.service_health_red, model_deployments.data_drift_red, model_deployments.accuracy_red, model_deployments.health.fairness_health.red, model_deployments.health.custom_metrics_health.red, model_deployments.predictions_timeliness_health_red, model_deployments.actuals_timeliness_health_red, misc.asset_access_request, users_delete.preview_started, users_delete.preview_completed, users_delete.preview_failed, perma_delete_project.failure, perma_delete_project.success, secure_config.shared, entity_notification_policy_template.shared, notification_channel_template.shared, invite_job.completed] |