Olo

Olo es una plataforma software como servicio (SaaS) abierta líder para restaurantes que habilita la hostelería en cada punto de intervención.

Al integrar Olo y Braze, puedes:

• Actualizar los perfiles de usuario en Braze para mantenerlos coherentes con los perfiles de usuario de Olo
• Enviar el siguiente mejor mensaje desde Braze basándote en eventos de Olo

Requisitos previos

Un webhook es una forma en que Olo envía información basada en eventos a Braze sobre los usuarios y sus acciones, incluidos eventos como Order Placed, Guest Opt In, Order Picked Up y más. El webhook de Olo entrega el evento a Braze generalmente en cuestión de segundos después de que se realiza la acción.

Descargo de responsabilidad

En Olo, estás limitado a un webhook por entorno para cada marca aprobada, todos enviados a la misma URL de destino. Las distintas marcas pueden tener URLs diferentes, pero los eventos de la misma marca deben compartir una URL. En Braze, esto significa que solo puedes crear una transformación para usarla con Olo.

Para gestionar múltiples eventos de Olo dentro de esta única transformación, busca el encabezado X-Olo-Event-Type en cada webhook. Este encabezado te permite procesar condicionalmente diferentes eventos de Olo.

Integración

Paso 1: Configura la transformación de datos de Braze para aceptar el evento de prueba de Olo

En el panel de Braze, ve a Configuración de datos > Transformación de datos.

Selecciona Crear transformación para darle un nombre a tu transformación y, a continuación, elige tu experiencia de edición.

Selecciona Utilizar una plantilla para examinar una biblioteca de plantillas, incluidos los ejemplos de transformación de datos. O bien, selecciona Empezar de cero para cargar una plantilla de código predeterminada.

Si empiezas de cero, elige un destino para tu transformación. Todavía puedes insertar una plantilla de código de la biblioteca de plantillas.

Nota

¿Quieres additional templates or destinations? Considera dejar comentarios sobre el producto.

Después de crear tu transformación, verás la vista detallada de la transformación. Aquí puedes ver el webhook más reciente recibido para esta transformación en Webhook details y un espacio para escribir tu código de transformación en Transformation code.

Copia tu URL del webhook para utilizarla en el siguiente paso.

Paso 2: Configura los webhooks de Olo

Usa la herramienta de webhooks de autoservicio dentro del panel de Olo para configurar webhooks que envíen datos a tu transformación de datos.

1. Elige qué eventos deben enviarse a Braze
2. Configura la URL de destino. Esta será la URL de la transformación de datos creada en el paso 1.

Nota

OAuth y el secreto compartido del encabezado X-Olo-Signature no son necesarios para la transformación.

3. Verifica que el webhook esté configurado correctamente enviando un evento de prueba a tu transformación de datos. Solo los usuarios del panel de Olo con el permiso de herramientas de desarrollador pueden enviar eventos de prueba.

Olo requiere una respuesta exitosa del webhook del evento de prueba antes de que puedas completar el proceso de configuración de webhooks de Olo.

Paso 3: Escribe el código de transformación para aceptar los eventos de Olo que hayas elegido

En este paso, transformarás la carga útil del webhook que se enviará desde la plataforma de origen en un valor de retorno de objeto JavaScript.

1. Envía una solicitud a la URL de tu transformación de datos con una carga útil de evento de muestra de un evento de Olo que desees soportar. Consulta el formato del cuerpo de la solicitud para obtener ayuda con el formato de tu solicitud.
2. Actualiza tu transformación de datos y asegúrate de que puedas ver la carga útil del evento de muestra en los detalles del webhook.
3. Actualiza el código de tu transformación de datos para soportar los eventos de Olo que hayas elegido.
4. Haz clic en Validar para obtener una vista previa del resultado de tu código y comprobar si es una solicitud /users/track aceptable.
5. Guarda y activa tu transformación de datos.

Formato del cuerpo de la solicitud

Este valor de retorno debe cumplir con el formato del cuerpo de la solicitud /users/track de Braze:

• El código de transformación se acepta en el lenguaje de programación JavaScript. Se admite cualquier flujo de control estándar de JavaScript, como la lógica if/else.
• El código de transformación accede al cuerpo de la solicitud del webhook a través de la variable payload. Esta variable es un objeto que se completa al analizar el JSON del cuerpo de la solicitud.
• Se admite cualquier característica compatible con nuestro endpoint /users/track, incluyendo:
  • Objetos de atributos de usuario, objetos de eventos y objetos de compra
  • Atributos anidados y propiedades de eventos personalizados anidadas
  • Actualizaciones de grupos de suscripción
  • Dirección de correo electrónico como identificador

Ejemplos de transformaciones de datos para webhooks de Olo

Esta sección contiene plantillas de ejemplo que se pueden utilizar como punto de partida. Puedes partir desde cero o eliminar componentes específicos como consideres necesario.

En cada plantilla, el código define una variable, brazecall, para construir una solicitud /users/track.

Después de que la solicitud /users/track se asigna a brazecall, devolverás explícitamente brazecall para crear una salida.

Transformación de un solo evento

Si solo buscas admitir un único evento de Olo, no necesitarás usar el encabezado X-Olo-Event-Type para crear condicionalmente la carga útil de la solicitud /users/track. Por ejemplo, registrar un evento de compra o un evento personalizado en el perfil de usuario cuando se envía un webhook de pedido realizado de Olo a Braze.

Registrar cada producto como una compra

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// iterate through the items included within the order

const purchases = payload.items.map((item) => {
 return {
   external_id: payload.customer.customerId.toString(),
   product_id: item.productId.toString(),
   currency: 'USD',
   price: item.sellingPrice,
   time: new Date().toISOString(),
   quantity: item.quantity,
   properties: {
     customValues: item.customValues
   }
 };
});

// log a purchase per item in the order

let brazecall = {
 "purchases": purchases
};

return brazecall;

Registrar un evento personalizado

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// log an event “Order Placed” to the profile that includes all items in the order as event properties.

let brazecall = {
"events": [
   {
     "external_id": payload.customer.customerId.toString(),
     "_update_existing_only": false,
     "name": "Order Placed",
     "time": new Date().toISOString(),
     "properties": {
       "Delivery Method": payload.deliveryMethod,
       "Items": payload.items,
       "Total": payload.totals.total,
       "Location": payload.location.name
     }
   }
 ]
};

return brazecall;

Transformación multievento

Olo envía el tipo de evento dentro del encabezado X-Olo-Event-Type de cada webhook. Para admitir múltiples eventos de webhook de Olo dentro de una única transformación, usa lógica condicional para transformar la carga útil del webhook en función del valor de este tipo de encabezado.

En el siguiente ejemplo de transformación, nuestro JavaScript crea una carga útil particular para los eventos UserSignedUp y OrderPlaced. Además, una condición else maneja una carga útil para cualquier evento de Olo enviado a Braze sin el encabezado X-Olo-Event-Type de UserSignedUp y OrderPlaced.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
// captures the value within the X-Olo-Event-Type header for use in the conditional logic

let event_type = headers["X-Olo-Event-Type"];

// defines a variable 'brazecall' that will hold the request payload for the /users/track request

let brazecall;

// if the X-Olo-Event-Type header is 'UserSignedUp', define a variable for the different subscription statuses that could be included within the Olo event payload

if (event_type == "UserSignedUp") {
	let emailSubscribe;
	let emailSubscriptionGroup;
	let smsSubscriptionGroup;


// determine if the user has opted into marketing emails


	if (payload.allowEmail) {
		emailSubscribe = "opted_in";
		emailSubscriptionGroup = "subscribed";
	} else {
		emailSubscribe = "unsubscribed";
		emailSubscriptionGroup = "unsubscribed";
	}


	// determine if the user has opted into SMS


	if (payload.allowMarketingSms) {
		smsSubscriptionGroup = "subscribed";
	} else {
		smsSubscriptionGroup = "unsubscribed";
	}

	// build the /users/track request and pass in the appropriate subscription statuses


	brazecall = {
		"attributes": [{
			"external_id": payload.id.toString(),
			"_update_existing_only": false,
			"email": payload.emailAddress,
			"first_name": payload.firstName,
			"last_name": payload.lastName,
			"email_subscribe": emailSubscribe,
			"phone": payload.contactNumber,
			"subscription_groups": [{
					"subscription_group_id": "57e5307f-9084-490d-9d6d-8244dc919a48",
					"subscription_state": emailSubscriptionGroup
				},
				{
					"subscription_group_id": "6440ba26-86ea-47db-a935-6647941dc78b",
					"subscription_state": smsSubscriptionGroup
				}
			]
		}]
	}; // if the X-Olo-Event-Type header is 'OrderPlaced', build the /users/track request to log an event to the user profile
} else if (event_type == "OrderPlaced") {
	brazecall = {
		"events": [{
			"external_id": payload.customer.customerId.toString(),
			"_update_existing_only": false,
			"name": "Order Placed",
			"time": new Date().toISOString(),
			"properties": {
				"Delivery Method": payload.deliveryMethod,
				"Items": payload.items,
				"Total": payload.totals.total,
				"Location": payload.location.name
			}
		}]
	};
} else { // if the X-Olo-Event-Type header is anything else, build the /users/track request to log an event to the user profile
	brazecall = {
		"events": [{
			"external_id": payload.customer.customerId.toString(),
			"_update_existing_only": true,
			"name": "Another Event",
			"time": new Date().toISOString()
		}]

	};
}

// return `brazecall` to create an output.

return brazecall;

Paso 4: Publica tu webhook de Olo

Después de haber activado tu transformación de datos en Braze, usa la herramienta de webhooks de autoservicio dentro del panel de Olo para publicar tu webhook. Cuando el webhook esté publicado, la transformación de datos comenzará a recibir mensajes de eventos de webhook de Olo.

Cosas que debes saber

Reintentos

Olo reintentará las llamadas de webhook que resulten en un código de estado de respuesta HTTP 429 - Too Many Requests o en el rango 5xx (por ejemplo, debido a un tiempo de espera del gateway o un error del servidor), hasta 50 veces durante un período de 24 horas antes de descartar la solicitud.

Entrega al menos una vez

Si una llamada de webhook resulta en un código de estado de respuesta HTTP 429 - Too Many Requests o en el rango 5xx (por ejemplo, debido a un tiempo de espera del gateway o un error del servidor), Olo reintentará el mensaje hasta 50 veces durante un período de 24 horas antes de abandonar el intento.

Por lo tanto, los webhooks pueden ser recibidos varias veces por un suscriptor. Es responsabilidad del suscriptor ignorar los duplicados comprobando el encabezado X-Olo-Message-Id.