Webhook Live Chat

Quem deve usar Webhooks?

Webhooks são projetados para desenvolvedores que têm a própria plataforma e alguma experiência com APIs.

Como configurar Webhooks no NicoChat

Veja o passo a passo para configurar webhooks no NicoChat:

Configure a URL do seu Webhook:

• Acesse Integrações e depois Webhooks.
• Opcionalmente, você pode configurar seus próprios cabeçalhos para mais segurança.
• Informe a URL do Webhook onde você quer receber os dados.

Ative Webhooks nas Configurações do Canal:

• Acesse as Configurações do Canal do chat que você quer integrar à sua plataforma (por exemplo, WhatsApp, SMS).
• Em Configurações de Live Chat, selecione Webhook.

Use a ação Pausar o Bot:

• No seu fluxo do NicoChat, inclua a ação Pausar o Bot no ponto em que você quer que a conversa passe para a sua plataforma.
• Quando um usuário interagir depois desse ponto, a mensagem será enviada para a URL do seu Webhook.

Exemplo de payload

Os dados que o NicoChat envia para a URL do seu Webhook são um payload JSON com vários detalhes sobre a mensagem e a conversa. Veja o detalhamento do payload de exemplo da imagem:

• meta
  user_ns: identificador exclusivo do usuário. agent_id: ID do agente atribuído à conversa no momento (0 indica nenhum agente atribuído). flow_ns: identificador exclusivo do fluxo de chat. team_id: ID da equipe à qual o chat pertence.
• message
  _id: identificador exclusivo da mensagem. mid: identificador exclusivo da mensagem dentro do canal. type: indica o tipo de mensagem (por exemplo, "in" para mensagem recebida). msg_type: especifica o tipo de conteúdo da mensagem (por exemplo, "text"). sender_id: ID do remetente da mensagem. agent_id: ID do agente que recebeu a mensagem (0 indica nenhum agente atribuído). assigned_agent_id: ID do agente atribuído à conversa depois que a mensagem foi recebida.
• payload
  text: contém o conteúdo de texto da mensagem. content: também contém o conteúdo de texto da mensagem. username: nome de usuário do remetente da mensagem. date: mostra a data em que a mensagem foi enviada. timestamp: timestamp da mensagem em milissegundos. ts: outra representação do timestamp da mensagem. is_delivered: indica se a mensagem foi entregue (1 significa entregue). seen: este campo vem vazio no payload de exemplo, mas pode indicar se a mensagem foi vista.

Usando a API do NicoChat

Depois de capturar a mensagem do usuário na sua plataforma, você pode usar a API do NicoChat para enviar uma resposta ao usuário dentro da conversa. A API do NicoChat usa o user_ns e o flow_ns do payload para identificar a conversa e enviar a mensagem.

Considerações adicionais

• Webhooks são uma ferramenta poderosa, mas exigem experiência em desenvolvimento.
• O NicoChat oferece suporte a vários tipos de mensagem, e o payload reflete o tipo de conteúdo (texto, imagem, etc.).
• Use a API do NicoChat para a comunicação nos dois sentidos entre a sua plataforma e os usuários do NicoChat.

Seguindo esses passos e entendendo os dados do payload, você consegue configurar webhooks para integrar sua própria plataforma aos recursos de automação do NicoChat.