Webhooks entrantes

Al agregar el Webhook entrante en el canal, podrás enviar mensajes desde fuentes externas a un canal en WOZTELL.

Configurar un Webhook Entrante

En "Configuración" -> "Canal", dirígete a "Webhooks Entrantes".
Selecciona "+ Crear Webhook" para añadir un nuevo webhook.

Agrega un nombre para el webhook. Luego, "Guarda" la configuración del nuevo webhook.

Una vez que el nuevo webhook se guarde, se generará una URL.

Editar un Webhook Entrante

Para el webhook entrante existente, debes activar o desactivar el interruptor para activar o desactivar el webhook.

Puedes hacer clic en "Eliminar" para eliminar el webhook.

Enviar mensaje al canal

Para enviar un mensaje al canal de WOZTELL utilizando el webhook entrante, necesitarás utilizar el método POST y formatear el mensaje adecuadamente.

Generar la Firma

Para hacer un POST del mensaje utilizando el webhook entrante, necesitarías generar una firma y añadirla a los encabezados (headers):

"X-Woztell-Signature": signature

Para generar la firma:

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

Petición

Lo siguiente es la referencia para formular la petición.

Cuerpo

Propiedad	Tipo	Descripción	Requerido
ExternalId	Cadena	Para determinar en qué miembro se ejecutará la lógica del webhook entrante	Requerido
MessageEvent	Objeto	Necesario para la lógica del bot, el evento del mensaje puede configurarse para funcionar según como se haya configurado tu disparador.	Requerido
Meta	Objeto	Datos que se enviarán en la meta de los eventos de webhook de entrada y salida	Opcional

`messageEvent`

Propiedad	Tipo	Descripción	Requerido
Tipo	Cadena	Cualquier tipo decidido por el remitente; si el tipo se establece como "Status" (es decir, LEÍDO, ENVIADO, ENTREGADO, FALLIDO, ELIMINADO), se puede utilizar para actualizar el estado de los chats.	Requerido
Datos	Objeto	Datos que se deben incluir en el evento del mensaje.	Opcional
Data.messageId	Cadena	Si se utiliza el tipo "Status", el ID del mensaje se puede usar para actualizar el estado específico de un mensaje.	Opcional
Data.watermark	Cadena	Como alternativa al ID del mensaje, esto actualiza todos los mensajes antes del tiempo del marcador de agua (usando epoch con número de milisegundos) con el estado especificado.	Opcional
Alternativa	Cadena	Debe especificarse para habilitar todos los componentes con estilo.	Opcional
Estilo	Objeto	Apariencia y vista del mensaje de texto que se permite personalizar.	Opcional

Estilo

Propiedad	Tipo	Descripción	Requerido
Sin bordes	Booleano	Verdadero o falso; establecido en verdadero para eliminar el borde del texto	Opcional
Color de fondo	Cadena	Color de fondo del bloque de mensaje. Acepta códigos hexadecimales, abreviaturas de códigos hexadecimales y cadenas de color predeterminadas del navegador.	Opcional
Color de texto	Cadena	Color de fuente del texto. Acepta códigos hexadecimales completos, abreviados y cadenas de color predeterminadas del navegador.	Opcional
Posición	Cadena	`BOT`, `USER` or `CETNER`; posición del bloque mostrado en el hilo del buzón	Opcional
Markdown	Booleano	Verdadero o falso; establecer en verdadero para permitir formular el texto en markdown	Opcional

Ejemplo:

{
  externalId: "852992919292",
  messageEvent: {
    type: "EVENT_TYPE",
    data: {
      invoiceId,
      amount
    },
    "fallback": "**Hello there!**",
      "style": {
      "borderless": false,
      "backgroundColor": "#fff",
      "textColor": "#645",
      "position": "BOT",
      "markdown": true
      },
    data: {
      messageId, 
      watermark
      //This is the example data specifically for message status events.
    }
  }
}

Cómo configurar y gestionar Webhooks Entrantes en WOZTELL