Skip to main content
POST
Validate monitor webhook

Authorizations

pubrio-api-key
string
header
required

A unique API token that represents the actions you perform through the API and the corresponding permissions and operations. You can create it through the Settings section.

Body

application/json
destination_config
object
required

Configuration for the destination. For webhook: requires webhook_url (string), optional headers (object) and body (object). For email: accepts email (string) or emails (array of strings). For sequences: requires sequence_identifier (string) plus at least one of is_people_search_enrolled / is_company_contact_enrolled set to true.

Example:
monitor_id
string<uuid>

Unique identifier of an existing monitor to test. Optional for testing new configurations.

name
string

Name of the monitor.

description
string

Description of the monitor.

detection_mode
enum<string>

How signals are detected. signal_first scans the market broadly; company_first tracks a named account list and requires at least one company, domain or LinkedIn URL. Immutable after creation — changing it on an existing monitor returns 40021. Create a new monitor instead.

Available options:
company_first,
signal_first
signal_types
enum<string>[]

Types of signals to monitor.

Available options:
jobs,
news,
advertisements,
expansions
signal_filters
object[]

Array of signal filter objects. Each object has signal_type (one of: jobs, news, advertisements, expansions) and filters (object with signal-specific parameters). See Job Search, News Search or Advertisement Search for the available filter parameters per signal type. For expansions, use the Expansion Search filter vocabulary — froms / tos, stages, momentum, freshness, scopes, signal_types, signal_strengths and window_days.

Example:
company_filters
object

Global company filters. Accepts the same parameters as the Company Search endpoint.

Example:
companies
string<uuid>[]

List of company domain_search_id UUIDs. Alternative: use domains or linkedin_urls.

domains
string[]

List of company domains. Alternative to companies.

linkedin_urls
string<uri>[]

List of LinkedIn company URLs. Alternative to companies.

is_company_enrichment
boolean

Whether to enrich company data.

is_people_enrichment
boolean

Whether to enrich people data.

people_enrichment_configs
object[]

Array of people enrichment layers. Contains max_people_to_return (1-25), people_contact_types (see Redeem), and filters (see People Search).

Example:
destination_type
enum<string>

Delivery destination type.

Available options:
webhook,
email,
sequences
frequency_minute
integer

Trigger frequency in minutes. Min: 0, Max: 10080.

Required range: 0 <= x <= 10080
max_failure_trigger
integer

Maximum consecutive failures before pausing. Min: 1, Max: 10.

Required range: 1 <= x <= 10
max_daily_trigger
integer

Maximum triggers per day. Min: 0, Max: 86400.

Required range: 0 <= x <= 86400
max_records_per_trigger
integer

Controls the maximum number of records delivered per trigger. Lower values reduce payload size per delivery, which is recommended for large result sets or rate-limited integrations. Min: 1, Max: 100, Default: 25. See Setting up Webhooks for guidance.

Required range: 1 <= x <= 100
notification_email
string<email>

Email for failure notifications.

max_retry_per_trigger
integer

Maximum retries per trigger. Min: 0, Max: 3.

Required range: 0 <= x <= 3
retry_delay_second
integer

Delay between retries in seconds. Min: 1, Max: 5.

Required range: 1 <= x <= 5

Response

Successful response containing the webhook validation results — the destination configuration and the test request/response payloads. On webhook failure the endpoint responds 400 (MONITOR_WEBHOOK_URL_INVALID) with the webhook's response in the error details.

data
object