---
title: Webhook na Chatbot
slug: webhook-na-chatbot
description: Learn how to configure webhook integration in the Jimmy Chat platform with this comprehensive document. Discover the step-by-step process, including specifying the request URL, selecting the request type, adding headers and parameters, and configuring the
createdAt: 2023-10-22T16:05:26.944Z
---

## 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.

![](https://api.archbee.com/api/optimize/-bSuDynCYLEJ8zVZ8TyRo/Q5orAc7l9hKiiav_-DKql_image.png)

## 2. Configurando a Integração via Webhook

**Passo a Passo para Configuração:**

1. **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.
2. **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.
3. **Headers**: Informações adicionais que podem ser incluídas na solicitação. Por exemplo, autenticações, tipo de conteúdo, etc.
4. **Params**: Parâmetros que podem ser adicionados à URL da solicitação, comumente usados em requisições **GET**.
5. **Body**: Corpo da requisição onde os dados são incluídos, geralmente usado em requisições **POST**, **PUT** e **PATCH**.
6. **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:**

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

:::CodeblockTabs
makefile

```html
Authorization: Bearer TOKEN_DE_AUTENTICACAO
```
:::

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

:::CodeblockTabs
makefile

```html
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:**

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

:::CodeblockTabs
makefile

```html
Authorization: Bearer TOKEN_DE_AUTENTICACAO
Content-Type: application/json
```
:::

**Body:**

```json
{
    "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.