Notifications

Create a new notification setting

Create a new notification setting

post/notifications/settings

Request body

_idstring

MongoDB ObjectId represented as a hexadecimal string

namestring

Name of the notification setting

descriptionstring

Description of the notification setting

type'task_finished' | 'task_error' | 'spider_created' | 'schedule_created'

Type of event to trigger notification

enabledboolean

Whether this notification setting is enabled

channel_idstring

MongoDB ObjectId represented as a hexadecimal string

templatestring

Message template for the notification

created_atstring date-time
updated_atstring date-time
created_bystring

MongoDB ObjectId represented as a hexadecimal string

updated_bystring

MongoDB ObjectId represented as a hexadecimal string

Response

Notification setting created successfully

codeinteger
messagestring
dataobject

Changes