Em resumo
- Nove eventos para escolher.Conversas, mensagens, transferências, status, leads, contatos, avaliações, agendamentos e uso.
- Assinados com um padrão aberto.Cada entrega segue o Standard Webhooks, para que seu servidor possa comprovar que ela veio da OneType.
- Novas tentativas por cerca de três dias.Uma entrega com falha é tentada de novo em um cronograma de 5 segundos até 24 horas.
- Um log que você pode reproduzir.Veja cada tentativa por 30 dias e reenvie qualquer evento com um clique.
Um lead que fica só em uma ferramenta de chat é um lead que se esquece. Um webhook é uma mensagem que a OneType envia para um endereço no seu servidor sempre que algo acontece. Use-o para adicionar leads ao seu CRM, abrir tickets, avisar sua equipe ou atualizar um painel, sem ninguém copiar dados à mão.
Os eventos
- conversation.created: um visitante inicia uma conversa.
- conversation.message.created: uma mensagem é concluída, pelo visitante, pelo agente ou pela sua equipe.
- conversation.handoff.requested: o visitante ou o agente pede uma pessoa.
- conversation.status.changed: aberta, escalada, resolvida, não resolvida ou com falha.
- lead.captured e contact.identified: um visitante deixa dados de contato ou é reconhecido como um dos seus usuários logados.
- usage.threshold.reached: seu workspace chega a 80% ou 100% do uso mensal.
Cada entrega leva o mesmo objeto que a API REST retorna para aquele recurso, então uma mensagem inclui se foi escrita pela IA. Você pode inscrever um endpoint em alguns eventos ou em todos.
Configure no painel
Em “Developer”, “Webhooks”, um proprietário ou administrador adiciona um endereço https e escolhe os eventos. O segredo de assinatura é mostrado uma única vez, então guarde-o logo. Clique em “Send test” para entregar um ping assinado e ver o código de resposta e o tempo. Você pode trocar o segredo a qualquer momento: por 24 horas, o segredo antigo e o novo assinam cada entrega, então nada quebra durante a troca.
Entregas em que você pode confiar
Responda qualquer 2xx em até 10 segundos e a entrega conta. Se seu servidor falhar ou for lento, a OneType tenta de novo após 5 segundos, 30 segundos, 2 minutos, 10 minutos, 30 minutos, 1 hora, 3 horas, 6 horas, 12 horas e depois a cada 24 horas, três vezes. A entrega é pelo menos uma vez, então guarde o cabeçalho webhook-id, que continua o mesmo em cada nova tentativa, e ignore as repetições. A ordem não é garantida.
Um endpoint que só falha por três dias é desativado, e os proprietários veem um aviso com “Turn back on”. O log de entregas guarda cada tentativa por 30 dias com status, código, tempo e um trecho da resposta, e “Redeliver” envia um evento de novo.
Segurança
Cada requisição é assinada conforme o Standard Webhooks, com um carimbo de data e hora, para você poder rejeitar requisições antigas ou repetidas. A OneType só entrega para endereços https públicos, nunca para redes privadas, e não segue redirecionamentos. A documentação para desenvolvedores inclui código de verificação para Node.js, Python e PHP.
Ideias para seu primeiro endpoint
- Adicione cada contato de lead.captured ao seu CRM ou lista de e-mails.
- Abra um ticket no seu helpdesk em conversation.handoff.requested.
- Avise o canal da sua equipe quando uma conversa for escalada.
- Avise o financeiro quando usage.threshold.reached chegar.
Somente proprietários e administradores podem ver e gerenciar endpoints, e os segredos nunca são mostrados de novo depois da primeira vez. Os outros colegas não veem os webhooks.