Regal

Regal.io est la solution de vente par téléphone et SMS conçue pour générer davantage de conversations afin que vous puissiez atteindre vos objectifs de croissance bien plus rapidement.

En intégrant Regal et Braze, vous pouvez créer une expérience plus cohérente et personnalisée sur tous vos points de contact avec les clients.

• Envoyez le prochain e-mail ou la prochaine notification push la plus pertinente depuis Braze en fonction de ce qui a été dit lors d’une conversation téléphonique sur Regal.
• Déclenchez un appel dans Regal lorsqu’un client à forte valeur clique sur un e-mail marketing de Braze mais ne convertit pas.

Conditions préalables

Intégration : envoi de données de Braze à Regal

La section suivante décrit comment utiliser Braze comme source pour envoyer les données de profil client et d’événements à Regal en utilisant les webhooks de Canvas ou de Campaign Braze.

Étape 1 : Créer de nouveaux contacts dans Regal

Créez un Canvas ou une Campaign qui envoie des webhooks à Regal chaque fois qu’un nouveau contact est créé dans Braze et que vous souhaitez qu’il soit disponible pour des appels et des SMS dans Regal.

1. Créez un Canvas ou une Campaign intitulé(e) « Créer un nouveau contact pour Regal » et sélectionnez Basé sur l’action comme type d’entrée.

2. Définissez la logique du déclencheur comme Événement personnalisé et sélectionnez l’événement qui est déclenché lorsqu’un contact avec un numéro de téléphone est créé. Regal recommande également d’ajouter un filtre supplémentaire sur le champ téléphone pour s’assurer qu’il est défini.

3. Dans votre nouveau modèle de webhook, remplissez les champs suivants :

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

En-têtes de requête et méthode

Regal.io nécessite également un en-tête HTTP pour l’autorisation et une méthode HTTP. Les éléments suivants seront déjà inclus dans le modèle en tant que paire clé-valeur dans l’onglet Settings :

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

Corps de la requête

Le seul champ requis ci-dessous est la propriété traits.phone. Le reste est facultatif. Cependant, si vous incluez optIn, vous devez inclure optIn.channel et 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"
}

L’exemple de payload ci-dessus suppose que tous vos contacts ont accepté l’abonnement pour les appels vocaux et les SMS. Si ce n’est pas le cas, vous pouvez supprimer la propriété optIn ci-dessus et configurer un Canvas ou une Campaign séparé(e) pour mettre à jour un contact dans Regal lorsque optIn est collecté.

Étape 2 : Mettre à jour les informations d’abonnement

Si l’abonnement et le désabonnement peuvent se produire à différents moments de l’expérience utilisateur sur votre application, il est important de mettre à jour Regal lorsque les utilisateurs s’abonnent ou se désabonnent. Vous trouverez ci-dessous un Canvas recommandé pour envoyer des informations d’abonnement à jour à Regal. Il suppose que vous enregistrez cela en tant que champ de profil Braze, mais sinon, le déclencheur peut tout aussi bien être un événement dans votre compte Braze qui représente un utilisateur s’abonnant ou se désabonnant. (L’exemple ci-dessous concerne l’abonnement téléphonique, mais vous pouvez configurer un Canvas ou une Campaign similaire pour l’abonnement SMS si vous les collectez séparément).

1. Créez un nouveau Canvas ou une nouvelle Campaign intitulé(e) « Envoyer l’abonnement ou le désabonnement à Regal ».

2. Sélectionnez l’une des options de déclencheur suivantes et choisissez le champ qui représente l’état d’abonnement de l’utilisateur. Si vous déclenchez un événement vers Braze pour représenter l’abonnement ou le désabonnement, utilisez cet événement comme déclencheur à la place.
   • Champ de profil utilisateur mis à jour
   • Mettre à jour le statut du groupe d’abonnement
   • Statut de l’abonnement
3. Dans votre nouveau modèle de webhook, remplissez les champs suivants :
   • Webhook URL : https://events.regalvoice.com/events
   • Request Body : Raw Text

En-têtes de requête et méthode

Regal.io nécessite également un en-tête HTTP pour l’autorisation et une méthode HTTP. Les éléments suivants seront déjà inclus dans le modèle en tant que paire clé-valeur, dans l’onglet Settings :

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

Corps de la requête

Vous pouvez également ajouter des attributs supplémentaires de profil utilisateur dans ce payload si vous souhaitez vous assurer que davantage d’attributs sont à jour simultanément.

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"
}

Étape 3 : Envoyer des événements personnalisés

Enfin, configurez un Canvas ou une Campaign pour chacun des événements clés que vous souhaitez envoyer à Regal. Regal recommande d’envoyer tous les événements importants pour déclencher des SMS et des appels dans Regal (comme un événement à chaque étape du processus d’inscription ou d’achat) ou qui seront utilisés comme critères de sortie pour que les contacts sortent des Campaigns Regal.

Par exemple, voici un flux de travail pour envoyer un événement à Regal lorsqu’un utilisateur termine la première étape d’une candidature.

1. Créez un nouveau Canvas ou une nouvelle Campaign intitulé(e) « Envoyer l’événement Étape 1 de la candidature terminée à Regal ».

2. Définissez la logique du nœud déclencheur comme Événement personnalisé et sélectionnez le nom de l’événement que vous souhaitez envoyer à Regal, tel que « Application Step 1 Completed ».

3. Dans votre nouveau modèle de webhook, remplissez les champs suivants :

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

En-têtes de requête et méthode

Regal.io nécessite également un en-tête HTTP pour l’autorisation et une méthode HTTP. Les éléments suivants seront déjà inclus dans le modèle en tant que paire clé-valeur, dans l’onglet Settings :

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

Corps de la requête

Vous pouvez également ajouter des attributs supplémentaires de profil utilisateur dans ce payload si vous souhaitez vous assurer que plusieurs attributs sont à jour simultanément.

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"
}

Attributs de contact à jour

Bien que cela ne soit pas nécessaire, Regal recommande également d’envoyer les champs de données de profil utilisateur clés dans les payloads d’événements de vos flux de travail afin que Regal ait accès aux attributs de contact les plus récents au moment où les événements clés deviennent disponibles.

Remarque

Si vous avez des questions sur les événements importants à envoyer à Regal ou sur la meilleure façon de configurer ces Canvas et Campaigns, contactez [email protected].

Intégration : envoi de données de Regal à Braze

Cette section décrit comment récupérer les événements de reporting Regal tels que SMS.sent et call.completed dans Braze afin qu’ils puissent apparaître sur vos profils Braze et être disponibles dans l’outil de segmentation Braze, Canvas et Campaigns. Cette intégration utilise les webhooks de reporting Regal et la Transformation des données Braze pour automatiser le flux de données.

Étape 1 : Créer une Transformation des données dans Braze

Important

La transformation des données est actuellement en accès anticipé. Contactez votre gestionnaire de la satisfaction client Braze si vous souhaitez participer à l’accès anticipé.

Braze recommande de créer une transformation pour chaque webhook Regal que vous prévoyez d’envoyer à Braze.

Pour créer une Transformation des données :

1. Accédez à la page Transformations dans votre tableau de bord de Braze.
2. Donnez un nom à votre transformation et cliquez sur Create transformation.
3. Dans la liste des transformations, cliquez sur et sélectionnez Copy webhook URL.

Étape 2 : Activer les webhooks de reporting dans Regal

Pour configurer les webhooks de reporting :

1. Accédez à l’application Regal et ouvrez la page Settings.

2. Dans la section Reporting Webhooks, cliquez sur Create Webhooks.

3. Dans le champ de saisie de l’endpoint du webhook, ajoutez l’URL du webhook de Transformation des données Braze pour la transformation associée.

Mise à jour d’un endpoint

Lorsque vous modifiez un endpoint, cela peut prendre jusqu’à 5 minutes pour que le cache s’actualise et envoie les événements à votre nouvel endpoint.

Nouvelles tentatives

Actuellement, il n’y a pas de nouvelles tentatives pour ces événements. Si une réponse n’est pas reçue dans les 5 secondes, l’événement est abandonné et n’est pas retenté. Regal ajoutera des nouvelles tentatives dans une future version.

Événements

Le guide des webhooks de reporting de Regal comprend la liste complète des événements de reporting publiés. Vous y trouverez également les définitions des propriétés et des exemples de payloads.

Étape 3 : Transformer les événements Regal en événements Braze

La fonctionnalité de Transformation des données de Braze vous permet de mapper les événements Regal entrants dans le format nécessaire pour les ajouter en tant qu’attributs, événements ou achats dans Braze.

1. Nommez votre Transformation des données. Il est recommandé de configurer une Transformation des données par webhook d’événement.

2. Pour tester la connexion, créez un appel sortant depuis le bureau de l’agent Regal vers votre téléphone portable et soumettez le formulaire de résumé de conversation pour créer un événement call.completed.

3. Déterminez quels identifiants vous utiliserez pour mapper vos contacts Regal à vos profils Braze. Les identifiants disponibles dans les événements Regal incluent :

   • userId — uniquement défini sur les événements si vous avez déjà envoyé cet identifiant pour un contact
   • traits.phone
   • traits.email — uniquement défini sur les événements si vous avez déjà envoyé cet identifiant pour un contact

Identifiants pris en charge par Braze

• Braze ne prend pas en charge les numéros de téléphone comme identifiant. Pour l’utiliser comme identifiant, le numéro de téléphone peut être défini comme alias d’utilisateur dans Braze.
• Lors de l’utilisation de la Transformation des données Braze, l’adresse e-mail peut être utilisée comme identifiant. Si l’adresse e-mail existe en tant que profil dans Braze, le profil existant sera mis à jour. Si l’adresse e-mail n’existe pas encore dans Braze, un profil uniquement e-mail sera créé.

Cas d’utilisation

• déclencher un e-mail
• mettre à jour les attributs de profil
• synchroniser vos expériences
• désabonner un 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;