Обработчики уведомлений
GET https://serpmax.ru/api/notification-handlers/
curl --request GET \
--url 'https://serpmax.ru/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://serpmax.ru/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
| Параметры | Подробнее | Описание |
|---|---|---|
| search | Необязательный Строка | Поисковый запрос. |
| search_by | Необязательный Строка | Поле, по которому выполняется поиск. Допустимые значения: name. |
| is_enabled | Необязательный Логическое значение | |
| type | Необязательный Строка | Поле, по которому выполняется поиск. Допустимые значения: email, webhook, microsoft_teams. |
| datetime_field | Необязательный Строка | Допустимые значения: datetime, last_datetime |
| datetime_start | Необязательный Строка | Фильтр результатов начиная с этой даты и времени в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС. |
| datetime_end | Необязательный Строка | Фильтр результатов до этой даты и времени в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС. |
| order_by | Необязательный Строка | Поле для сортировки результатов. Допустимые значения: notification_handler_id, datetime, last_datetime, name. |
| order_type | Необязательный Строка | Направление сортировки. Допустимые значения: ASC — по возрастанию, DESC — по убыванию. |
| search | Необязательный Строка | Поисковый запрос. |
| search_by | Необязательный Строка | Поле, по которому выполняется поиск. Допустимые значения: name. |
| is_enabled | Необязательный Логическое значение | |
| type | Необязательный Строка | Поле, по которому выполняется поиск. Допустимые значения: email, webhook, microsoft_teams. |
| datetime_field | Необязательный Строка | Допустимые значения: datetime, last_datetime |
| datetime_start | Необязательный Строка | Фильтр результатов начиная с этой даты и времени в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС. |
| datetime_end | Необязательный Строка | Фильтр результатов до этой даты и времени в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС. |
| order_by | Необязательный Строка | Поле для сортировки результатов. Допустимые значения: notification_handler_id, datetime, last_datetime, name. |
| order_type | Необязательный Строка | Направление сортировки. Допустимые значения: ASC — по возрастанию, DESC — по убыванию. |
| page | Необязательный Целое число | Номер страницы для выдачи результатов. По умолчанию: 1. |
| results_per_page | Необязательный Целое число | Количество результатов на одной странице. Допустимые значения: 10, 25, 50, 100, 250, 500, 1000. По умолчанию: 25. |
{
"data": [
{
"id": 1,
"type": "email",
"name": "Work email",
"settings": {
"email": "hey@example.com"
},
"is_enabled": true,
"last_datetime": null,
"datetime": "2026-07-24 00:26:16",
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://serpmax.ru/api/notification-handlers?page=1",
"last": "https://serpmax.ru/api/notification-handlers?page=1",
"next": null,
"prev": null,
"self": "https://serpmax.ru/api/notification-handlers?page=1"
}
}
GET https://serpmax.ru/api/notification-handlers/{notification_handler_id}
curl --request GET \
--url 'https://serpmax.ru/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://serpmax.ru/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
{
"data": {
"id": 1,
"type": "email",
"name": "Work email",
"settings": {
"email": "hey@example.com"
},
"is_enabled": true,
"last_datetime": null,
"datetime": "2026-07-24 00:26:16",
}
}
POST https://serpmax.ru/api/notification-handlers
| Параметры | Подробнее | Описание |
|---|---|---|
| name | Обязательный Строка | - |
| type | Обязательный Строка | Допустимые значения: email, webhook, microsoft_teams |
| Необязательный Строка | Доступно при условии: type = email Email-адрес | |
| webhook | Необязательный Строка | Доступно при условии: type = webhook Webhook URL |
| microsoft_teams | Необязательный Строка | Доступно при условии: type = microsoft_teams Microsoft Teams Webhook URL |
curl --request POST \
--url 'https://serpmax.ru/api/notification-handlers' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'type=email' \
--form 'email=hello@example.com' \
--url 'https://serpmax.ru/api/notification-handlers' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'type=email' \
--form 'email=hello@example.com' \
{
"data": {
"id": 1
}
}
POST https://serpmax.ru/api/notification-handlers/{notification_handler_id}
| Параметры | Подробнее | Описание |
|---|---|---|
| name | Необязательный Строка | - |
| type | Необязательный Строка | Допустимые значения: email, webhook, microsoft_teams |
| Необязательный Строка | Доступно при условии: type = email Email-адрес | |
| webhook | Необязательный Строка | Доступно при условии: type = webhook Webhook URL |
| microsoft_teams | Необязательный Строка | Доступно при условии: type = microsoft_teams Microsoft Teams Webhook URL |
| is_enabled | Необязательный Логическое значение | - |
curl --request POST \
--url 'https://serpmax.ru/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example new name' \
--form 'is_enabled=1' \
--url 'https://serpmax.ru/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example new name' \
--form 'is_enabled=1' \
{
"data": {
"id": 1
}
}
DELETE https://serpmax.ru/api/notification-handlers/{notification_handler_id}
curl --request DELETE \
--url 'https://serpmax.ru/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://serpmax.ru/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \