Regal

Regal.io es la solución de ventas por teléfono y SMS creada para impulsar más conversaciones y que puedas alcanzar tus objetivos de crecimiento mucho más rápido.

Al integrar Regal y Braze, puedes crear una experiencia más coherente y personalizada en todos los puntos de intervención con el cliente.

• Envía el siguiente mejor correo electrónico o notificación push de Braze basándote en lo que se dice en una conversación telefónica en Regal.
• Desencadena una llamada en Regal cuando un cliente de alto valor hace clic en un correo electrónico de marketing de Braze pero no convierte.

Requisitos previos

Integración: envío de datos de Braze a Regal

La siguiente sección describe cómo utilizar Braze como fuente para enviar el perfil de tu cliente y datos de eventos a Regal utilizando Canvas o webhooks de Campaign de Braze.

Paso 1: Crear nuevos contactos en Regal

Crea un Canvas o una Campaign que envíe webhooks a Regal cada vez que se cree un nuevo contacto en Braze que quieras que esté disponible para llamadas y mensajes de texto en Regal.

1. Crea un Canvas o una Campaign con el título “Crear nuevo contacto para Regal” y selecciona Basado en acciones como tipo de entrada.

2. Establece la lógica de desencadenamiento como Evento personalizado y selecciona el evento que se dispara cuando se crea un contacto con un número de teléfono. Regal también recomienda añadir un filtro adicional en el campo del teléfono que garantice que está configurado.

3. En tu nueva plantilla de webhook, rellena los siguientes campos:

   • Webhook URL: https://events.regalvoice.com/events
   • Request Body: Raw Text

Encabezados de solicitud y método

Regal.io también requiere un encabezado HTTP para la autorización y un método HTTP. Lo siguiente ya estará incluido dentro de la plantilla como un par clave-valor en la pestaña Settings:

• HTTP Method: POST
• Request Headers:
  • Authorization: {{<REGAL_API_KEY>}}
  • Content-Type: application/json

Cuerpo de la solicitud

El único campo obligatorio a continuación es la propiedad traits.phone. El resto es opcional. Sin embargo, si incluyes optIn, debes incluir optIn.channel y optIn.subscribed.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
    "userId": "<uniqueIdentifier>", //this is optional
    "traits": {
        "phone": "<phoneNumber>",
        "email": "<email>",
        "firstName": "<firstName>",
        "lastName": "<lastName>",
        "optIn": [
            {
                "channel": "voice",
                "source": "<leadSource>",
                "subscribed": true
            },
            {
                "channel": "sms",
                "source": "<leadSource>",
                "subscribed": true
            }
        ],
        "custom1": "<custom1>",
        "custom2": "<custom2>"
    },
    "eventSource": "braze"
}

El ejemplo de carga útil anterior supone que todos tus contactos han aceptado la adhesión voluntaria para voz y SMS. Si no es así, puedes eliminar la propiedad optIn de lo anterior y configurar un Canvas o una Campaign independiente para actualizar un contacto en Regal cuando se recopile optIn.

Paso 2: Actualizar la información de adhesión voluntaria

Si la adhesión voluntaria y la exclusión pueden producirse en diferentes partes de la experiencia del usuario en tu aplicación, es importante actualizar Regal a medida que los usuarios se adhieren o se excluyen. A continuación encontrarás un Canvas recomendado sobre cómo enviar información actualizada de adhesión voluntaria a Regal. Se supone que lo guardas como un campo de perfil de Braze, pero si no es así, el desencadenante puede ser fácilmente un evento de tu cuenta de Braze que represente a un usuario que se suscribe o cancela su suscripción. (El ejemplo de abajo es para la adhesión voluntaria por teléfono, pero puedes configurar un Canvas o una Campaign similar para la adhesión voluntaria por SMS si los recoges por separado).

1. Crea un nuevo Canvas o una nueva Campaign con el título “Enviar adhesión voluntaria o baja a Regal”.

2. Selecciona una de las siguientes opciones de desencadenamiento y selecciona el campo que represente el estado de adhesión voluntaria del usuario. Si envías un evento a Braze para representar la aceptación o el rechazo, utiliza ese evento como desencadenante.
   • Campo de perfil de usuario actualizado
   • Actualizar el estado del grupo de suscripción
   • Estado de la suscripción
3. En tu nueva plantilla de webhook, rellena los siguientes campos:
   • Webhook URL: https://events.regalvoice.com/events
   • Request Body: Raw Text

Encabezados de solicitud y método

Regal.io también requiere un encabezado HTTP para la autorización y un método HTTP. Lo siguiente ya estará incluido dentro de la plantilla como un par clave-valor, pero en la pestaña Settings:

• HTTP Method: POST
• Request Headers:
  • Authorization: {{<REGAL_API_KEY>}}
  • Content-Type: application/json

Cuerpo de la solicitud

Puedes añadir más atributos de perfil de usuario en esta carga útil si deseas asegurarte de que más atributos estén actualizados simultáneamente.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
    "userId": "<uniqueIdentifier>", //this is optional
    "traits": {
        "phone": "<phoneNumber>",
        "optIn": [
            {
                "channel": "voice",
                "source": "<leadSource>",
                "subscribed": "<voice_optin_subscribed>"
            },
            {
                "channel": "sms",
                "source": "<leadSource>",
                "subscribed": "<voice_optin_subscribed>"
            }
        ]
    },
    "eventSource": "braze"
}

Paso 3: Enviar eventos personalizados

Por último, configura un Canvas o una Campaign para cada uno de los eventos clave que quieras enviar a Regal. Regal recomienda enviar cualquier evento que sea importante para desencadenar SMS y llamadas en Regal (como un evento en cada paso del flujo de registro o compra) o que se utilice como criterio de salida para que los contactos se salgan de las campañas de Regal.

Por ejemplo, a continuación se muestra un flujo de trabajo para enviar a Regal un evento cuando un usuario completa el primer paso de una solicitud.

1. Crea un nuevo Canvas o una nueva Campaign con el título “Enviar evento Paso 1 de solicitud completado a Regal”.

2. Establece la lógica del nodo desencadenante como Evento personalizado y selecciona el nombre del evento que deseas enviar a Regal, como por ejemplo “Application Step 1 Completed”.

3. En tu nueva plantilla de webhook, rellena los siguientes campos:

   • Webhook URL: https://events.regalvoice.com/events
   • Request Body: Raw Text

Encabezados de solicitud y método

Regal.io también requiere un encabezado HTTP para la autorización y un método HTTP. Lo siguiente ya estará incluido dentro de la plantilla como un par clave-valor, pero en la pestaña Settings:

• HTTP Method: POST
• Request Headers:
  • Authorization: {{<REGAL_API_KEY>}}
  • Content-Type: application/json

Cuerpo de la solicitud

Puedes añadir más atributos de perfil de usuario en esta carga útil si deseas asegurarte de que más atributos estén actualizados simultáneamente.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
    "userId": "<uniqueIdentifier>", //this is optional
    "traits": {
        "phone": "<phoneNumber>",
        "firstName": "<firstName>",
        "lastName": "<lastName>",
        "custom1": "<custom1>",
        "custom2": "<custom2>",
        "custom3": "<custom3>"
    },
    "name": "Application Step 1 Completed",
    "properties": {
      "educationalLevel": "<educationalLevel>",
      "preferredLocation": "<preferredLocation>",
      "preferredSubject": "<preferredSubject>",
      "readytoCommit": true
    },
    "eventSource": "braze"
}

Atributos de contacto actualizados

Aunque no es necesario, Regal recomienda enviar también cualquier campo de datos de perfil de usuario clave en las cargas útiles de eventos de tus flujos de trabajo de eventos para garantizar que Regal tenga acceso a los atributos de contacto más actualizados en el momento en que los eventos clave estén disponibles.

Nota

Si tienes preguntas sobre qué eventos es importante enviar a Regal o sobre la mejor manera de configurar estos Canvas y Campaigns, ponte en contacto con [email protected].

Integración: envío de datos de Regal a Braze

Esta sección describe cómo obtener eventos de informes de Regal como SMS.sent y call.completed en Braze para que aparezcan en tus perfiles de Braze y estén disponibles en la herramienta de segmentación de Braze, Canvas y Campaigns. Esta integración utiliza los webhooks de informes de Regal y la Transformación de datos de Braze para automatizar el flujo de datos.

Paso 1: Crear una Transformación de datos en Braze

Importante

La Transformación de datos se encuentra actualmente en fase de acceso anticipado. Ponte en contacto con tu administrador del éxito del cliente de Braze si te interesa participar en el acceso anticipado.

Braze recomienda crear una transformación por cada webhook de Regal que planees enviar a Braze.

Para crear una Transformación de datos:

1. Ve a la página Transformations en tu panel de Braze.
2. Dale un nombre a tu transformación y haz clic en Create transformation.
3. En la lista de transformaciones, haz clic en y selecciona Copy webhook URL.

Paso 2: Habilitar webhooks de informes en Regal

Para configurar webhooks de informes:

1. Ve a la aplicación Regal y abre la página de Settings.

2. En la sección Reporting Webhooks, haz clic en Create Webhooks.

3. En la entrada del punto de conexión del webhook, añade la URL del webhook de Transformación de datos de Braze para la Transformación de datos asociada.

Actualización de un punto de conexión

Cuando editas un punto de conexión, la caché puede tardar hasta 5 minutos en actualizarse y enviar eventos a tu nuevo punto de conexión.

Reintentos

Actualmente, no hay reintentos en estos eventos. Si no se recibe una respuesta en 5 segundos, el evento se descarta y no se reintenta. Regal añadirá reintentos en una futura versión.

Eventos

La guía de webhooks de informes de Regal incluye la lista completa de eventos de informes que publican. Allí puedes ver definiciones de propiedades y también ejemplos de cargas útiles.

Paso 3: Transformar los eventos de Regal en eventos de Braze

La característica de Transformación de datos de Braze te permite mapear los eventos entrantes de Regal en el formato necesario para añadirlos como atributos, eventos o compras en Braze.

1. Asigna un nombre a tu Transformación de datos. Se recomienda configurar una Transformación de datos por webhook de evento.

2. Para probar la conexión, crea una llamada saliente desde el escritorio del agente de Regal a tu teléfono móvil y envía el formulario de resumen de conversación para crear un evento call.completed.

3. Determina qué identificadores utilizarás para mapear tus contactos de Regal a tus perfiles de Braze. Los identificadores disponibles en los eventos de Regal incluyen:

   • userId - solo se establece en eventos si previamente se ha enviado este identificador para un contacto
   • traits.phone
   • traits.email - solo se establece en eventos si previamente se ha enviado este identificador para un contacto

Identificadores compatibles con Braze

• Braze no admite números de teléfono como identificador. Para utilizarlo como identificador, el número de teléfono puede configurarse como alias de usuario en Braze.
• Al utilizar la Transformación de datos de Braze, la dirección de correo electrónico puede utilizarse como identificador. Si la dirección de correo electrónico existe como perfil en Braze, se actualizará el perfil existente. Si la dirección de correo electrónico aún no existe en Braze, se creará un perfil solo para correo electrónico.

Casos de uso

• trigger an email
• update profile attributes
• keep your experiments in sync
• unsubscribe a contact

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
{
  "userId": "123",
  "traits": {
    "phone": "+17625555555",
    "email": "[email protected]"
  },
  "name": "call.completed",
  "properties": {
    "agent_firstname": "Rebecca",
    "agent_fullname": "Rebecca Greene",
    "agent_id": "[email protected]",
    "direction": "OUTBOUND",
    "regal_voice_phone": "+19545558563",
    "regal_voice_phone_internal_name": "Sales Line",
    "contact_phone": "+17625555555",
    "call_id": "WTxxxxx9",
    "type": "Outbound Call",
    "disposition": "Converted During Convo",
    "notes": null,
    "objections": null,
    "campaign_name": "Life Insurance Quote Follow Up",
    "campaign_friendly_id": "445",
    "started_at": 1657855046,
    "ended_at": 1657855053,
    "completed_at": 1657855059,
    "talk_time": 7,
    "wrapup_time": 6,
    "handle_time": 13,
    "journey_uuid": null,
    "journey_name": null,
    "journey_friendly_id": null
  },
  "originalTimestamp": "1657855059",
  "eventSource": "Regal Voice"
}

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
// The Braze /users/track endpoint expects timestamps in an ISO 8601 format. To use the Unix timestamp within Regal's call.completed event payload as the event timestamp in Braze must first be converted to ISO 8601. This can be done with the following code:
let unixTimestamp = payload.originalTimestamp;
let dateObj = new Date(unixTimestamp * 1000);
let isoString = dateObj.toISOString();

// This is a default template you can use as a starting point. Feel free to delete this entirely to start from scratch or to delete specific components as you see fit.

// First, this code defines a variable, "brazecall", to build up a /users/track request
// Everything from the incoming webhook is accessible via the special variable "payload". As such, you can template in desired values in your /users/track request with JS dot notation, such as payload.x.y.z

let brazecall = {
 "events": [
   {
     "external_id": payload.userId,
     "name": "Call Completed",
     "time": isoString,
     "_update_existing_only": false,
     "properties": {
       "agent_firstname": payload.properties.agent_firstname,
       "agent_fullname": payload.properties.agent_fullname,
       "agent_id": payload.properties.agent_id,
       "direction": payload.properties.direction,
       "regal_voice_phone": payload.properties.regal_voice_phone,
       "regal_voice_phone_internal_name": payload.properties.regal_voice_phone_internal_name,
       "contact_phone": payload.properties.contact_phone,
       "call_id": payload.properties.call_id,
       "type": payload.properties.type,
       "disposition": payload.properties.disposition,
       "notes": payload.properties.notes,
       "objections": payload.properties.objections,
       "campaign_name": payload.properties.campaign_name,
       "campaign_friendly_id": payload.properties.campaign_friendly_id,
       "started_at": payload.properties.started_at,
       "ended_at": payload.properties.ended_at,
       "completed_at": payload.properties.completed_at,
       "talk_time": payload.properties.talk_time,
       "wrapup_time": payload.properties.wrapup_time,
       "handle_time": payload.properties.handle_time,
       "journey_uuid": payload.properties.journey_uuid,
       "journey_name": payload.properties.journey_name,
       "journey_friendly_id": payload.properties.journey_friendly_id
     }
   }
 ]
};

// After the /users/track request is assigned to brazecall, you will want to explicitly return brazecall to create an output
return brazecall;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "userId": "123",
  "traits": {
    "phone": "+17625555555",
    "email": "[email protected]"
  },
  "name": "contact.attribute.edited",
  "properties": {
    "agent_email": "[email protected]",
    "contact_phone": "+17625555555",
    "changes": {
      "custom_properties": {
        "annual_income": {
          "old_value": "150,000",
          "new_value": "300,000"
        }
      }
    },
    "created_at": "1657855462"
  },
  "originalTimestamp": "1657855462",
  "eventSource": "Regal Voice"
}

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
// This is an example template you can use as a starting point. Feel free to delete this entirely to start from scratch or to delete specific components as you see fit.

// Capture the key's updated property value within the 'changes' object and store this in an attributes variable that can be used in the /users/track request

const changes = payload.properties.changes.custom_properties;

const attributes = {};
for (const key in changes) {
 attributes[key] = changes[key].new_value;
}

// First, this code defines a variable, "brazecall", to build up a /users/track request
// Everything from the incoming webhook is accessible via the special variable "payload". As such, you can template in desired values in your /users/track request with JS dot notation, such as payload.x.y.z

const brazecall = {
 "attributes": [
   {
     "external_id": payload.userId,
     "_update_existing_only": false,
     ...attributes
   }
 ]
};

// After the /users/track request is assigned to brazecall, you will want to explicitly return brazecall to create an output
return brazecall;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "userId": "123",
  "traits": {
    "phone": "+17625555555",
    "email": "[email protected]"
  },
  "name": "contact.experiment.assigned",
  "properties": {
    "experiment_name": "Post Call Offer Test",
    "experiment_id": "xxxx-xxxx-xxxx-xxxx",
    "experiment_variant": "Aggressive Offer - 50%",
    "journey_uuid": "xxxx-xxxx-xxxx-xxxx",
    "journey_friendly_id": 220,
    "journey_name": "Post Call Follow Up"
  },
  "originalTimestamp": "1657855118",
  "eventSource": "Regal Voice"
}

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
// The Braze /users/track endpoint expects timestamps in an ISO 8601 format. To use the Unix timestamp within Regal's call.completed event payload as the event timestamp in Braze, it must first be converted to ISO 8601. This can be done with the following code:
let unixTimestamp = payload.originalTimestamp;
let dateObj = new Date(unixTimestamp * 1000);
let isoString = dateObj.toISOString();

// This is an example template you can use as a starting point. Feel free to delete this entirely to start from scratch or to delete specific components as you see fit.

// First, this code defines a variable, "brazecall", to build up a /users/track request
// Everything from the incoming webhook is accessible via the special variable "payload". As such, you can template in desired values in your /users/track request with JS dot notation, such as payload.x.y.z
let brazecall = {
 "events": [
   {
     "external_id": payload.userId,
     "_update_existing_only": false,
     "name": "Contact Experiment Assigned",
     "time": isoString,
     "properties": {
       "experiment_name": payload.properties.experiment_name,
       "experiment_id": payload.properties.experiment_id,
       "experiment_variant": payload.properties.experiment_variant,
       "journey_uuid": payload.properties.journey_uuid,
       "journey_friendly_id": payload.properties.journey_friendly_id,
       "journey_name": payload.properties.journey_name
     }
   }
 ]
};

// After the /users/track request is assigned to brazecall, you will want to explicitly return brazecall to create an output
return brazecall;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  "userId": "123",
  "traits": {
    "phone": "+17625555555",
    "email": "[email protected]",
    "ip": "78.97.213.166"
  },
  "name": "contact.unsubscribed",
  "properties": {
    "new_subscription": true,
    "channel": "voice",
    "text": null,
    "ip": "207.38.149.143",
    "source": "regalvoice.agent_desktop",
    "timestamp": "1657855229"
  },
  "originalTimestamp": "1657855230",
  "eventSource": "Regal Voice"
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// This is an example template you can use as a starting point. Feel free to delete this entirely to start from scratch or to delete specific components as you see fit.

// First, this code defines a variable, "brazecall", to build up a /users/track request
// Everything from the incoming webhook is accessible via the special variable "payload". As such, you can template in desired values in your /users/track request with JS dot notation, such as payload.x.y.z

let brazecall = {
 "attributes": [
   {
     "external_id": payload.userId,
     "_update_existing_only": true,
     "subscription_groups" : [{
       "subscription_group_id": "YOUR SUBSCRIPTION GROUP ID",
       "subscription_state": "unsubscribed"
     }]
   }
 ]
};

// After the /users/track request is assigned to brazecall, you will want to explicitly return brazecall to create an output
return brazecall;