---
title: "Create a new notification setting"
method: POST
path: "/notifications/settings"
tags: ["Notifications"]
---

# Create a new notification setting

`POST /notifications/settings`

Create a new notification setting

## Request body

- NotificationSetting
  - `_id` string — MongoDB ObjectId represented as a hexadecimal string
  - `name` string — Name of the notification setting
  - `description` string — Description of the notification setting
  - `type` 'task_finished' | 'task_error' | 'spider_created' | 'schedule_created' — Type of event to trigger notification
  - `enabled` boolean — Whether this notification setting is enabled
  - `channel_id` string — MongoDB ObjectId represented as a hexadecimal string
  - `template` string — Message template for the notification
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `created_by` string — MongoDB ObjectId represented as a hexadecimal string
  - `updated_by` string — MongoDB ObjectId represented as a hexadecimal string

## Response `200`

Notification setting created successfully

- Success
  - `code` integer
  - `message` string
  - `data` object

## Changes

- **2025-03-02** `526e5bdf6dee` — 1 breaking, 27 warning, 18 info
  - request body became required
  - removed the request property `data`
  - removed the optional property `data/_id` from the response with the `200` status
  - removed the optional property `data/channel_ids` from the response with the `200` status
  - …42 more

[Change history](https://skmtc.dev/crawlab-team/apis/crawlab-api/changes/notifications/settings/post.md)

---

[API](https://skmtc.dev/crawlab-team/apis/crawlab-api.md) · [All operations](https://skmtc.dev/crawlab-team/apis/crawlab-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/crawlab-team/crawlab-api/revisions/526e5bdf6dee/schema)