Обработчики уведомлений

Получить всё

GET https://serpmax.ru/api/notification-handlers/
curl --request GET \
--url 'https://serpmax.ru/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
Параметры Детали Описание
search Необязательный Строка Строка поиска.
search_by Необязательный Строка Поле для поиска. Допустимые значения: name.
is_enabled Необязательный Логическое
type Необязательный Строка Поле для поиска. Допустимые значения: email, webhook, slack, discord, telegram, microsoft_teams.
datetime_field Необязательный Строка Допустимые значения: datetime, last_datetime
datetime_start Необязательный Строка Фильтр результатов начиная с этой даты. Формат Y-m-d H:i:s.
datetime_end Необязательный Строка Фильтр результатов до этой даты. Формат Y-m-d H:i:s.
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-04-21 12:48:07",
        }
    ],
    "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}' \ 
{
    "data": {
        "id": 1,
        "type": "email",
        "name": "Work email",
        "settings": {
            "email": "hey@example.com"
        },
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-04-21 12:48:07",
    }
}

Создать

POST https://serpmax.ru/api/notification-handlers
Параметры Детали Описание
name Обязательный Строка -
type Обязательный Строка Допустимые значения: email, webhook, slack, discord, telegram, microsoft_teams
email Необязательный Строка Доступно при: type = email Адрес почты
webhook Необязательный Строка Доступно при: type = webhook URL для Webhook
slack Необязательный Строка Доступно при: type = slack URL вебхука Slack
discord Необязательный Строка Доступно при: type = discord URL вебхука Discord
telegram Необязательный Строка Доступно при: type = telegram Токен бота Telegram
telegram_chat_id Необязательный Строка Доступно при: type = telegram ID чата Telegram
microsoft_teams Необязательный Строка Доступно при: type = microsoft_teams URL вебхука Teams
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' \
{
    "data": {
        "id": 1
    }
}

Обновить

POST https://serpmax.ru/api/notification-handlers/{notification_handler_id}
Параметры Детали Описание
name Необязательный Строка -
type Необязательный Строка Допустимые значения: email, webhook, slack, discord, telegram, microsoft_teams
email Необязательный Строка Доступно при: type = email Адрес почты
webhook Необязательный Строка Доступно при: type = webhook URL для Webhook
slack Необязательный Строка Доступно при: type = slack URL вебхука Slack
discord Необязательный Строка Доступно при: type = discord URL вебхука Discord
telegram Необязательный Строка Доступно при: type = telegram Токен бота Telegram
telegram_chat_id Необязательный Строка Доступно при: type = telegram ID чата Telegram
microsoft_teams Необязательный Строка Доступно при: type = microsoft_teams URL вебхука Teams
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' \
{
    "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}' \