--- title: Create a notification rule description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Case Management --- # Create a notification rule{% #create-a-notification-rule %} {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/cases/projects/{project_id}/notification_rules | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/cases/projects/{project_id}/notification_rules | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/cases/projects/{project_id}/notification_rules | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/cases/projects/{project_id}/notification_rules | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/cases/projects/{project_id}/notification_rules | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/cases/projects/{project_id}/notification_rules | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/cases/projects/{project_id}/notification_rules | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/cases/projects/{project_id}/notification_rules | ### Overview Create a notification rule for a project. OAuth apps require the `cases_write` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#case-management) to access this endpoint. ### Arguments #### Path Parameters | Name | Type | Description | | ---------------------------- | ------ | ------------ | | project_id [*required*] | string | Project UUID | ### Request #### Body Data (required) Notification rule payload {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ---------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Notification rule create | | data | attributes [*required*] | object | Notification rule creation attributes | | attributes | is_enabled | boolean | Whether the notification rule is enabled | | attributes | query | string | Query to filter cases for this notification rule | | attributes | recipients [*required*] | [object] | List of notification recipients | | recipients | data | object | Recipient data | | data | channel | string | Slack channel name | | data | channel_id | string | Slack channel ID | | data | channel_name | string | Microsoft Teams channel name | | data | connector_name | string | Microsoft Teams connector name | | data | email | string | Email address | | data | name | string | HTTP webhook name | | data | service_name | string | PagerDuty service name | | data | team_id | string | Microsoft Teams team ID | | data | team_name | string | Microsoft Teams team name | | data | tenant_id | string | Microsoft Teams tenant ID | | data | tenant_name | string | Microsoft Teams tenant name | | data | workspace | string | Slack workspace name | | data | workspace_id | string | Slack workspace ID | | recipients | type | string | Type of recipient (SLACK_CHANNEL, EMAIL, HTTP, PAGERDUTY_SERVICE, MS_TEAMS_CHANNEL) | | attributes | triggers [*required*] | [object] | List of triggers for this notification rule | | triggers | data | object | Trigger data | | data | change_type | string | Change type (added, removed, changed) | | data | field | string | Field name for attribute value changed trigger | | data | from_status | string | Status ID to transition from | | data | from_status_name | string | Status name to transition from | | data | to_status | string | Status ID to transition to | | data | to_status_name | string | Status name to transition to | | triggers | type | string | Type of trigger (CASE_CREATED, STATUS_TRANSITIONED, ATTRIBUTE_VALUE_CHANGED, EVENT_CORRELATION_SIGNAL_CORRELATED) | | data | type [*required*] | enum | Notification rule resource type Allowed enum values: `notification_rule` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "is_enabled": false, "query": "string", "recipients": [ { "data": { "channel": "string", "channel_id": "string", "channel_name": "string", "connector_name": "string", "email": "string", "name": "string", "service_name": "string", "team_id": "string", "team_name": "string", "tenant_id": "string", "tenant_name": "string", "workspace": "string", "workspace_id": "string" }, "type": "EMAIL" } ], "triggers": [ { "data": { "change_type": "string", "field": "string", "from_status": "string", "from_status_name": "string", "to_status": "string", "to_status_name": "string" }, "type": "CASE_CREATED" } ] }, "type": "notification_rule" } } ``` {% /tab %} ### Response {% tab title="201" %} CREATED {% tab title="Model" %} Notification rule response | Parent field | Field | Type | Description | | ------------ | ---------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------- | | | data | object | A notification rule for case management | | data | attributes [*required*] | object | Notification rule attributes | | attributes | is_enabled | boolean | Whether the notification rule is enabled | | attributes | query | string | Query to filter cases for this notification rule | | attributes | recipients | [object] | List of notification recipients | | recipients | data | object | Recipient data | | data | channel | string | Slack channel name | | data | channel_id | string | Slack channel ID | | data | channel_name | string | Microsoft Teams channel name | | data | connector_name | string | Microsoft Teams connector name | | data | email | string | Email address | | data | name | string | HTTP webhook name | | data | service_name | string | PagerDuty service name | | data | team_id | string | Microsoft Teams team ID | | data | team_name | string | Microsoft Teams team name | | data | tenant_id | string | Microsoft Teams tenant ID | | data | tenant_name | string | Microsoft Teams tenant name | | data | workspace | string | Slack workspace name | | data | workspace_id | string | Slack workspace ID | | recipients | type | string | Type of recipient (SLACK_CHANNEL, EMAIL, HTTP, PAGERDUTY_SERVICE, MS_TEAMS_CHANNEL) | | attributes | triggers | [object] | List of triggers for this notification rule | | triggers | data | object | Trigger data | | data | change_type | string | Change type (added, removed, changed) | | data | field | string | Field name for attribute value changed trigger | | data | from_status | string | Status ID to transition from | | data | from_status_name | string | Status name to transition from | | data | to_status | string | Status ID to transition to | | data | to_status_name | string | Status name to transition to | | triggers | type | string | Type of trigger (CASE_CREATED, STATUS_TRANSITIONED, ATTRIBUTE_VALUE_CHANGED, EVENT_CORRELATION_SIGNAL_CORRELATED) | | data | id [*required*] | string | The notification rule's identifier | | data | type [*required*] | enum | Notification rule resource type Allowed enum values: `notification_rule` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "is_enabled": false, "query": "string", "recipients": [ { "data": { "channel": "string", "channel_id": "string", "channel_name": "string", "connector_name": "string", "email": "string", "name": "string", "service_name": "string", "team_id": "string", "team_name": "string", "tenant_id": "string", "tenant_name": "string", "workspace": "string", "workspace_id": "string" }, "type": "EMAIL" } ], "triggers": [ { "data": { "change_type": "string", "field": "string", "from_status": "string", "from_status_name": "string", "to_status": "string", "to_status_name": "string" }, "type": "CASE_CREATED" } ] }, "id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", "type": "notification_rule" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="401" %} Unauthorized {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Path parameters export project_id="e555e290-ed65-49bd-ae18-8acbfcf18db7" \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/cases/projects/${project_id}/notification_rules" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "recipients": [ { "type": "EMAIL" } ], "triggers": [ { "type": "CASE_CREATED" } ] }, "type": "notification_rule" } } EOF ##### ```python """ Create a notification rule returns "CREATED" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.case_management_api import CaseManagementApi from datadog_api_client.v2.model.case_notification_rule_create import CaseNotificationRuleCreate from datadog_api_client.v2.model.case_notification_rule_create_attributes import CaseNotificationRuleCreateAttributes from datadog_api_client.v2.model.case_notification_rule_create_request import CaseNotificationRuleCreateRequest from datadog_api_client.v2.model.case_notification_rule_recipient import CaseNotificationRuleRecipient from datadog_api_client.v2.model.case_notification_rule_recipient_data import CaseNotificationRuleRecipientData from datadog_api_client.v2.model.case_notification_rule_resource_type import CaseNotificationRuleResourceType from datadog_api_client.v2.model.case_notification_rule_trigger import CaseNotificationRuleTrigger from datadog_api_client.v2.model.case_notification_rule_trigger_data import CaseNotificationRuleTriggerData body = CaseNotificationRuleCreateRequest( data=CaseNotificationRuleCreate( attributes=CaseNotificationRuleCreateAttributes( is_enabled=True, recipients=[ CaseNotificationRuleRecipient( data=CaseNotificationRuleRecipientData(), type="EMAIL", ), ], triggers=[ CaseNotificationRuleTrigger( data=CaseNotificationRuleTriggerData(), type="CASE_CREATED", ), ], ), type=CaseNotificationRuleResourceType.NOTIFICATION_RULE, ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = CaseManagementApi(api_client) response = api_instance.create_project_notification_rule(project_id="project_id", body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Create a notification rule returns "CREATED" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::CaseManagementAPI.new body = DatadogAPIClient::V2::CaseNotificationRuleCreateRequest.new({ data: DatadogAPIClient::V2::CaseNotificationRuleCreate.new({ attributes: DatadogAPIClient::V2::CaseNotificationRuleCreateAttributes.new({ is_enabled: true, recipients: [ DatadogAPIClient::V2::CaseNotificationRuleRecipient.new({ data: DatadogAPIClient::V2::CaseNotificationRuleRecipientData.new({}), type: "EMAIL", }), ], triggers: [ DatadogAPIClient::V2::CaseNotificationRuleTrigger.new({ data: DatadogAPIClient::V2::CaseNotificationRuleTriggerData.new({}), type: "CASE_CREATED", }), ], }), type: DatadogAPIClient::V2::CaseNotificationRuleResourceType::NOTIFICATION_RULE, }), }) p api_instance.create_project_notification_rule("project_id", body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Create a notification rule returns "CREATED" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { body := datadogV2.CaseNotificationRuleCreateRequest{ Data: datadogV2.CaseNotificationRuleCreate{ Attributes: datadogV2.CaseNotificationRuleCreateAttributes{ IsEnabled: datadog.PtrBool(true), Recipients: []datadogV2.CaseNotificationRuleRecipient{ { Data: &datadogV2.CaseNotificationRuleRecipientData{}, Type: datadog.PtrString("EMAIL"), }, }, Triggers: []datadogV2.CaseNotificationRuleTrigger{ { Data: &datadogV2.CaseNotificationRuleTriggerData{}, Type: datadog.PtrString("CASE_CREATED"), }, }, }, Type: datadogV2.CASENOTIFICATIONRULERESOURCETYPE_NOTIFICATION_RULE, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewCaseManagementApi(apiClient) resp, r, err := api.CreateProjectNotificationRule(ctx, "project_id", body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `CaseManagementApi.CreateProjectNotificationRule`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `CaseManagementApi.CreateProjectNotificationRule`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Create a notification rule returns "CREATED" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.CaseManagementApi; import com.datadog.api.client.v2.model.CaseNotificationRuleCreate; import com.datadog.api.client.v2.model.CaseNotificationRuleCreateAttributes; import com.datadog.api.client.v2.model.CaseNotificationRuleCreateRequest; import com.datadog.api.client.v2.model.CaseNotificationRuleRecipient; import com.datadog.api.client.v2.model.CaseNotificationRuleRecipientData; import com.datadog.api.client.v2.model.CaseNotificationRuleResourceType; import com.datadog.api.client.v2.model.CaseNotificationRuleResponse; import com.datadog.api.client.v2.model.CaseNotificationRuleTrigger; import com.datadog.api.client.v2.model.CaseNotificationRuleTriggerData; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); CaseManagementApi apiInstance = new CaseManagementApi(defaultClient); CaseNotificationRuleCreateRequest body = new CaseNotificationRuleCreateRequest() .data( new CaseNotificationRuleCreate() .attributes( new CaseNotificationRuleCreateAttributes() .isEnabled(true) .recipients( Collections.singletonList( new CaseNotificationRuleRecipient() .data(new CaseNotificationRuleRecipientData()) .type("EMAIL"))) .triggers( Collections.singletonList( new CaseNotificationRuleTrigger() .data(new CaseNotificationRuleTriggerData()) .type("CASE_CREATED")))) .type(CaseNotificationRuleResourceType.NOTIFICATION_RULE)); try { CaseNotificationRuleResponse result = apiInstance.createProjectNotificationRule("e555e290-ed65-49bd-ae18-8acbfcf18db7", body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling CaseManagementApi#createProjectNotificationRule"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Create a notification rule returns "CREATED" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_case_management::CaseManagementAPI; use datadog_api_client::datadogV2::model::CaseNotificationRuleCreate; use datadog_api_client::datadogV2::model::CaseNotificationRuleCreateAttributes; use datadog_api_client::datadogV2::model::CaseNotificationRuleCreateRequest; use datadog_api_client::datadogV2::model::CaseNotificationRuleRecipient; use datadog_api_client::datadogV2::model::CaseNotificationRuleRecipientData; use datadog_api_client::datadogV2::model::CaseNotificationRuleResourceType; use datadog_api_client::datadogV2::model::CaseNotificationRuleTrigger; use datadog_api_client::datadogV2::model::CaseNotificationRuleTriggerData; #[tokio::main] async fn main() { let body = CaseNotificationRuleCreateRequest::new(CaseNotificationRuleCreate::new( CaseNotificationRuleCreateAttributes::new( vec![CaseNotificationRuleRecipient::new() .data(CaseNotificationRuleRecipientData::new()) .type_("EMAIL".to_string())], vec![CaseNotificationRuleTrigger::new() .data(CaseNotificationRuleTriggerData::new()) .type_("CASE_CREATED".to_string())], ) .is_enabled(true), CaseNotificationRuleResourceType::NOTIFICATION_RULE, )); let configuration = datadog::Configuration::new(); let api = CaseManagementAPI::with_config(configuration); let resp = api .create_project_notification_rule("project_id".to_string(), body) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Create a notification rule returns "CREATED" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.CaseManagementApi(configuration); const params: v2.CaseManagementApiCreateProjectNotificationRuleRequest = { body: { data: { attributes: { isEnabled: true, recipients: [ { data: {}, type: "EMAIL", }, ], triggers: [ { data: {}, type: "CASE_CREATED", }, ], }, type: "notification_rule", }, }, projectId: "project_id", }; apiInstance .createProjectNotificationRule(params) .then((data: v2.CaseNotificationRuleResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}