Crear un Webhook Braze to Braze

Los webhooks Braze to Braze te permiten llamar a la API REST de Braze desde dentro de Braze utilizando un webhook en una campaña o Canvas. Utiliza esto para tareas de orquestación, como desencadonar un Canvas desencadentado por API. Para actualizar los atributos de usuario, los eventos personalizados o las compras desde Canvas, utiliza la opción Actualización de usuario. Está diseñado para cambios en el perfil de usuario y procesa las actualizaciones de manera más eficiente.

Para sacar el máximo partido a este artículo, debes estar familiarizado con el funcionamiento de los webhooks y con cómo crear un webhook en Braze.

Utiliza la actualización de usuario para los cambios en los datos de usuario.

Para actualizar los perfiles de usuario desde Canvas, incluyendo la modificación de atributos personalizados, el registro de eventos personalizados o el registro de compras, utiliza la actualización de usuario en lugar de un Webhook Braze to Braze.

La actualización de usuarios agrupa varios cambios y los envía por lotes, lo que la hace más rápida que los webhooks. Es más fácil de configurar que un webhook y admite actualizaciones complejas a través de tu compositor JSON avanzado. Por ejemplo, para contar cuántas veces un usuario ha visto un mensaje, utiliza la característica Incrementar y disminuir de User Update en lugar de un Webhook Braze to Braze.

Cuándo utilizar un webhook Braze to Braze

La actualización de usuarios puede realizar casi todas las mismas tareas que un Webhook Braze to Braze para actualizar los perfiles de usuario. Para actualizaciones complejas que vayan más allá de los simples atributos personalizados, puedes utilizar el compositor JSON avanzado.

Puedes utilizar un webhook Braze to Braze cuando necesites llamar a la API REST de Braze desde dentro de Braze para situaciones distintas a las actualizaciones directas de los usuarios desde los pasos en Canvas. Algunos ejemplos comunes son:

• Desencadenar un Canvas activado por API desde otro Canvas
• Llamar a otros puntos finales de mensajería para patrones de orquestación en los que un flujo de trabajo en Braze necesita invocar una API que no tiene un componente Canvas dedicado.

Para las actualizaciones de usuarios dentro de Canvas, el método recomendado es utilizar la función Actualización de usuario.

Requisitos previos

Para crear un Webhook Braze to Braze, necesitas una clave de API con permisos para el punto final al que deseas acceder. Por ejemplo, para desencadear un Canvas desencadentado por API, necesitas una clave de API con elcanvas.trigger.sendpermiso.

Configuración de tu Webhook Braze to Braze

El flujo de trabajo general para crear un Webhook Braze to Braze sigue estos pasos:

1. Crea un webhook como campaña o componente de Canvas.
2. Elija Plantilla en blanco.
3. En la pestaña Componer, especifica la URL del webhook y el cuerpo de la solicitud para tu caso de uso de la API.
4. En la pestaña Configuración, especifica tu método HTTP y los encabezados de solicitud según lo requiera el punto final.
5. Configura cualquier configuración de entrega adicional (por ejemplo, desencadenar desde un evento personalizado) y crea el resto de tu campaña o Canvas.

Activar un segundo lienzo a partir de un lienzo inicial

En este caso de uso, creas dos Canvas y utilizas un Webhook Braze to Braze para desencadear el segundo Canvas desde el primero. Esto actúa como un disparador de entrada para cuando un usuario alcanza un cierto punto en otro Canvas.

1. Empieza creando tu segundo Canvas, el Canvas que debe desencadenar tu Canvas inicial.
2. Para la Programación de entrada en Canvas, selecciona Desencadenado por API.
3. Anota tu ID de Canvas. Lo necesitarás en un paso posterior.
4. Continúa construyendo los pasos de tu segundo lienzo y guárdalo.
5. Por último, crea tu primer lienzo. Busque el paso en el que desea activar el segundo Canvas y cree un nuevo paso con un webhook.

Consulte lo siguiente cuando configure su webhook:

• URL del webhook: La URL de tu punto final REST seguida de /canvas/trigger/send. Por ejemplo, para la instancia US-06, la URL sería https://rest.iad-06.braze.com/canvas/trigger/send.
• Cuerpo de la solicitud: Texto sin procesar

Encabezados de solicitud y método

Braze requiere un encabezado HTTP para la autorización que incluya tu clave de API y otro que declare tu tipo de contenido.

• Encabezados de solicitud:
  • Autorización: Bearer YOUR_API_KEY
  • Tipo de contenido: application/json
• Método HTTP: POST

ReemplazaYOUR_API_KEY por una clave de API de Braze que tengacanvas.trigger.sendlos permisos necesarios. Puedes crear una clave de API en el panel de Braze yendo a Configuración > Claves de API.

Cuerpo de la solicitud

Añada su solicitud /canvas/trigger/send en el campo de texto. Para obtener más información, consulta Envío de mensajes de Canvas mediante entrega desencadenada por API. El siguiente es un ejemplo del cuerpo de la solicitud para este punto final, donde your_canvas_id es el ID del lienzo de su segundo lienzo:

1
2
3
4
5
6
7
8
{
  "canvas_id": "your_canvas_id",
  "recipients": [
    {
      "external_user_id": "{{${user_id}}}"
    }
  ]
}

Cuando un usuario llega a este paso del webhook en el primer Canvas, Braze desencadena el segundo Canvas para ese usuario a través de la API.

Consideraciones

• Actualizaciones de los usuarios: Para actualizar los perfiles de usuario desde Canvas (atributos, eventos, compras), utiliza User Update en lugar de los Webhook Braze to Braze para obtener una mayor eficiencia y rentabilidad.
• Los webhooks Braze to Braze están sujetos a límites de velocidad de los puntos finales.
• Las actualizaciones del perfil de usuario generan puntos de datos que se contabilizan en tu consumo total, mientras que el envío de otro mensaje a través de los puntos finales de mensajería no lo hace.
• Para dirigirte a usuarios anónimos, utilizabraze_id en lugar deexternal_id en el cuerpo de la solicitud de tu webhook.
• Puedes guardar tu Webhook Braze to Braze como plantilla de webhook para volver a utilizarlo.
• Puede consultar el registro de actividad de mensajes para ver y solucionar los fallos de los webhooks.