Webhook na Chatbot

9 min

1. Introdução

A função de integração via webhook na plataforma Jimmy Chat é uma ferramenta poderosa que permite a comunicação do chatbot com sistemas externos, potencializando suas funcionalidades e tornando a experiência do usuário ainda mais rica.

2. Configurando a Integração via Webhook

Passo a Passo para Configuração:

URL da Requisição: Especifique a URL para a qual o webhook enviará a requisição. Esta URL pertence ao sistema externo com o qual deseja integrar.
Tipo de Requisição:
- GET
  Usado para solicitar dados de um recurso.
- POST
  Usado para enviar dados para serem processados por um recurso.
- PUT
  Usado para atualizar um recurso existente.
- PATCH
  Usado para fazer atualizações parciais em um recurso.
- DELETE
  Usado para deletar um recurso.
Headers: Informações adicionais que podem ser incluídas na solicitação. Por exemplo, autenticações, tipo de conteúdo, etc.
Params: Parâmetros que podem ser adicionados à URL da solicitação, comumente usados em requisições GET.
Body: Corpo da requisição onde os dados são incluídos, geralmente usado em requisições POST, PUT e PATCH.
Resposta: Configure como o chatbot deve reagir à resposta recebida do webhook. Por exemplo, pode-se determinar a próxima ação do chatbot com base no status da resposta.

3. Utilizando Campos de Contexto

Campos de contexto coletados durante o fluxo de atendimento podem ser utilizados dentro das configurações do webhook, permitindo uma integração personalizada e dinâmica. Por exemplo, se você coletou o e-mail do usuário durante o fluxo, pode inserir esse e-mail no corpo (Body) de uma requisição POST para registrá-lo em um sistema externo.

Para utilizar um campo de contexto, usa-se a sintaxe entre chaves, exemplo {{nome_do_campo}}.

4. Exemplos

Exemplo: Verificar Status de Pedido via Webhook

Objetivo: Permitir que o usuário verifique o status de seu pedido através do chatbot, buscando as informações em um sistema externo.

Informações solicitadas no chatbot:

Número do pedido {{numero_pedido}}

Configuração do Webhook:

URL de Destino: https://meusistema.com/api/statusPedido
Tipo de Requisição: GET
Headers: (Por exemplo, para autenticação)

Authorization: Bearer TOKEN_DE_AUTENTICACAO

Params: (Parâmetros adicionados à URL da requisição)

pedido_id={{numero_pedido}}

(Observação: {{numero_pedido}} é um campo de contexto que será substituído pelo valor coletado no fluxo do chatbot.)

Resposta: (Para determinar a próxima ação do chatbot)

Se status 200 (Sucesso): Informar o status do pedido ao usuário.
Se outro status (Erro): Informar o usuário que ocorreu um erro e pedir para tentar novamente mais tarde.

Exemplo: Cadastro de Usuários via Webhook

Objetivo: Registrar informações do usuário em um sistema externo após coletar seus dados pelo chatbot.

Informações coletadas no chatbot:

Nome do usuário {{nome_usuario}}
E-mail do usuário {{email_usuario}}
CPF do usuário {{cpf}}

Configuração do Webhook:

URL de Destino: https://meusistema.com/api/cadastro
Tipo de Requisição: POST
Headers: (Por exemplo, para autenticação e definição de formato JSON)

Authorization: Bearer TOKEN_DE_AUTENTICACAO
Content-Type: application/json

Body:

{
    "nome": "{{nome_usuario}}",
    "email": "{{email_usuario}}",
    "documento": "{{cpf}}"
}

(Observação: {{nome_usuario}}, {{email_usuario}} e {{cpf}} são campos de contexto que serão substituídos pelos valores coletados no fluxo do chatbot.)

Resposta: (Para determinar a próxima ação do chatbot)

Se status 200 (Sucesso): Agradecer o usuário e informar que o cadastro foi realizado.
Se outro status (Erro): Informar o usuário que ocorreu um erro e pedir para tentar novamente mais tarde.