> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pubrio.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Configurando Webhooks

> Configure destinos de webhook, valide endpoints, verifique assinaturas e trate payloads.

Webhooks são a forma recomendada de receber resultados de monitores. Quando um monitor é acionado, a Pubrio envia uma requisição POST com um payload JSON para a sua URL configurada — em tempo real.

## Pré-requisitos

* Uma chave de API Pubrio com acesso a monitores
* Um endpoint HTTPS publicamente acessível (ou uma URL de teste do [usewebhook.com](https://usewebhook.com))

<Tip>
  **Teste rápido:** use o [usewebhook.com](https://usewebhook.com) para gerar uma URL de webhook temporária e gratuita. Você pode inspecionar cada payload recebido sem precisar implantar nada.
</Tip>

***

## Etapa 1: Criar um Monitor com Destino de Webhook

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST https://api.pubrio.com/monitors/create \
    -H "Content-Type: application/json" \
    -H "pubrio-api-key: YOUR_API_KEY" \
    -d '{
      "name": "My First Monitor",
      "detection_mode": "signal_first",
      "signal_types": ["jobs"],
      "signal_filters": [
        {
          "signal_type": "jobs",
          "filters": {
            "locations": ["US"]
          }
        }
      ],
      "destination_type": "webhook",
      "destination_config": {
        "webhook_url": "https://usewebhook.com/YOUR_WEBHOOK_ID",
        "headers": {
          "X-Custom-Auth": "your-secret-token"
        },
        "body": {
          "pipeline": "my-webhook"
        }
      },
      "max_records_per_trigger": 5,
      "profile_id": 1
    }'
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      "https://api.pubrio.com/monitors/create",
      headers={
          "Content-Type": "application/json",
          "pubrio-api-key": "YOUR_API_KEY"
      },
      json={
          "name": "My First Monitor",
          "detection_mode": "signal_first",
          "signal_types": ["jobs"],
          "signal_filters": [
              {
                  "signal_type": "jobs",
                  "filters": {
                      "locations": ["US"]
                  }
              }
          ],
          "destination_type": "webhook",
          "destination_config": {
              "webhook_url": "https://usewebhook.com/YOUR_WEBHOOK_ID",
              "headers": {
                  "X-Custom-Auth": "your-secret-token"
              },
              "body": {
                  "pipeline": "my-webhook"
              }
          },
          "max_records_per_trigger": 5,
          "profile_id": 1
      }
  )

  print(response.json())
  ```

  ```javascript Node.js theme={null}
  const response = await fetch("https://api.pubrio.com/monitors/create", {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "pubrio-api-key": "YOUR_API_KEY"
    },
    body: JSON.stringify({
      name: "My First Monitor",
      detection_mode: "signal_first",
      signal_types: ["jobs"],
      signal_filters: [
        {
          signal_type: "jobs",
          filters: {
            locations: ["US"]
          }
        }
      ],
      destination_type: "webhook",
      destination_config: {
        webhook_url: "https://usewebhook.com/YOUR_WEBHOOK_ID",
        headers: {
          "X-Custom-Auth": "your-secret-token"
        },
        body: {
          pipeline: "my-webhook"
        }
      },
      max_records_per_trigger: 5,
      profile_id: 1
    })
  });

  console.log(await response.json());
  ```
</CodeGroup>

**Resposta:**

```json theme={null}
{
  "data": {
    "monitor_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "My First Monitor",
    "detection_mode": "signal_first",
    "destination_type": "webhook",
    "is_active": true,
    "is_paused": false,
    "masked_signature": "7••••••••••••••••8df",
    "created_at": "2026-04-06T10:00:00.000Z",
    "signature": "71a2b3c4-d5e6-f789-0abc-def123456789"
  }
}
```

O objeto `headers` adiciona cabeçalhos HTTP personalizados a cada entrega (útil para autenticação). O objeto `body` adiciona campos personalizados à raiz do payload do webhook.

<Tip>
  Salve o `signature` retornado na resposta — você vai precisar dele para verificar os payloads recebidos. Ele só é retornado no momento da criação, pelo endpoint [Signature Reveal](/pt/api-reference/endpoint/monitors/signature_reveal), ou pelo [Monitor Lookup](/pt/api-reference/endpoint/monitors/lookup) com `is_signature_reveal: true`.
</Tip>

***

## Etapa 2: Validar a Conexão do Webhook

Use o endpoint [Validate Webhook](/pt/api-reference/endpoint/monitors/webhook_validate) para testar se o seu endpoint está acessível. Isso envia um **payload de amostra** com dados fictícios — nenhum crédito é consumido e nenhum sinal real é buscado.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST https://api.pubrio.com/monitors/webhook/validate \
    -H "Content-Type: application/json" \
    -H "pubrio-api-key: YOUR_API_KEY" \
    -d '{
      "monitor_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "detection_mode": "signal_first",
      "signal_types": ["jobs"],
      "signal_filters": [
        {
          "signal_type": "jobs",
          "filters": { "locations": ["US"] }
        }
      ],
      "destination_type": "webhook",
      "destination_config": {
        "webhook_url": "https://usewebhook.com/YOUR_WEBHOOK_ID",
        "headers": { "X-Custom-Auth": "your-secret-token" },
        "body": { "pipeline": "my-webhook" }
      },
      "profile_id": 1
    }'
  ```
</CodeGroup>

Uma resposta bem-sucedida retorna o payload de amostra que foi enviado e a resposta que o seu endpoint devolveu — assim você confirma que a conexão funciona antes de colocar em produção.

***

## Etapa 3: Testar com Dados Reais

Depois que a conexão for validada, acione uma execução real usando o endpoint [Process Try](/pt/api-reference/endpoint/monitors/process_try). Isso busca sinais reais e os entrega ao seu webhook — use `tried_at` com uma data recente no passado para garantir que haja dados disponíveis:

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST https://api.pubrio.com/monitors/process/try \
    -H "Content-Type: application/json" \
    -H "pubrio-api-key: YOUR_API_KEY" \
    -d '{
      "monitor_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "tried_at": "2026-01-01T00:00:00.000Z",
      "profile_id": 1
    }'
  ```
</CodeGroup>

<Info>
  Ao contrário do validate, o endpoint try executa uma varredura real e **consome créditos**. Use-o para confirmar que os payloads reais chegam corretamente e para ter uma estimativa rápida dos resultados antes que a varredura agendada seja executada.
</Info>

***

## Etapa 4: Verificar Assinaturas

Cada monitor tem uma assinatura única para verificar que os payloads recebidos vêm de fato da Pubrio.

<CodeGroup>
  ```bash cURL — Reveal Signature theme={null}
  curl -X POST https://api.pubrio.com/monitors/signature/reveal \
    -H "Content-Type: application/json" \
    -H "pubrio-api-key: YOUR_API_KEY" \
    -d '{
      "monitor_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "profile_id": 1
    }'
  ```
</CodeGroup>

```json theme={null}
{
  "data": {
    "monitor_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "signature": "71a2b3c4-d5e6-f789-0abc-def123456789"
  }
}
```

Compare essa assinatura com o `monitor.monitor_id` nos payloads recebidos para verificar a autenticidade.

***

## Estrutura do Payload do Webhook

Os payloads variam de acordo com o `detection_mode` do monitor:

<Tabs>
  <Tab title="Sinal Primeiro">
    No modo `signal_first`, o payload contém um array `signals` no nível raiz:

    ```json theme={null}
    {
      "monitor": {
        "monitor_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "My Signal Monitor",
        "detection_mode": "signal_first",
        "signal_types": ["jobs", "news"],
        "signal_filters": [...],
        "company_filters": {...},
        "is_company_enrichment": true,
        "is_people_enrichment": true,
        "people_enrichment_configs": [...]
      },
      "metadata": {
        "total_signals": 3,
        "total_companies": 2,
        "total_people": 5
      },
      "triggered_at": "2026-04-05T20:29:43.832Z",
      "signals": [
        {
          "signal_type": "jobs",
          "signal": {
            "signal_type": "jobs",
            "job_search_id": "...",
            "companies": [
              {
                "domain_search_id": "...",
                "company_name": "...",
                "domain": "...",
                ...
              }
            ],
            ...
          },
          "companies": [
            {
              "domain_search_id": "...",
              "company_name": "...",
              "domain": "...",
              "logo_url": "...",
              "country_code": "...",
              "company_size": 5000,
              "industry": "...",
              "people": [...],
              "emails": [...],
              "phones": [...],
              ...
            }
          ]
        },
        {
          "signal_type": "news",
          "signal": {
            "signal_type": "news",
            "news_search_id": "...",
            "news_id": "...",
            "title": "...",
            "summary": "...",
            "published_at": "...",
            "source": "...",
            "category": "...",
            "companies": [...],
            ...
          },
          "companies": [...],
          ...
        },
        ...
      ]
    }
    ```

    Cada entrada de sinal contém os detalhes do sinal e as empresas e pessoas enriquecidas associadas.
  </Tab>

  <Tab title="Empresa Primeiro">
    No modo `company_first`, o payload contém um array `companies` no nível raiz, com dados de empresa enriquecidos e sinais aninhados:

    ```json theme={null}
    {
      "monitor": {
        "monitor_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "My Company Monitor",
        "detection_mode": "company_first",
        "signal_types": ["jobs", "news", "advertisements"],
        "signal_filters": [...],
        "company_filters": {...},
        "is_company_enrichment": true,
        "is_people_enrichment": true,
        "people_enrichment_configs": [...]
      },
      "metadata": {
        "total_signals": 4,
        "total_companies": 2,
        "total_people": 8
      },
      "triggered_at": "2026-04-03T17:45:27.228Z",
      "companies": [
        {
          "company_name": "Acme Corp",
          "domain": "acmecorp.com",
          "domain_search_id": "...",
          "country_code": "US",
          "logo_url": "...",
          "linkedin_name": "acmecorp",
          "company_size": 5200,
          "industry": "Enterprise Software",
          "estimated_revenue": 50000000,
          "founded_year": 2010,
          "company_address": "San Francisco, CA",
          "specialties": ["SaaS", "Cloud Computing", ...],
          "linkedin_url": "https://linkedin.com/company/...",
          "locations": ["US"],
          "signals": [
            {
              "signal_type": "news",
              "signal": {
                "news_id": "...",
                "title": "Acme Corp Launches New AI Product",
                "summary": "...",
                "published_at": "2026-04-03T16:35:00.000Z",
                "source": "techcrunch.com",
                "category": "launches",
                "news_category_name": "Product Launch",
                ...
              }
            },
            {
              "signal_type": "jobs",
              "signal": {
                "job_search_id": "...",
                ...
              }
            },
            ...
          ],
          "people": [
            {
              "name": "Jane Smith",
              "title": "VP of Engineering",
              "email": "j.smith@acmecorp.com",
              ...
            },
            ...
          ],
          "emails": ["info@acmecorp.com", ...],
          "phones": ["+14155551234", ...],
          "contacts": [...],
          ...
        },
        ...
      ]
    }
    ```

    Cada empresa no array inclui o perfil enriquecido completo, todos os sinais correspondentes e os contatos de pessoas enriquecidos.
  </Tab>
</Tabs>

<Note>
  Os campos personalizados de `body` definidos em `destination_config` aparecem no nível raiz do payload (por exemplo, `"pipeline": "my-webhook"` quando configurado no seu destino).
</Note>

***

## Sinais de Expansão

Além de `jobs`, `news` e `advertisements`, um monitor pode observar **sinais de expansão** — a evidência datada de que uma empresa está entrando ou crescendo em um novo mercado. Adicione `expansions` a `signal_types`:

```json theme={null}
{
  "name": "US market entries",
  "detection_mode": "signal_first",
  "signal_types": ["expansions"],
  "signal_filters": [
    {
      "signal_type": "expansions",
      "filters": {
        "tos": ["US"],
        "stages": ["expanding", "scaling"],
        "signal_strengths": ["high", "very_high"],
        "window_days": 30
      }
    }
  ],
  "destination_type": "webhook",
  "destination_config": {
    "webhook_url": "https://usewebhook.com/YOUR_WEBHOOK_ID"
  }
}
```

Os filtros de expansão usam o vocabulário do [Expansion Search](/pt/api-reference/endpoint/expansions/market_lookup), e não o de vagas/notícias/anúncios — `froms` e `tos` para o corredor, além de `stages`, `scopes`, `momentum`, `freshness`, `signal_types`, `signal_subtypes`, `signal_strengths`, `source_types` e `window_days`. Resolva os slugs válidos em [Expansion Reference](/pt/api-reference/endpoint/expansions/types).

<Note>
  Os sinais de expansão são agrupados **por empresa e mercado**, não por sinal. Uma empresa entrando em dois mercados gera duas entradas, cada uma com sua própria linha do tempo de sinais daquele mercado.
</Note>

### Payload de Sinal de Expansão

```json theme={null}
{
  "monitor": {
    "monitor_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "US market entries",
    "detection_mode": "signal_first",
    "signal_types": ["expansions"],
    "signal_filters": [...]
  },
  "metadata": {
    "total_signals": 2,
    "total_companies": 1,
    "total_people": 0
  },
  "triggered_at": "2026-08-14T09:12:04.551Z",
  "signals": [
    {
      "signal_type": "expansions",
      "signal": {
        "signal_type": "expansions",
        "expansion_signal_id": 90211,
        "domain_search_id": "550e8400-e29b-41d4-a716-446655440002",
        "country_code": "US",
        "signal_type_slug": "HIRE",
        "signal_type_name": "Hiring",
        "signal_subtype_slug": "country_manager",
        "signal_strength_slug": "high",
        "polarity": "expansion",
        "event_date": "2026-08-13T14:00:00.000Z",
        "event_date_precision": "day",
        "source_type": "linkedin",
        "display_label": "Hired Country Manager",
        "evidence_url": "https://linkedin.com/company/example-corp",
        "metadata": {...},
        "companies": [
          {
            "domain_search_id": "550e8400-e29b-41d4-a716-446655440002",
            "company_name": "Example Corp",
            "domain": "example.com",
            "stage_name": "Expanding",
            "stage_description": "...",
            "home_country": "GB",
            "home_country_name": "United Kingdom",
            "target_country": "US",
            "target_country_name": "United States",
            "estimated_employees": 420,
            "linkedin_url": "https://linkedin.com/company/example-corp"
          }
        ]
      },
      "companies": [...]
    }
  ]
}
```

O significado de cada campo está detalhado na [Expansion Field Reference](/pt/knowledge-base/concepts/expansion-field-reference). Para obter as mesmas linhas sob demanda em vez de por acionamento, use o [Expansion Signal Search](/pt/api-reference/endpoint/expansions/signal_search).

***

## Destino por E-mail

Para equipes que preferem a entrega por e-mail, defina `destination_type` como `"email"`:

```json theme={null}
{
  "destination_type": "email",
  "destination_config": {
    "email": "alerts@your-company.com"
  }
}
```

<Info>
  A Pubrio oferece suporte a entrega de e-mail com marca branca para agências e equipes. [Entre em contato](https://pubrio.com/en/get-in-touch) para saber mais sobre personalização de domínio de envio e identidade visual.
</Info>

***

## Solução de Problemas

<AccordionGroup>
  <Accordion title="O webhook não recebe payloads">
    * Verifique se o seu endpoint é publicamente acessível (não está atrás de um firewall ou VPN)
    * Garanta que ele retorne um código de status `200` — outros códigos são tratados como falhas
    * Use o endpoint [Validate Webhook](/pt/api-reference/endpoint/monitors/webhook_validate) para testar a conectividade
    * Verifique os [Statistic Logs](/pt/api-reference/endpoint/monitors/statistics_logs) em busca de mensagens de erro e códigos de resposta
  </Accordion>

  <Accordion title="Monitor pausado após falhas">
    Se o seu webhook retornar códigos diferentes de 200 de forma consistente, o monitor é pausado ao atingir `max_failure_trigger` falhas consecutivas. Corrija o problema e reative usando o [Update Monitor](/pt/api-reference/endpoint/monitors/update).
  </Accordion>

  <Accordion title="Payloads duplicados">
    Se uma entrega falhar e houver novas tentativas configuradas, você pode receber o mesmo payload várias vezes. Use `triggered_at` ou o ID do log para deduplicar do seu lado.
  </Accordion>

  <Accordion title="Payload muito grande">
    Reduza `max_records_per_trigger` para limitar os registros por entrega. Você também pode restringir seus filtros para reduzir o volume de sinais correspondentes.
  </Accordion>
</AccordionGroup>