Webhooks

Webhooks permitem criar integrações que comunicam eventos ocorridos nas operações e requisições. Quando um evento ocorre, a Inovanti Ip notifica a sua aplicação imediatamente, através de uma requisição HTTP POST para a URL previamente cadastrada.

Limite de requisições

A Inovanti Ip controla o limite de requisições realizadas. Não é permitido realizar polling em requisições. Se for necessário realizar essa prática por qualquer motivo, entre em contato com developers@inovanti.com.br solicitando permissão prévia.

Cadastro de Webhooks

Para ter acesso aos eventos de webhook na sua organização, você deve primeiramente solicitar atraves do email developers@inovanti.com.br o cadastro da URL responssáel por receber os eventos.

Segurança de Webhooks

Protegendo o seu endpoint

Para a Inovanti Ip se comunicar com a sua aplicação, você precisará de uma URL pública acessível. Sugerimos que a URL seja protegida para que requisições maliciosas não possam manipular seus dados.

Requisições HTTPS

Para garantir que os dados sejam criptografados, sugerimos fortemente a utilização de HTTPS na URL do seu webhook.

Melhores práticas

1. Serviços para testes com Webhooks

Sugerimos a utilização de um serviço para realização de testes com Webhooks que servem para inspecionar as requisições HTTP. Você pode criar uma URL temporária e usá-la como sua URL do Webhook. Ela irá gravar as solicitações HTTP e permitir inspecioná-las para verificar Headers e Body das requisições. Desta forma, você poderá começar a desenvolver sua integração mesmo se ainda não tiver uma URL pública disponível.

https://pinggy.io/
http://webhook.site
https://ngrok.com - Requisição externa chega no computador do desenvolvedor.

2. Responda com HTTP Status Code 200

Responda a requisição do Webhook com uma resposta HTTP 200 OK. Qualquer resposta fora do intervalo 2XX informará que você não recebeu seu webhook, incluindo o 301 Redirect. A plataforma Inovanti Ip não segue redirecionamentos para notificações do webhook e considerará um redirecionamento como uma resposta de erro.

Principais erros:

Requisições HTTP redirecionando para HTTPS.

Certificados SSL vencidos ou inválidos.

3. Responda rapidamente

Recomendamos que sua aplicação responda o mais rápido possível aos Webhooks da Inovanti Ip. Se você precisar realizar outras requisições ou processamentos dos documentos, realize esses procedimentos em background.

4. Exemplos de resposta do webhook

Na Operação

{
  "organization_uuid": "c0b61bfd-0eda-5694-87c3-d049a9684b19",
  "name": "approved",
  "event_type": "operation",
  "created_at": "2025-01-14T14:01:45.117872Z",
  "data": {
    "operation": "3384de20-d7ac-4013-9fce-01a6ceccdabf",
    "client": "00e042d2-71c1-57be-960f-93d248ea6d3d",
    "status": "approved"
  }
}

Na Requeisição

{
  "organization_uuid": "c0b61bfd-0eda-5694-87c3-d049a9684b19",
  "name": "under_analysis",
  "event_type": "request",
  "created_at": "2025-01-14T14:01:45.117872Z",
  "data": {
    "request": "3384de20-d7ac-4013-9fce-01a6ceccdabf",
    "client": "00e042d2-71c1-57be-960f-93d248ea6d3d",
    "status": "under_analysis"
  }
}

No Cliente

{
  "organization_uuid": "c0b61bfd-0eda-5694-87c3-d049a9684b19",
  "name": "created",
  "event_type": "client",
  "created_at": "2025-01-14T14:01:45.117872Z",
  "data": {
    "client": "3384de20-d7ac-4013-9fce-01a6ceccdabf",
    "taxid_number": "12345678900",
    "status": "created"
  }
}

5. Suporte da inovanti Ip

Se você estiver com problemas relacionados a Webhooks, entre em contato conosco através do e-mail developers@inovanti.com.br com o máximo de detalhes possível. Informações que nos ajudam a debugar a sua requisição:

Ambiente: (sandbox ou produção)

Conta da Organização

URL do Webhook

E-mail da organização/fornecedor

UUID (operação/cliente/requisição)

Tipo de Evento

Nome do Evento

Horário da requisição

Cadastro de Webhooks#

Segurança de Webhooks#

Protegendo o seu endpoint#

Requisições HTTPS#

Melhores práticas#

1. Serviços para testes com Webhooks#

2. Responda com HTTP Status Code 200#

3. Responda rapidamente#

4. Exemplos de resposta do webhook#

5. Suporte da inovanti Ip#