Casa dos Dados
    Casa dos Dados
    • Casa dos Dados - Documentação do sistema e API
    • Webhook
    • API
      • Informações Básicas
      • v4
        • Consulta CNPJ
        • Quantidade de empresas abertas do dia
        • Quantidade de empresas abertas nos últimos X dias
        • Consulta geração de arquivo
        • Listar solicitações de arquivos
      • v5
        • Pesquisa Avançada de empresas
        • Gerar arquivo com as empresas
        • Consulta o saldo total e detalhado da conta

    Webhook

    📡 Documentação do Webhook#

    A Casa dos Dados disponibiliza um serviço de Webhook para notificar seu sistema sempre que encontramos um novo CNPJ.

    🔔 Funcionamento#

    Sempre que um novo CNPJ for detectado, seu sistema receberá uma requisição HTTP POST com o seguinte payload:
    {
      "data_evento": "2025-06-13T11:15:42.404160427-03:00",
      "evento": [
        {
          "cnpj": "33000167000101",
          "nome_fantasia": "PETROBRAS - EDISE",
          "razao_social": "PETROLEO BRASILEIRO S A PETROBRAS",
          "situacao_cadastral": "ATIVA"
        }
      ],
      "id_evento": "988f17e7-55a7-4a79-a2ac-28fb031f1c5f"
    }
    Após receber esse evento, você poderá consultar os dados completos do CNPJ na nossa API.

    ⚙️ Como configurar o Webhook#

    A configuração do webhook é feita na sua área logada:
    ➡️ https://portal.casadosdados.com.br/plataforma/api/webhook

    Informações necessárias#

    CampoDescrição
    URL do endpointURL do seu sistema que irá receber os eventos via POST
    Token (opcional)Token de autenticação personalizado. Será enviado no header casadosdados-token
    Exemplo de headers com token:

    🔁 Regras de Entrega e Reenvio#

    O timeout da requisição é de 10 segundos.
    Se seu sistema retornar um status HTTP diferente de 200 ou houver timeout, o evento será reenviado mais duas vezes logo em seguida.
    Se acumularem 10 falhas consecutivas, o webhook será automaticamente desativado, e você será notificado por e-mail.
    Os eventos são entregues imediatamente após a identificação de um novo CNPJ.

    💸 Custo#

    Atualmente, não há custo pelo uso dos webhooks.

    📦 Exemplo de Requisição curl#

    Veja abaixo um exemplo real de como nosso sistema faz a chamada para seu endpoint:

    ❗ Observações#

    Não é possível configurar filtros no momento. Seu sistema receberá todos os eventos de novos CNPJs.
    A propriedade evento pode futuramente conter múltiplos CNPJs por notificação.
    Trate os dados com resiliência e garanta que seu endpoint aceite múltiplas tentativas de entrega.

    🧪 Teste seu Webhook#

    Você pode utilizar ferramentas como:
    Webhook.site
    RequestBin

    📞 Suporte#

    Em caso de dúvidas ou problemas, entre em contato com nosso time técnico através do portal da Casa dos Dados.
    Modificado em 2025-07-15 21:14:03
    Página anterior
    Casa dos Dados - Documentação do sistema e API
    Próxima página
    Informações Básicas
    Built with