Skip to main content
POST
Проверка вебхука монитора

Авторизации

pubrio-api-key
string
header
обязательно

Уникальный токен API, представляющий действия, которые вы выполняете через API, и соответствующие права доступа и операции. Вы можете создать его в разделе Settings.

Тело

application/json
destination_config
object
обязательно

Конфигурация точки доставки. Для webhook: требуется webhook_url (строка), необязательные headers (объект) и body (объект). Для email: принимает email (строка) или emails (массив строк). Для последовательностей (sequences): требуется sequence_identifier (строка) плюс хотя бы одно из is_people_search_enrolled / is_company_contact_enrolled, установленное в true.

Пример:
monitor_id
string<uuid>

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

name
string

Название монитора.

description
string

Описание монитора.

detection_mode
enum<string>

Как обнаруживаются сигналы. signal_first сканирует рынок в широком масштабе; company_first отслеживает именованный список аккаунтов и требует хотя бы одну компанию, домен или URL LinkedIn. Неизменяемо после создания — изменение этого параметра у существующего монитора возвращает 40021. Вместо этого создайте новый монитор.

Доступные опции:
company_first,
signal_first
signal_types
enum<string>[]

Типы отслеживаемых сигналов.

Доступные опции:
jobs,
news,
advertisements,
expansions
signal_filters
object[]

По одной записи на каждый поток сигналов, который отслеживает монитор.

Пример:
company_filters
object

Глобальные фильтры компаний. Принимает те же параметры, что и эндпоинт Company Search.

Пример:
companies
string<uuid>[]

Список UUID domain_search_id компаний. Альтернатива: используйте domains или linkedin_urls.

domains
string[]

Список доменов компаний. Альтернатива companies.

linkedin_urls
string<uri>[]

Список URL компаний в LinkedIn. Альтернатива companies.

is_company_enrichment
boolean

Обогащать ли данные компании.

is_people_enrichment
boolean

Обогащать ли данные людей.

people_enrichment_configs
object[]

Массив слоёв обогащения данных о людях. Содержит max_people_to_return (1-25), people_contact_types (см. Redeem) и filters (см. People Search).

Пример:
destination_type
enum<string>

Тип точки доставки.

Доступные опции:
webhook,
email,
sequences
frequency_minute
integer

Частота срабатывания в минутах. Мин: 0, Макс: 10080.

Требуемый диапазон: 0 <= x <= 10080
max_failure_trigger
integer

Максимальное количество последовательных сбоев до приостановки. Мин: 1, Макс: 10.

Требуемый диапазон: 1 <= x <= 10
max_daily_trigger
integer

Максимальное количество срабатываний в день. Мин: 0, Макс: 86400.

Требуемый диапазон: 0 <= x <= 86400
max_records_per_trigger
integer

Определяет максимальное количество записей, доставляемых за одно срабатывание. Меньшие значения уменьшают размер полезной нагрузки при каждой доставке, что рекомендуется для больших наборов результатов или интеграций с ограничением частоты запросов. Мин: 1, Макс: 100, По умолчанию: 25. См. Setting up Webhooks для рекомендаций.

Требуемый диапазон: 1 <= x <= 100
notification_email
string<email>

Email для уведомлений о сбоях.

max_retry_per_trigger
integer

Максимальное количество повторных попыток на срабатывание. Мин: 0, Макс: 3.

Требуемый диапазон: 0 <= x <= 3
retry_delay_second
integer

Задержка между повторными попытками в секундах. Мин: 1, Макс: 5.

Требуемый диапазон: 1 <= x <= 5

Ответ

Успешный ответ с результатами проверки вебхука — конфигурацией точки доставки и тестовыми данными запроса/ответа. При сбое вебхука эндпоинт возвращает 400 (MONITOR_WEBHOOK_URL_INVALID) с ответом вебхука в деталях ошибки.

data
object