Уведомления

Подписка на канал · бесплатно

💳 Стоимость: бесплатно (создание подписки). Каждая доставка уведомления по этой подписке тарифицируется в 2 кредита.

Создает подписку на новые публикации указанного канала. Канал можно передать числовым идентификатором, публичной ссылкой https://max.ru/... или коротким именем. Подписка уникальна по каналу: если подписка на этот канал уже существует, возвращается существующая запись.

post/v1/callback/subscriptions/channel

Request

  • Base URL: https://maxstat.ru/api
  • URL: https://maxstat.ru/api/v1/callback/subscriptions/channel
  • Auth: API key in header X-API-Token

Request body

callback_urlstring uri required

Публично доступный HTTPS URL, на который MaxStat будет отправлять уведомления.

channelstring required

Канал для отслеживания: числовой идентификатор, публичная ссылка или короткое имя.

Example request

{
  "callback_url": "https://example.com/maxstat/webhooks",
  "channel": "https://max.ru/max_news"
}

Response

Successful Response

idstring uuid required

Идентификатор подписки.

type'channel' | 'keyword' required

Тип подписки: channel для канала или keyword для поискового запроса.

activeboolean

Признак активности подписки. Неактивные подписки не обрабатываются.

callback_urlstring required

URL, на который отправляются уведомления по подписке.

channel_idstring nullable

Идентификатор отслеживаемого канала. Заполняется только для подписок типа channel.

querystring nullable

Поисковый запрос. Заполняется только для подписок типа keyword.

category_idinteger nullable

Идентификатор категории канала для подписки типа keyword, если фильтр задан.

last_processed_atstring date-time nullable

Дата и время, до которых MaxStat проверил новые публикации по этой подписке.

last_matched_atstring date-time nullable

Дата и время последней отправки уведомления с найденными публикациями.

last_error_atstring date-time nullable

Дата и время последней ошибки при отправке уведомления.

last_error_typestring nullable

Имя класса исключения последней ошибки доставки, например ConnectError или HTTPStatusError.

consecutive_failuresinteger

Количество последовательных ошибок доставки. При достижении порога подписка автоматически деактивируется.

created_atstring date-time required

Дата и время создания подписки.

updated_atstring date-time required

Дата и время последнего обновления подписки.

Example response

{
  "id": "9f3f0c8a-7d52-4f42-a8b1-5a9b7a7f6a10",
  "type": "channel",
  "active": true,
  "callback_url": "https://example.com/maxstat/webhooks",
  "channel_id": "-91827364546372",
  "query": "запуск продукта",
  "category_id": 12,
  "last_processed_at": "2026-05-05T10:15:00+03:00",
  "last_matched_at": "2026-05-05T10:15:00+03:00",
  "last_error_at": "2026-05-05T10:15:00+03:00",
  "last_error_type": "ConnectError",
  "created_at": "2026-05-05T09:00:00+03:00",
  "updated_at": "2026-05-05T10:15:00+03:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.