Webhooks de Entrada

Ao adicionar o Webhook De Entrada no canal, você poderá postar mensagens de fontes externas em um canal no WOZTELL.

Configurar um Webhook de Entrada

Em "Configurações" -> "Canal", vá para "Webhooks de Entrada".
Selecione "+ Criar Webhook" para adicionar um novo webhook.

Adicione um nome para o webhook. Em seguida, "Salvar" as novas configurações do webhook.

Uma vez que o novo webhook tenha sido salvo, uma URL será gerada.

Editar um Webhook de Entrada

Para o webhook de entrada existente, você pode alternar este interruptor para ativar/desativar o webhook.

Você pode clicar em "Excluir" para remover o webhook.

Postar Mensagem no Canal

Para enviar uma mensagem para o canal WOZTELL usando o webhook de entrada, você precisará usar o método POST e formatar a mensagem adequadamente.

Gerar a Assinatura

Para POST a mensagem usando o webhook de entrada, você deve gerar uma assinatura e adicioná-la aos cabeçalhos:

"X-Woztell-Signature": assinatura

Para gerar a assinatura:

  const bodyStr = JSON.stringify(Body)
  const assinatura = crypto.createHmac("sha256", channelSecret)
    .update(bodyStr)
    .digest("base64")

Requisição

A seguir está a referência para formular a requisição.

Corpo

Propriedade	Tipo	Descrição	Necessário
externalId	String	Para determinar qual membro a lógica do webhook de entrada será executada	Necessário
messageEvent	Objeto	Necessário para a lógica do bot, o messageEvent pode ser configurado para trabalhar conforme seu gatilho for configurado.	Necessário
meta	Objeto	Dados que serão enviados no meta dos eventos de webhook de entrada e saída	Opcional

`messageEvent`

Propriedade	Tipo	Descrição	Necessário
type	String	Qualquer tipo decidido pelo remetente; se o tipo for definido como "Status" (ou seja, `READ`, `SENT`, `DELIVERED`, `FAILED`, `DELETED`), ele pode ser usado para atualizar o status das mensagens.	Necessário
data	Objeto	Dados a serem incluídos no messageEvent.	Opcional
data.messageId	String	Se o tipo "Status" for usado, o `messageId` pode ser usado para atualizar o status de mensagens específicas.	Opcional
data.watermark	String	Alternativa ao `messageId`, isso atualiza todas as mensagens antes do tempo da marca d'água (usa o número epoch com ms) com o status.	Opcional
fallback	String	Precisa ser especificado para habilitar todos os componentes no `style`	Opcional
style	Objeto	Aparência e visualização da mensagem de texto, que pode ser personalizada	Opcional

`style`

Propriedade	Tipo	Descrição	Necessário
borderless	Booleano	`true` ou `false`; defina como `true` para remover a borda do texto	Opcional
backgroundColor	String	Cor de fundo do bloco de mensagem. Aceita código hex, abreviação do código hex, e string de cor do navegador padrão	Opcional
textColor	String	Cor da fonte do texto. Aceita código hex, abreviação do código hex, e string de cor do navegador padrão	Opcional
position	String	`BOT`, `USER` ou `CENTER`; posição do bloco mostrado no tópico da caixa de entrada	Opcional
markdown	Booleano	`true` ou `false`; defina como `true` para permitir a formatação do texto em markdown	Opcional

Exemplo:

{
  externalId: "852992919292",
  messageEvent: {
    type: "EVENT_TYPE",
    data: {
      invoiceId,
      amount
    },
    "fallback": "**Olá, tudo bem!**",
      "style": {
      "borderless": false,

                      "backgroundColor": "#fff",
      "textColor": "#645",
      "position": "BOT",
      "markdown": true
      "style": {
      "borderless": false,
      "backgroundColor": "#fff",
      "textColor": "#645",
      "position": "BOT",
      "markdown": true
      "style": {

Como configurar e gerenciar Webhooks de Entrada no WOZTELL