Webhook

O canal Webhook oferece uma maneira de criar uma integração personalizada com o Chatlayer que atua como um canal.

Com o canal Webhook, você pode enriquecer as informações enviadas por determinados canais. Por exemplo, em vez de usar o direto canal do Facebook Messenger ou WhatsApp, você pode usar o Webhook para enviar mensagens ao Messenger ou ao WhatsApp.

Ao usar o canal Webhook, o canal escolhido é conectado indiretamente ao Chatlayer.

O canal Webhook não deve ser confundido com offloading do Webhook, projetado para encaminhamento a agentes humanos.

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

Registrar uma API de Webhook

Para adicionar uma API de Webhook ao seu bot:

1

Adicione um Webhook canal ao seu bot.

2

Configure o URL do Webhook campo.

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

3

Opcionalmente, configure o token de verificação campo.

Isso pode ser qualquer string arbitrária, mas recomendamos usar a fornecida, que foi gerada aleatoriamente.

Mensagens do Webhook

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

200

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

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:

Especificações das mensagens do Chatlayer