Webhook

O canal Webhook fornece uma forma de construir uma integração personalizada com o Chatlayer que funciona como um canal.

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

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

O canal Webhook não deve ser confundido com descarregamento de Webhook, projetado para descarregar para agentes humanos.

Enviar e receber mensagens com Webhook

O Chatlayer fornece:

• um endpoint de API de mensagem Webhook: para enviar uma mensagem de usuário ao bot

• uma configuração de Webhook: Habilita notificações quando o bot responde às mensagens de usuário enviadas via a API de Mensagem Webhook, conforme detalhado aqui. Esta API opera em tempo quase real, permitindo que você acione ações baseadas em eventos imediatamente ao receber uma resposta do bot. Essa configuração facilita a integração perfeita da lógica de fluxo do bot em sua aplicação ou plataforma de mensagens.

O mecanismo geral é vagamente baseado no protocolo Pubsub e depende de uma requisição HTTP contendo a resposta da mensagem do bot sendo enviada para uma URL de Endpoint do consumidor. A URL de Endpoint do 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

Adicionar um Webhook canal ao seu bot.

2

Configure o URL do Webhook .

Esta URL deve ser pública ou, pelo menos, estar 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 .

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

Mensagens Webhook

POST URL do endpoint webhook do cliente configurada no Chatlayer.ai

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

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

200

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

Objetos de mensagem

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

Especificações das mensagens do Chatlayer