This guide describes how to use mParticle to send data to Regal Voice.
Regal Voice relies on the Webhooks output. You can refer to mParticle developer documentation on webhooks, as well.
- Email [email protected] to get your Regal Voice API Key.
- In mParticle, navigate to the Inputs tab. Open the input from which you'd like to send data to Regal Voice.
- Click to Add an Output.
- From the list of possible outputs, choose Webhooks.
- Add the following endpoint as the POST URL: mparticle.regalvoice.com
- Add your Regal Voice API Key in the Authorization header
- Configure connection settings. Leave all default settings as is, except:
- Set send as batch should be set to FALSE
- Set send network performance events to FALSE
- Set push registrations and receipts to FALSE
- Set Include User Attribute Change Events to TRUE
- Set Include User Identity Change Events to TRUE
- mParticle will now send data from the selected source to Regal Voice.
mParticle collects 3 important kinds of data that map closely to Regal Voice's data model:
- Screen/Page Views - keep track of where a user is in your app
- Custom Events - track any actions the user might take in your app. Commerce Events - purchases and other product-related activity - are a subset of custom events. These are the same as what Regal Voice calls track events.
- mParticle also captures data about your user, including their identities, information about the device they are using and any custom attributes you set. User identities are unique identifiers for your user, like an email address or customer ID. When a phone number is added to a user, that user becomes a contact in your Regal Voice audience.
In order to trigger outbound calls or sms messages from Regal Voice, you must collect the user’s explicit opt-in for those channels along with the user’s phone number.
There are 2 options for how you can let Regal Voice know a user has opted in:
Anytime you collect opt-in for sms or voice calls, you can trigger a track event after a user opts in and let the Regal Voice team know what track event is synonymous with opt-in collected (there is no required format for this event). The product will then automatically subscribe users who perform that event. (Note: for Regal Voice to subscribe a user, there must already be a phone provided for that user.)
Alternatively, anytime you collect opt-in for sms or voice calls, you can use an identify call to pass that opt-in information to Regal Voice by adding an optIn object like the example above. The example above
Below is an example of what an identify call would look like for a user who opted into multiple channels (sms and voice calls) at once:
To check the success of your integration:
- Go to the Recent Activity page in the Regal Voice app to view incoming track and page events
- Go to the Audience page in the Regal Voice app to view your contacts (created from identify events) - remember in order for a user to appear in your audience they must have a phone. You can also view their optIn status from the Audience page
Updated 4 days ago