---
title: "Create a Notification Setting"
method: POST
path: "/notification_settings"
tags: ["Notifications"]
---

# Create a Notification Setting

`POST /notification_settings`

## Request

- Base URL: `https://dataops.nexla.io/nexla-api`
- URL: `https://dataops.nexla.io/nexla-api/notification_settings`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nexla/apis/nexla-rest-api/docs/notification_settings/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a setting to designate whether, when, and how a specific notification should be fired.

## Request body

- NotificationSettingCreateRequired
  - `channel` 'APP' | 'EMAIL' | 'SMS' | 'SLACK' | 'WEBHOOKS', required
  - `status` 'PAUSED' | 'ACTIVE': Whether or not the user should be notified about this event for this resource on the selected channel.
  - `config` object: Configuration properties for customizing the criteria for firing the event.
  - `notification_resource_type` 'ORG' | 'USER' | 'DATA_FLOW' | 'CUSTOM_DATA_FLOW' | 'SOURCE' | 'DATASET' | 'SINK'
  - `resource_id` integer
  - `checked` boolean
  - `notification_channel_setting_id` integer
  - `notification_type_id` integer, required

## Response `200`

Success

- NotificationSetting
  - `id` integer
  - `org_id` integer
  - `owner_id` integer
  - `channel` 'APP' | 'EMAIL' | 'SMS' | 'SLACK' | 'WEBHOOKS'
  - `notification_resource_type` 'ORG' | 'USER' | 'DATA_FLOW' | 'CUSTOM_DATA_FLOW' | 'SOURCE' | 'DATASET' | 'SINK'
  - `resource_id` integer
  - `config` object
  - `priority` integer
  - `status` 'PAUSED' | 'ACTIVE': Whether or not the user should be notified about this event for this resource on the selected channel.
  - `notification_type_id` integer
  - `name` string
  - `description` string
  - `code` integer
  - `category` string
  - `event_type` 'SHARE' | 'CREATE' | 'DELETE' | 'UPDATE' | 'ACTIVATE' | 'PAUSE' | 'METRICS' | 'RESETPASS' | 'ERROR_AGGREGATED' | 'ERROR' | 'MONITOR' | 'WRITE' | 'EMPTY_DATA' | 'READ_START' | 'READ_DONE' | 'WRITE_START' | 'WRITE_DONE'
  - `resource_type` 'ORG' | 'USER' | 'DATA_FLOW' | 'CUSTOM_DATA_FLOW' | 'SOURCE' | 'DATASET' | 'SINK'

## Other responses

- `400`: Bad Request
- `403`: Forbidden

---

[API](https://skmtc.dev/nexla/apis/nexla-rest-api.md) - [All operations](https://skmtc.dev/nexla/apis/nexla-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nexla/apis/nexla-rest-api/revisions/ef02be92fe7b?raw)