Skip to content

Commit d2d92b1

Browse files
committed
Reorder Event Types
1 parent 313677f commit d2d92b1

File tree

1 file changed

+29
-27
lines changed
  • src/connections/destinations/catalog/regal-voice

1 file changed

+29
-27
lines changed

src/connections/destinations/catalog/regal-voice/index.md

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -59,17 +59,42 @@ analytics.identify({
5959
});
6060
```
6161

62-
Segment sends Identify calls to Regal Voice as an identify event. If an identify event contains a phone, Regal Voice will create a contact in your Audience.
62+
Segment sends Identify calls to Regal Voice as an identify event.
6363

64+
If an identify event contains a phone, Regal Voice will create a contact in your Audience.
65+
66+
## Track
67+
68+
If you aren't familiar with the Segment Spec, take a look at the [Track method documentation](/docs/connections/spec/track/) to learn about what it does.
69+
70+
Segment recommends calling `track` on any user or system event that you may want Regal Voice to be able to use for lead scoring or as triggers or conditions when sending voice and sms campaigns.
71+
72+
Segment sends `track` calls to Regal Voice as a track event. Pass all attributes relevant to your use case into the `properties` object.
73+
74+
Regal Voice communications can be triggered proactively to a user based on their activity or inactivity - in order to nudge them through your funnel.
75+
76+
An example for a financial services company might be that you want to tigger an outbound call to a user for whom a 'Loan Application Approved' event has been received, but not a 'Loan Signed' event (with some parameter around timing).
77+
78+
In that case, an example `track` call for the 'Loan Application Approved' event would look like:
79+
80+
```js
81+
analytics.track('Loan Application Approved', {
82+
loanType: 'Personal loan',
83+
amount: 30000
84+
currency: 'USD'
85+
term: 12
86+
})
87+
```
6488

6589
## Collecting OptIn
6690

6791
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.
68-
There are 2 options for how you can let Regal Voice know a user has opted in.
6992

70-
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.)
93+
There are 2 options for how you can let Regal Voice know a user has opted in;
94+
95+
1. 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.)
7196

72-
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.
97+
2. 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.
7398

7499
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:
75100

@@ -103,27 +128,4 @@ For the identify method, the `ip` field is required if you are opting in users s
103128

104129
Make sure to include `timestamp` with the exact time the user opted in. Since traits are [cached](/docs/connections/sources/catalog/libraries/website/javascript/identity/#clearing-traits) and sent with subsequent Identify calls, Regal Voice ignores opt-ins that do not have a `timestamp` date.
105130

106-
107-
## Track
108-
109-
If you aren't familiar with the Segment Spec, take a look at the [Track method documentation](/docs/connections/spec/track/) to learn about what it does.
110-
111-
Segment recommends calling `track` on any user or system event that you may want Regal Voice to be able to use for lead scoring or as triggers or conditions when sending voice and sms campaigns.
112-
113-
Segment sends `track` calls to Regal Voice as a track event. Pass all attributes relevant to your use case into the `properties` object.
114-
115-
Regal Voice communications can be triggered proactively to a user based on their activity or inactivity - in order to nudge them through your funnel.
116-
117-
An example for a financial services company might be that you want to tigger an outbound call to a user for whom a 'Loan Application Approved' event has been received, but not a 'Loan Signed' event (with some parameter around timing).
118-
119-
In that case, an example`track` call for the 'Loan Application Approved' event would look like:
120-
121-
```js
122-
analytics.track('Loan Application Approved', {
123-
loanType: 'Personal loan',
124-
amount: 30000
125-
currency: 'USD'
126-
term: 12
127-
})
128-
```
129131
---

0 commit comments

Comments
 (0)