Crear una campaña webhook

Crear una campaña de webhook o incluir un webhook en una campaña multicanal te permite desencadenar acciones no relacionadas con la aplicación proporcionando a otros sistemas y aplicaciones información en tiempo real.

Puedes utilizar webhooks para enviar información a sistemas, como Salesforce o Marketo, o a tus sistemas backend. Por ejemplo, es posible que desee abonar una promoción en las cuentas de sus clientes después de que hayan realizado un evento personalizado un determinado número de veces.

Paso 1: Elige dónde construir tu mensaje

¿No estás seguro de si tu mensaje debe enviarse mediante una campaña o un Canvas? Las campañas son mejores para mensajes sencillos y únicos, mientras que los lienzos son mejores para recorridos de usuario de varios pasos.

• campaña
• canvas

Paso 2: Crea tu webhook

Puedes elegir crear un webhook desde cero, utilizar una plantilla existente o utilizar una de nuestras plantillas existentes. A continuación, crea tu webhook en la pestaña Redactar del editor.

La pestaña Componer consta de los siguientes campos:

• Idioma
• URL del webhook
• Método HTTP
• Cuerpo de la solicitud

Idioma

Se admite la internacionalización en la URL y en el cuerpo de la solicitud. Para internacionalizar tu mensaje, selecciona Añadir idiomas y rellena los campos obligatorios.

Le recomendamos que seleccione sus idiomas antes de escribir el contenido para que pueda rellenar el texto donde corresponda en el Líquido. Para consultar nuestra lista completa de idiomas disponibles que puedes utilizar, consulta Idiomas admitidos.

Si añades texto en un idioma escrito de derecha a izquierda, ten en cuenta que el aspecto final de los mensajes escritos de derecha a izquierda depende en gran medida de cómo los rendericen los proveedores de servicios. Para conocer las mejores prácticas de elaboración de mensajes de derecha a izquierda que se muestren con la mayor precisión posible, consulta Crear mensajes de derecha a izquierda.

URL del webhook

La URL del webhook, o URL HTTP, especifica tu punto final. El endpoint es el lugar donde enviarás la información que estás capturando en el webhook.

Si desea enviar información a un proveedor, éste debe proporcionar esta URL en la documentación de su API. Si envías información a tus propios sistemas, comprueba con tu equipo desarrollador o de ingeniería que utilizas la URL correcta.

Braze sólo permite URL que se comuniquen a través de los puertos estándar 80 (HTTP) y 443 (HTTPS).

Utilizar Liquid

Puede personalizar las URL de sus webhooks utilizando Liquid. En ocasiones, ciertos puntos finales pueden requerir que identifique a un usuario o que proporcione información específica del usuario como parte de su URL. Cuando utilices Liquid, asegúrate de incluir un valor predeterminado para cada dato específico del usuario que utilices en tu URL.

Método HTTP

El método HTTP que debes utilizar variará en función del punto final al que envíes información. En la mayoría de los casos, utilizarás POST.

Cuerpo de la solicitud

El cuerpo de la solicitud es la información que se enviará a la URL especificada. Puedes crear el cuerpo de tu solicitud de webhook con pares clave-valor JSON o texto sin formato.

Pares clave-valor JSON

Los pares clave-valor JSON te permiten escribir fácilmente una solicitud para un punto final que espera un formato JSON. Sólo puedes utilizarlo con un punto final que espere una petición JSON. Por ejemplo, si tu clave es message_body, el valor correspondiente podría ser Your order just arrived!. Una vez introducido el par clave-valor, el compositor configurará la solicitud en sintaxis JSON y se mostrará automáticamente una vista previa de la solicitud JSON.

Puedes personalizar tus pares clave-valor utilizando Liquid, por ejemplo, incluyendo en tu solicitud cualquier atributo del usuario, atributo personalizado o propiedad del evento. Por ejemplo, puedes incluir el nombre y el correo electrónico de un cliente en tu solicitud. Asegúrate de incluir un valor predeterminado para cada atributo.

Texto bruto

La opción de texto sin formato le ofrece la flexibilidad de escribir una solicitud para un punto final que espera un cuerpo de cualquier formato. Por ejemplo, podrías utilizarlo para escribir una solicitud para un punto final que espera que tu solicitud esté en formato XML.

Tanto la personalización como la internacionalización mediante Liquid son compatibles con el texto sin formato.

Si establece el encabezado de solicitud Content-Type en application/x-www-form-url-encoded, el cuerpo de la solicitud debe tener formato de cadena codificada en URL. Por ejemplo:

1
to={{custom_attribute.${example}}}&text=Your+order+just+arrived

Paso 3: Configurar ajustes adicionales

Encabezados de solicitud (opcional)

Algunos puntos finales pueden requerir que incluya cabeceras en su solicitud. En la sección Componer del compositor, puedes añadir tantas cabeceras como necesites.

Las cabeceras de solicitud comunes son Content-Type especificaciones (que describen qué tipo de datos esperar en el cuerpo, como XML o JSON) y cabeceras de autorización que contienen sus credenciales con su proveedor o sistema.

Las especificaciones de tipo de contenido deben utilizar la clave Content-Type. Los valores más comunes son application/json o application/x-www-form-urlencoded.

Las cabeceras de autorización deben utilizar la clave Authorization. Los valores habituales son Bearer {{YOUR_TOKEN}} o Basic {{YOUR_TOKEN}} , donde YOUR_TOKEN son las credenciales proporcionadas por tu proveedor o sistema.

Paso 4: Pruebe a enviar su mensaje

Antes de lanzar la campaña, Braze recomienda probar el webhook para asegurarse de que el formato de la solicitud es correcto.

Para ello, cambie a la pestaña Prueba y envíe un webhook de prueba. Puede probar el webhook como un usuario aleatorio, un usuario específico (introduciendo su dirección de correo electrónico o ID de usuario externo) o un usuario personalizado con los atributos que usted elija.

Después de enviar el webhook de prueba, aparecerá un diálogo con el mensaje de respuesta. Si la solicitud de webhook no tiene éxito, consulte el mensaje de error para obtener ayuda en la solución de problemas de su webhook. El siguiente ejemplo detalla la respuesta de un webhook con una URL de webhook inválida.

1
2
3
4
5
6
7
8
9
404 Not Found

{
  "error": {
    "message": "Unrecognized request URL. Please see https://lob.com/docs or email us at [email protected].",
    "status_code": 404
  }
}

Paso 5: Construye el resto de tu campaña o Canvas

• campaña
• canvas

Paso 6: Revisar y desplegar

Cuando hayas terminado de crear lo último de tu campaña o Canvas, revisa sus detalles, pruébala y ¡envíala!

Lo que hay que saber

Errores, lógica de reintentos y tiempos de espera

Los webhooks dependen de que los servidores Braze realicen solicitudes a un punto final externo, por lo que pueden producirse errores de sintaxis y de otro tipo. El primer paso para evitar errores de webhook es probar tu campaña webhook en busca de errores de sintaxis y asegurarte de que las variables personalizadas tienen un valor por defecto. Sin embargo, los webhooks pueden fallar debido a problemas como claves de API caducadas, límites de velocidad o errores inesperados del servidor. Si tu webhook no se envía, se registra un mensaje de error en el Registro de actividad de mensajes.

Esta descripción contiene la hora en que se produjo el error, el nombre de la aplicación y el mensaje de error:

Si el cuerpo del mensaje no es lo suficientemente claro en cuanto al origen del error, debes consultar la documentación del punto final de la API que estás utilizando. Suelen ofrecer una explicación de los códigos de error que utiliza el punto final, así como su causa habitual.

Al igual que otras campañas, Braze realiza un seguimiento de la entrega de sus campañas webhook y de las conversiones resultantes. Cuando se envía la solicitud de webhook, el servidor receptor devolverá un código de respuesta indicando qué ha ocurrido con la solicitud.

La siguiente tabla resume las diferentes respuestas que puede enviar el servidor, cómo afectan a los análisis de la campaña y si, en caso de error, Braze intentará volver a entregar la campaña:

Lista de IP permitidas

Cuando se envía un webhook desde Braze, los servidores Braze realizan solicitudes de red a nuestros clientes o a servidores de terceros. Con listas de direcciones IP permitidas, puedes verificar que las solicitudes de webhook proceden de Braze, añadiendo una capa de seguridad.

Braze enviará webhooks desde las siguientes IPs. Las IP de la lista se añaden automática y dinámicamente a cualquier clave de API que haya sido objeto de adhesión voluntaria a la lista permitida.

• united states (us)
• european union (eu)
• australia (au)

Utilizar webhooks con socios Braze

Hay muchas maneras de utilizar webhooks, y con nuestros socios tecnológicos (Alloys), puede utilizar webhooks para nivelar su comunicación directamente con sus clientes y usuarios.

Consulta:

• Messenger
• Remerge
• Lob.com
• ¡Y muchos más de nuestros socios tecnológicos!