Passar para o conteúdo principal

Webhooks OmniChat

Receba notificações no seu sistema sobre alterações na OmniChat

Escrito por Caroline Silva

Webhooks são notificações automáticas que a OmniChat envia para o seu sistema sempre que um objeto é alterado na plataforma — como um novo pedido, uma conversa encerrada ou uma mensagem recebida. É a forma mais eficiente de manter seus sistemas externos sincronizados em tempo real.

Webhooks para mensagens: Se você deseja receber notificações específicas de mensagens, consulte o artigo Webhooks para Mensagens na Central de Ajuda.

Como configurar

  1. Defina um endpoint no seu sistema para receber as notificações
    Exemplo: https://my.sistema.com/webhook/

  2. Informe esse endereço ao time de suporte da OmniChat para que a configuração seja ativada

Formato das notificações

Sempre que um objeto for alterado, a OmniChat enviará uma requisição POST para o seu endpoint com a seguinte estrutura:

{
  "objectId": "string",         // identificador do objeto alterado
  "resource": "Message",        // tipo do objeto (ex: Message, Order, Chat)
  "event": "string",            // tipo do evento ocorrido
  "timestamp": 2321654987987    // momento do disparo (Unix timestamp)
}

Como obter os dados completos: O payload do webhook contém apenas o identificador do objeto. Para buscar todas as informações, faça uma consulta à API OmniChat usando o objectId recebido.

Casos de uso comuns

  • Atualizar pedidos no ERP quando o status mudar na OmniChat

  • Disparar fluxos automatizados ao encerrar um atendimento

  • Registrar mensagens em sistemas de análise ou CRM externo

  • Sincronizar dados de clientes entre plataformas

Respondeu à sua pergunta?