Top.Mail.Ru

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

Получить все

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 Необязательно Логический (Boolean)
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-06-08 19:46:55",
        }
    ],
    "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-06-08 19:46:55",
    }
}

Создать

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