Необработанные вебхуки

Необработанные вебхуки — это лёгкая и быстрая альтернатива стандартным (обогащённым) вебхукам. Они доставляют основные данные статьи в момент её публикации, полностью пропуская конвейер обогащения ИИ.

Ключевые отличия от обогащённых вебхуков:

Более быстрая доставка — статьи отправляются сразу после приёма, без ожидания анализа тональности, разрешения сущностей или сопоставления компаний.
Упрощённые фильтры — поддерживаются только query, sources, excludeSources, language и includeUpdates. tickers, countries, categories, includeContent, includeEntities и excludeEmptyContent недоступны.
Без обогащения ИИ — полезная нагрузка не содержит данных sentiment, confidence или companies.
Фильтрация query на уровне полей — параметр query поддерживает синтаксис уровня полей только для source, title и summary.
Неизменяемый тип — тип доставки (raw или enriched) задаётся при создании и не может быть изменён впоследствии.

Модель статьи

Необработанные вебхуки доставляют упрощённую полезную нагрузку статьи. Сущности компаний, оценки тональности и сгенерированные ИИ обогащения не включаются.

Name
link
Type
string
Description
URL полной статьи.
Name
source
Type
string
Description
Сайт-источник. Напр. www.reuters.com
Name
title
Type
string
Description
Заголовок статьи.
Name
summary
Type
string
Description
Краткое содержание статьи, если есть. Может быть null.
Name
publishDate
Type
Date
Description
Дата публикации в виде строки даты ISO 8601.
Name
createdAt
Type
Date
Description
Внутренняя дата создания статьи в системе finlight в виде строки даты ISO 8601.
Name
revisedDate
Type
Date | null
Description
Дата последней правки статьи после первоначальной публикации. null, если статья никогда не правилась. Присутствует, когда включён includeUpdates и статья была отредактирована.
Name
isUpdate
Type
boolean
Description
true, когда эта доставка вызвана обновлением после публикации. Присутствует только при включённом includeUpdates.
Name
language
Type
string
Description
Код языка в формате ISO 639-1. Напр. en | de | fr
Name
images
Type
string[]
Description
Массив URL изображений из статьи.
Name
countries
Type
string[]
Description
Массив кодов стран в формате ISO 3166-1 alpha-2. Напр. ["US", "GB"]. Может быть пустым.
Name
categories
Type
string[]
Description
Массив категорий статьи. Возможные значения: markets | economy | business | politics | geopolitics | regulation | technology | energy | commodities | crypto | health | climate | security. Может быть пустым.

WEBHOOKТип доставки

Создание необработанного вебхука

При создании вебхука в панели finlight выберите Raw в качестве типа доставки на первом шаге мастера настройки. Тогда на шаге критериев будут показаны только четыре поддерживаемых параметра фильтра.

Необработанные вебхуки доставляют только вновь опубликованные статьи, соответствующие вашим критериям. Каждая доставка — это полезная нагрузка одной статьи, отправляемая на ваш эндпоинт HTTP-запросом POST.

Name
query
Type
string
Description
Поисковый запрос для поиска релевантных статей. Поддерживает фильтрацию на уровне полей для source, title и summary. См. фильтрацию query на уровне полей ниже.
Name
sources
Type
string[]
Description
Ограничивает доставку статьями из определённых источников. Напр. ["www.reuters.com", "www.cnbc.com"]. Допустимые значения см. в эндпоинте источников.
Name
excludeSources
Type
string[]
Description
Исключает статьи из определённых источников. Напр. ["www.example.com"].
Name
language
Type
string
Description
Фильтрация по языку статьи (ISO 639-1). По умолчанию en — возвращает только английский и исключает другие языки — см. Язык и охват.
Name
includeUpdates
Type
boolean
Description
Повторно доставляет статьи при их обновлении после первоначальной публикации. Обновлённые полезные нагрузки включают isUpdate=true и метку времени revisedDate.

Response

{
  "link": "https://www.example.com/article1",
  "source": "www.example.com",
  "title": "Stock Market Hits New Highs",
  "summary": "A brief summary of the article...",
  "publishDate": "2023-10-01T12:34:56Z",
  "createdAt": "2023-10-01T12:35:10Z",
  "language": "en",
  "images": [
    "https://www.example.com/image1.jpg",
    "https://www.example.com/image2.jpg"
  ],
  "countries": ["US"],
  "categories": ["markets"]
}

Response (includeUpdates: true)

{
  "link": "https://www.example.com/article1",
  "source": "www.example.com",
  "title": "Stock Market Hits New Highs — Updated",
  "summary": "An updated summary of the article...",
  "publishDate": "2023-10-01T12:34:56Z",
  "createdAt": "2023-10-01T12:35:10Z",
  "revisedDate": "2023-10-02T08:00:00Z",
  "isUpdate": true,
  "language": "en",
  "images": [
    "https://www.example.com/image1.jpg"
  ],
  "countries": ["US"],
  "categories": ["markets"]
}

Фильтрация query на уровне полей

Параметр query необработанных вебхуков поддерживает фильтрацию на уровне полей, ограниченную только этими полями:

source - фильтрация по домену источника статьи
title - фильтрация по содержимому заголовка статьи
summary - фильтрация по содержимому краткого описания статьи

Примеры:

query=title:Nvidia

Доставляет статьи, в заголовке которых есть «Nvidia».

query=summary:earnings +title:Tesla

Доставляет статьи, в кратком описании которых упоминается «earnings», а в заголовке есть «Tesla».

query=source:www.reuters.com -crypto

Доставляет статьи Reuters, исключая упоминающие «crypto».

Полный справочник по синтаксису запросов см. в руководстве Расширенное построение запросов.

GUIDEПомощь в выборе

Когда использовать необработанные вебхуки

Выбирайте Raw, когда вы:

Нуждаетесь в максимально низкой задержке доставки
Строите высоконагруженный конвейер, где данные обогащения не требуются
Хотите фильтровать только по ключевым словам, источникам или языку
Хотите более компактную полезную нагрузку, чтобы снизить накладные расходы на обработку на своей стороне

Выбирайте Enriched, когда вы:

Нуждаетесь в фильтрации на уровне компании/тикера (tickers, countries, categories)
Хотите получать в полезной нагрузке оценки тональности, значения достоверности или разрешение сущностей
Должны включать полный текст статьи или извлечённые сущности через includeContent / includeEntities
Строите мониторинг акций, отслеживание отчётностей или отраслевые новостные ленты

Полные сведения о параметрах фильтрации обогащённых вебхуков см. в руководстве Критерии фильтрации.