> For the complete documentation index, see [llms.txt](https://docs.chatlayer.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.chatlayer.ai/chatlayer-documentation-pt-br/channels/all-channels/webhook-api.md).

# Webhook

Com o canal Webhook, você pode enriquecer as informações enviadas por determinados [canais](/chatlayer-documentation-pt-br/channels/all-channels.md). Por exemplo, em vez de usar o [direto](/chatlayer-documentation-pt-br/channels/all-channels.md#direct-channels) canal do Facebook Messenger ou WhatsApp, você pode usar o Webhook para enviar mensagens ao Messenger ou ao WhatsApp.

<figure><img src="/files/f0e7a023b9ed2eafce2f4e30b45ef5de62ccdb1f" alt=""><figcaption><p>Ao usar o canal Webhook, o canal escolhido é conectado indiretamente ao Chatlayer.</p></figcaption></figure>

{% hint style="warning" %}
O canal Webhook não deve ser confundido com [offloading do Webhook](https://docs.chatlayer.ai/integrations/human-offloading-live-chat/offloading-webhook), projetado para encaminhamento a agentes humanos.
{% endhint %}

## Envie e receba mensagens com Webhook

O Chatlayer oferece:

* um endpoint de API de mensagens do Webhook: para enviar uma mensagem do usuário ao bot
* uma configuração de Webhook: permite notificações quando o bot responde às mensagens do usuário enviadas via a API de Mensagens do Webhook, conforme detalhado [aqui](#registering-a-webhook-api). Esta API opera em quase tempo real, permitindo acionar ações baseadas em eventos imediatamente após o recebimento de uma resposta do bot. Essa configuração facilita a integração contínua da lógica de fluxo do bot ao seu aplicativo ou plataforma de mensagens.

O mecanismo geral é baseado de forma flexível no protocolo Pubsub e depende do envio de uma solicitação HTTP contendo a resposta da mensagem do bot para uma URL de endpoint do consumidor. A URL do endpoint webhook do cliente pode ser configurada em nossa plataforma conforme descrito em [esta seção](#registering-a-webhook-api).

## Registrar uma API de Webhook

Para adicionar uma API de Webhook ao seu bot:

{% stepper %}
{% step %}
[Adicione um **Webhook** canal](/chatlayer-documentation-pt-br/channels/add-a-channel-to-your-bot.md) ao seu bot.

<figure><img src="/files/33693a2aaa0a726ce56c084fcd44ff5030ae015b" alt="" width="375"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Configure o **URL do Webhook** campo.

**T**Esta URL deve estar disponível publicamente ou, no mínimo, disponível a partir do intervalo de IPs da nossa plataforma. Recomendamos fortemente o uso de HTTPS para este endpoint.
{% endstep %}

{% step %}
Opcionalmente, configure o **token de verificação** campo.

Isso pode ser qualquer string arbitrária, mas recomendamos usar a fornecida, que foi gerada aleatoriamente.
{% endstep %}
{% endstepper %}

## Mensagens do Webhook

<mark style="color:verde;">`POST`</mark> `URL do endpoint webhook do cliente configurada no Chatlayer.ai`

Quando uma mensagem do usuário é enviada para a API de mensagens do Webhook, a(s) resposta(s) do bot será(ão) enviada(s) para a URL do endpoint webhook do cliente.

O objeto de payload do corpo da resposta do bot incluirá a mensagem do bot. Essa mensagem pode ter uma estrutura de objeto diferente com base no tipo de mensagem.

{% tabs %}
{% tab title="200 " %}

```
  "recipient": {
    "id": "default-b94215f0-0c7e-11ea-9c43-7174cba76asdfoijadsfoiadsiojadfiojasodijfb12"
  },
  "verifyToken": "eenheeluniekeverifytoken",
  "message": {
    "text": "mensagem de texto de teste"
  }
```

{% endtab %}
{% endtabs %}

## Objetos de mensagem

Uma mensagem do bot enviada para a URL do endpoint webhook do cliente e retornada como resposta às mensagens do usuário pode ter diferentes estruturas de objeto, dependendo do tipo de mensagem. Quer aprender como criar esses objetos de mensagem? Leia sobre isso aqui:

{% content-ref url="/pages/bd5260ba51e505cef74ec499460222df5caaf8f4" %}
[Especificações das mensagens do Chatlayer](/chatlayer-documentation-pt-br/integrateandcode/chat-message-structure-for-apis.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.chatlayer.ai/chatlayer-documentation-pt-br/channels/all-channels/webhook-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.