Skip to main content
POST
Validar webhook do monitor

Autorizações

pubrio-api-key
string
header
obrigatório

Um token de API exclusivo que representa as ações que você realiza por meio da API e as permissões e operações correspondentes. Você pode criá-lo na seção Configurações.

Corpo

application/json
destination_config
object
obrigatório

Configuração do destino. Para webhook: exige webhook_url (string), com headers (objeto) e body (objeto) opcionais. Para e-mail: aceita email (string) ou emails (array de strings). Para sequences: exige sequence_identifier (string) mais pelo menos um de is_people_search_enrolled / is_company_contact_enrolled definido como true.

Exemplo:
monitor_id
string<uuid>

Identificador único de um monitor existente a ser testado. Opcional para testar novas configurações.

name
string

Nome do monitor.

description
string

Descrição do monitor.

detection_mode
enum<string>

Como os sinais são detectados. signal_first varre o mercado de forma ampla; company_first acompanha uma lista nomeada de contas e exige pelo menos uma empresa, domínio ou URL do LinkedIn. Imutável após a criação — alterar esse valor em um monitor existente retorna 40021. Crie um novo monitor em vez disso.

Opções disponíveis:
company_first,
signal_first
signal_types
enum<string>[]

Tipos de sinais a monitorar.

Opções disponíveis:
jobs,
news,
advertisements,
expansions
signal_filters
object[]

Uma entrada para cada stream de sinal monitorado.

Exemplo:
company_filters
object

Filtros globais de empresa. Aceita os mesmos parâmetros do endpoint Company Search.

Exemplo:
companies
string<uuid>[]

Lista de UUIDs domain_search_id de empresas. Alternativa: use domains ou linkedin_urls.

domains
string[]

Lista de domínios de empresas. Alternativa a companies.

linkedin_urls
string<uri>[]

Lista de URLs do LinkedIn de empresas. Alternativa a companies.

is_company_enrichment
boolean

Se deve enriquecer os dados da empresa.

is_people_enrichment
boolean

Se deve enriquecer os dados de pessoas.

people_enrichment_configs
object[]

Array de camadas de enriquecimento de pessoas. Contém max_people_to_return (1-25), people_contact_types (veja Redeem) e filters (veja People Search).

Exemplo:
destination_type
enum<string>

Tipo de destino de entrega.

Opções disponíveis:
webhook,
email,
sequences
frequency_minute
integer

Frequência de disparo em minutos. Mín: 0, Máx: 10080.

Intervalo necessário: 0 <= x <= 10080
max_failure_trigger
integer

Número máximo de falhas consecutivas antes de pausar. Mín: 1, Máx: 10.

Intervalo necessário: 1 <= x <= 10
max_daily_trigger
integer

Número máximo de disparos por dia. Mín: 0, Máx: 86400.

Intervalo necessário: 0 <= x <= 86400
max_records_per_trigger
integer

Controla o número máximo de registros entregues por disparo. Valores menores reduzem o tamanho do payload por entrega, o que é recomendado para conjuntos de resultados grandes ou integrações com limite de taxa. Mín: 1, Máx: 100, Padrão: 25. Consulte Setting up Webhooks para mais orientações.

Intervalo necessário: 1 <= x <= 100
notification_email
string<email>

E-mail para notificações de falha.

max_retry_per_trigger
integer

Número máximo de novas tentativas por disparo. Mín: 0, Máx: 3.

Intervalo necessário: 0 <= x <= 3
retry_delay_second
integer

Atraso entre as tentativas, em segundos. Mín: 1, Máx: 5.

Intervalo necessário: 1 <= x <= 5

Resposta

Resposta bem-sucedida contendo os resultados da validação do webhook — a configuração de destino e os payloads de requisição/resposta do teste. Em caso de falha do webhook, o endpoint responde com 400 (MONITOR_WEBHOOK_URL_INVALID), trazendo a resposta do webhook nos detalhes do erro.

data
object