API/Webhook - Configuracao e Gerenciamento
O recurso API/Webhook do Intelbras Conversas permite configurar integracoes para envio de dados por API e tambem registrar webhooks para recebimento de eventos gerados pelo sistema. A configuracao e realizada pelo ambiente administrativo e pode incluir regras sobre o que acontece com o atendimento apos o envio, alem da definicao dos eventos que serao encaminhados ao webhook.
1. Acessar API/Webhook
No menu lateral, acesse Configuracoes. Na secao Avancado, clique em API/Webhook.

2. Tela de Configuracoes API/Webhook
Na tela Configuracoes API/Webhook sao exibidas as integracoes cadastradas. Cada registro apresenta informacoes da configuracao e acoes de gerenciamento.
Na parte superior, tambem estao disponiveis as abas Configuracoes API/Webhook e Logs. Para criar uma nova configuracao, clique em Adicionar.

3. Criar uma configuracao de API/Webhook
Ao clicar em Adicionar, sera aberta a tela Criar Configuracao da API/Webhook.
3.1 Dados API (PUSH)
- Nome da API: informe um nome para identificar a configuracao;
- Enviar por: selecione a opcao desejada para o envio;
- Acao no atendimento apos envio: define o comportamento do atendimento apos a execucao.
As acoes disponiveis sao Fechar, Manter aberto, Redirecionar para fila e Redirecionar para usuario. Ao escolher uma opcao de redirecionamento, selecione tambem o destino correspondente.
3.2 Configuracao do Webhook
- URL Webhook: endereco que recebera os eventos;
- E-mail para alertas: campo opcional para recebimento de aviso caso o webhook seja desativado automaticamente apos falhas consecutivas;
- Token de autenticacao: credencial enviada no cabecalho Authorization. Caso seja necessario utilizar um prefixo, ele deve ser informado junto ao token, por exemplo Bearer ou Token.
3.3 Selecionar eventos
Selecione os eventos que deverao ser encaminhados para o webhook:
- Contato criado;
- Contato atualizado;
- Atendimento atualizado;
- Atendimento iniciado;
- Atendimento finalizado;
- Atendimento finalizado (Historico da conversa);
- Novo atendimento;
- Atendimento transferido;
- Mensagem criada;
- Status da mensagem;
- Atualizacao da conexao;
- Oportunidades.
Apos preencher os campos e selecionar os eventos desejados, clique em Salvar.

4. Editar uma configuracao existente
Na tela principal de Configuracoes API/Webhook, localize a configuracao desejada e clique no icone de edicao.
Na tela Editar Configuracao da API/Webhook, e possivel atualizar os dados da API, alterar a acao executada apos o envio, modificar os dados do webhook e revisar os eventos selecionados.
A configuracao tambem possui a opcao Ativo, utilizada para definir se a integracao permanecera habilitada. Depois de realizar os ajustes, salve as alteracoes.

5. Boas praticas
- Utilize nomes claros para identificar cada integracao;
- Confirme a URL do webhook antes de salvar a configuracao;
- Selecione apenas os eventos necessarios para a integracao;
- Revise com atencao a acao configurada para o atendimento apos o envio;
- Mantenha o token de autenticacao protegido e compartilhe-o somente com sistemas e pessoas autorizadas;
- Utilize a aba Logs para apoiar a analise das integracoes quando necessario.
6. Beneficios do recurso
- Integracao com sistemas externos: permite conectar o Intelbras Conversas a outros sistemas e processos;
- Automacao de eventos: possibilita enviar eventos do Conversas automaticamente para um webhook configurado;
- Controle do fluxo de atendimento: permite definir o comportamento do atendimento apos o envio;
- Flexibilidade: cada configuracao pode utilizar eventos especificos conforme a necessidade da integracao;
- Gerenciamento centralizado: criacao, edicao e acompanhamento das configuracoes ficam concentrados no ambiente administrativo.
Observacao: para detalhes tecnicos sobre endpoints e utilizacao da API do Intelbras Conversas, consulte tambem o artigo API Intelbras Conversas disponivel nesta base de conhecimento.
Este artigo foi útil?
Que bom!
Obrigado pelo seu feedback
Desculpe! Não conseguimos ajudar você
Obrigado pelo seu feedback
Feedback enviado
Agradecemos seu esforço e tentaremos corrigir o artigo