> For the complete documentation index, see [llms.txt](https://centraldeajuda.tradeinsights.com/bem-vindo-a-trade-insights/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://centraldeajuda.tradeinsights.com/bem-vindo-a-trade-insights/controle/integracoes/webhook.md).

# Webhook

Webhook é uma técnica usada para comunicação entre sistemas, permitindo que um aplicativo envie informações ou notificações para outro automaticamente e em tempo real.

### Como funciona?

Um webhook funciona de forma proativa: quando um evento específico ocorre em um sistema (exemplo: criação de um pedido, conclusão de um pagamento), ele envia uma mensagem (normalmente no formato JSON) para uma URL específica configurada por você.

### Componentes principais<br>

**1. Evento:**

• É a ação que dispara o webhook, como “novo cadastro”, “compra realizada”, ou “pedido cancelado”.

**2. Endpoint (URL):**

• É a URL configurada no sistema que vai receber as informações enviadas pelo webhook. Normalmente, é um servidor configurado para lidar com esses dados.

**3. Payload:**

• É o conjunto de informações enviadas pelo webhook, geralmente em formato JSON. Contém detalhes sobre o evento.

**4. Resposta (opcional):**

• Após o envio do webhook, o sistema receptor pode enviar uma resposta para confirmar que a mensagem foi recebida corretamente.

{% hint style="info" %}
**Exemplo do fluxo de um Webhook**\
\
**1.** Um cliente realiza uma compra em pelo Link do Plano.

**2.** Nosso sistema então dispara um webhook para a URL configurada.

**3.** O servidor da Ferramenta que fez integração recebe o webhook, lê o payload e registra o pagamento o evento..
{% endhint %}

### Benefícios

<br>

• **Automação em tempo real:** Não é necessário “checar” o status de eventos; o sistema avisa quando algo acontece.

• **Integração simplificada**: Conecta diferentes serviços ou sistemas sem necessidade de consulta constante (pull).

• **Escalabilidade**: Adequado para sistemas que precisam lidar com múltiplos eventos.

<br>

## Webhooks enviados da Insights, como configurar?

Clicando em Configurações, você poderá criar uma nova configuração para envio de webhooks baseado em eventos.

\
**1. Primeiro você vai no menu no item Controle > Integrações**

<figure><img src="https://2520162152-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAf7j6zODfGcke8zi1ePI%2Fuploads%2Fds4WpKN30T40y2m3TPYE%2FCaptura%20de%20Tela%202024-11-26%20a%CC%80s%2011.01.36.png?alt=media&amp;token=87cc39a8-a1e1-49f6-8b19-df5bd48a16c0" alt=""><figcaption></figcaption></figure>

**2. Clique no card "Webhook Conversão" e no sidebar lateral no campo "Webhook URL" insira seu link.**

<figure><img src="https://2520162152-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAf7j6zODfGcke8zi1ePI%2Fuploads%2FBHP4f4PVvGIHz6Wt46ma%2FCaptura%20de%20Tela%202024-11-26%20a%CC%80s%2011.00.02.png?alt=media&amp;token=f0b7222f-d3e3-4608-b398-fdd1d96c05fe" alt=""><figcaption></figcaption></figure>