Gerar e usar API keys e webhooks
Crie chaves de API para acessar o Omnifox por código e configure webhooks para receber eventos em tempo real.
Veja este passo no vídeo · Criar uma chave de API
Se você quer conectar o Omnifox com sistemas próprios ou automatizar ações, a API REST e os webhooks são seus melhores aliados. As API keys autenticam suas chamadas à API; os webhooks avisam na hora quando algo acontece no seu workspace. Aqui você vai aprender a gerar e usar ambos.
Gerar uma API key
- Abra API Keys no menu lateral.
- Pressione Nova chave API.
- Dê um nome descritivo (por exemplo, "Integração loja online").
- Selecione as permissões (escopos) que ela precisa: contatos, conversas, mensagens, etc.
- Pressione Gerar. Copie a chave imediatamente: por segurança ela só é exibida uma vez.
Guarde a chave em um lugar seguro (um gerenciador de segredos). Se a perder, revogue-a e crie uma nova.
Usar sua API key
Inclua a chave no cabeçalho Authorization de cada requisição:
Authorization: Bearer SUA_API_KEY- A API REST V1 fica em
/api/v1/*(por exemplo,https://omnifox.io/api/v1/contacts). - Respeite os limites de uso (rate limits); se receber um
429, aguarde e tente novamente.
Configurar um webhook
- Abra Webhooks no menu lateral.
- Pressione Novo webhook.
- Cole a URL de destino (um endpoint público no seu servidor que receba POST).
- Marque os eventos que deseja receber: mensagem recebida, conversa criada, contato atualizado, etc.
- Salve. O Omnifox enviará um POST com um corpo JSON sempre que o evento ocorrer.
Verificar e proteger seus webhooks
- Cada envio inclui uma assinatura nos cabeçalhos; valide-a com o seu segredo de webhook para confirmar que o evento é legítimo.
- Responda com um
200rapidamente. Se o seu endpoint falhar ou demorar, o Omnifox fará novas tentativas com backoff. - Use HTTPS sempre.
Boas práticas
- Crie uma API key por integração, assim você pode revogar uma sem afetar as demais.
- Conceda apenas as permissões mínimas necessárias.
- Registre (logs) cada webhook recebido para depurar mais fácil.
Dica: teste seus webhooks com uma ferramenta como um endpoint de inspeção antes de apontá-los para produção. Você verá o formato exato do JSON e evitará surpresas.
Artigos relacionados
-
Como conectar integrações e apps externos
Conecte o Omnifox às suas ferramentas favoritas a partir do catálogo de integrações em poucos passos.
-
Integrar o Omnifox com Azur, Siigo, Alegra, QuickBooks ou outro sistema contábil ou ERP
O Omnifox não tem hoje um conector nativo com sistemas contábeis ou ERP. Veja como fazer essa conexão mesmo assim com fluxos de trabalho, o nó HTTP, n8n, Make, Zapier ou a API, com exemplos.
-
Guia completo de integrações e API
Integrações e API a fundo, em 30 capítulos: chaves de API, chamadas reais, webhooks assinados, n8n, MCP e SDKs, tudo funcionando de verdade.
-
Introdução às integrações (webhook / OAuth / chave de API)
Conecte o Omnifox às suas outras ferramentas: o que está disponível hoje, o que chega em breve e quando usar um webhook, uma conexão OAuth ou uma chave de API.
-
A API REST do Omnifox: introdução e requisitos de plano
O que é a API REST do Omnifox, qual plano você precisa (a partir do Crece), como autenticar com o cabeçalho X-API-Key e onde fica a documentação.