Referência de endpoints da API: equipes, webhooks, membros e agentes/horários
Endpoints da API REST v1 do Omnifox para gerenciar equipes, assinaturas de webhooks, membros e a disponibilidade dos agentes.
Veja este passo no vídeo · A documentação da API
Introdução
A API REST v1 do Omnifox permite automatizar equipes, webhooks de saída e agentes a partir dos seus próprios sistemas. Base da API: https://omnifox.io/api/v1. Toda chamada usa Bearer token (token pessoal Sanctum) gerado em Configurações → Chaves API (/api-keys). Na lista você o reconhece por um prefixo visível omf_…, mas o valor que você envia no header tem o formato 123_aBc…. Cada token tem escopo de um único workspace: você não pode operar em outro workspace com o mesmo token.
Authorization: Bearer 123_aBc...seuTokenCompleto
Content-Type: application/json
Equipes (Teams)
GET /v1/teams— lista equipes. Filtro opcional?workspace_id=.POST /v1/teams— cria uma equipe. Body:workspace_id(obr),name(obr),description,assignment_strategy.GET /v1/teams/{team}— retorna a equipe com seus membros.PUT /v1/teams/{team}— atualizaname,description,assignment_strategy.DELETE /v1/teams/{team}— exclui a equipe.
Membros da equipe
POST /v1/teams/{team}/members— adiciona um usuário. Body:user_id(obr).DELETE /v1/teams/{team}/members/{user}— remove um usuário da equipe.GET /v1/teams/{team}/members/{user}— verifica uma associação específica; retorna{ is_member, role }.GET /v1/users/{user}/teams— equipes às quais um agente pertence (escopo do workspace).
Webhooks de saída
GET /v1/webhooks— lista as assinaturas com estatísticas de entrega.POST /v1/webhooks— cria uma assinatura. Body:name(obr),url(obr),events(obr, array),headers,retry_count,timeout_seconds. Ao criar, um segredo HMAC é gerado e um ping de teste é enviado à URL.GET /v1/webhooks/{webhook}— detalhe com os logs de entrega recentes.PUT /v1/webhooks/{webhook}— atualizaurl,events,is_active, etc.DELETE /v1/webhooks/{webhook}— exclui a assinatura.POST /v1/webhooks/{webhook}/rotate-secret— regenera osigning_secret.
Eventos disponíveis: contact.created/updated/deleted, conversation.created/closed/resolved/pending/assigned, message.received/sent/delivered/read/failed, note.created, call.started/ended, agent.assigned/status_changed, tag.added/removed, workflow.completed, broadcast.completed.
Cada entrega leva os cabeçalhos X-Omnifox-Signature (HMAC-SHA256 do corpo) e X-Omnifox-Timestamp. Verifique-os no seu endpoint com o signing_secret.
Agentes e disponibilidade (horários)
GET /v1/agents— lista agentes com seu status de disponibilidade e atribuições de workspace. Filtros:?workspace_id=,?status=,?team_id=.GET /v1/agents/{agent}— detalhe com workspaces, equipes e estatísticas (assigned_open_conversations,total_conversations_handled). Cada atribuição trazmax_concurrent_conversations.PUT /v1/agents/{agent}/status— altera a disponibilidade. Body:workspace_id(obr),status(obr:available,busy,away,offline). Transmite a mudança em tempo real.
Os horários de turno (on-shift) que decidem quem recebe a atribuição automática são configurados por workspace; a API expõe o status de disponibilidade resultante via
status.
Verificação
Teste seu token com GET /v1/teams. Um 200 com JSON confirma que o Bearer é válido e tem escopo do workspace correto.
Dicas
- A API REST está disponível a partir do plano Crece e o limite de requisições depende do seu plano: Crece 1.200/min, Escala 2.400/min, Exclusivo sem limite. Em
429, repita com backoff. - Guarde o
signing_secretde cada webhook em um cofre: ele só é exibido ao criar ou rotacionar.
Artigos relacionados
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.
-
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.
-
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.