Envie requisições com eventos especificos sempre quando houver atualizações no seu WhatsApp.
O que seria um WebHook?
Um webhook é como um assistente que fica de olho em eventos importantes. Quando algo interessante acontece, ele imediatamente avisa, permitindo que você tome ações específicas. É como ter um mensageiro eficiente que entrega notícias importantes no momento em que ocorrem.
Para ilustrar melhor, imagine a história de Jonas e seu item com defeito.
Jonas entrega seu item defetuoso ao técnico, deixando um número de contato. Após o conserto, o técnico notifica Jonas usando o número fornecido.
De forma semelhante, o Webhook na nossa API opera de maneira eficaz. Qualquer empresa que possua uma API interna pode fornercer uma URL específica , em outros termos um endpoint. Quando um evento predeterminado ocorre, nesse exemplo um atendimento é finalizado, a notificação é automaticamente enviada para a URL informada.
Ativando a funcionalidade
O primeiro passo para consumir nossa api é acessar a seção Módulos(Recursos Extra).
Estando na seção, ative essa funcionalidade clicando no toggle presente no WebHook.
Se o toggle estiver desativado, o disparo de eventos falhará!
Eventos Disponíveis
Movimentação de cards
Sempre que um card (conversa) for movido de uma lista para outra, será disparado um evento contendo informações do card.
{
event: 'card-move', // Movimentação de cards
channel: '5532900000000', // Número do Whatsapp conectado
chat: '559988776655', // Número do Whatsapp do card
server: 'contact', // Contato ou Grupo
list: {
"id": "XXXXXXXXXX",
"title": "Titulo da lista",
}
user: {
"username": "[email protected]",
"name": "Nome do usuário"
}
}
Transferência de usuário
Sempre que um atendimento for transferido para um atendente (usuário), será disparado um evento contendo informações.
{
event: 'atm-assign-user', // Transferência de usuário
channel: '5532900000000', // Número do whatsapp conectado
chat: '[email protected]', // @c.us para contato e @g.us para grupo
user: {
"username": "[email protected]",
"name": "Nome do usuário"
}
}
Card encerrado
Sempre que um card for encerrado será disparado um evento contendo informações.
{
event: 'card-end', // Transferência de usuário
channel: '5532900000000', // Número do whatsapp conectado
chat: '559988776655', // Número do Whatsapp do card
server: 'contact', // Contato ou Grupo
ganho: '0,00', // Se obteve ganho, o valor é informado
user: {
"username": "[email protected]",
"name": "Nome do usuário"
}
}
Atendimento finalizado
Sempre que um atendimento for finalizado será disparado um evento contendo informações.
{
event: 'atm-end', // Finalizar atendimento
channel: '5532900000000', // Número do whatsapp conectado
chat: '559988776655', // Número do Whatsapp do card
server: 'contact', // Contato ou Grupo
}
Atribuição de tag
Sempre que houver alteração de tags para a conversa será disparado um evento contendo informações.
{
event: 'tags-change', // Finalizar atendimento
channel: '5532900000000', // Número do whatsapp conectado
chat: '559988776655', // Número do Whatsapp do card
server: 'contact', // Contato ou Grupo
tags: [ 'green', 'red', 'blue', 'gray' ]
}
Configurando um evento
- Navegue até a seção Módulos (Recursos Extra) no seu painel.
- Localize o card relacionado à WebHook e clique no botão Configurar.
- No card do evento escolhido, você verá campos para inserir a URL da sua API (endpoint).
- Digite a URL da sua API no campo fornecido e pressione ENTER para salvar as modificações.
"https://minhaapi.com/servicecompleted" é apenas um exemplo ilustrativo