From 28c25de9dcdeaec061a1a7662ea8c746620d8b10 Mon Sep 17 00:00:00 2001 From: Thomas Gilbert Date: Thu, 20 Oct 2022 12:45:22 -0400 Subject: [PATCH 1/2] Update name for Regal Voice --- .../destinations/catalog/regal-voice/index.md | 40 +++++++++---------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/src/connections/destinations/catalog/regal-voice/index.md b/src/connections/destinations/catalog/regal-voice/index.md index c72b0fb56f..24585b2da1 100644 --- a/src/connections/destinations/catalog/regal-voice/index.md +++ b/src/connections/destinations/catalog/regal-voice/index.md @@ -1,17 +1,17 @@ --- rewrite: true -title: Regal Voice Destination +title: Regal.io Destination id: 5f33e746fad0d620b8a4b144 --- -[Regal Voice](https://regalvoice.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a next-gen customer engagement platform that helps brands proactively engage and convert customers before they buy elsewhere. +[Regal.io](https://www.regal.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a next-gen customer engagement platform that helps brands proactively engage and convert customers before they buy elsewhere. -Regal Voice maintains this destination. For any issues with the destination, contact their [Regal Voice support team](mailto:support@regalvoice.com). +Regal.io maintains this destination. For any issues with the destination, contact their [Regal.io support team](mailto:support@regalvoice.com). > note "Note:" -> Regal Voice is available in the U.S only. +> Regal.io is available in the U.S only. > note "Note:" -> The Regal Voice Destination is in beta, which means that they are still actively developing the destination. To join the beta program, or if you have any feedback to help improve the Regal Voice Destination and its documentation, [contact the Regal Voice support team](mailto:support@regalvoice.com)! +> The Regal.io Destination is in beta, which means that they are still actively developing the destination. To join the beta program, or if you have any feedback to help improve the Regal.io Destination and its documentation, [contact the Regal.io support team](mailto:support@regalvoice.com)! ## Getting Started @@ -19,10 +19,10 @@ Regal Voice maintains this destination. For any issues with the destination, con {% include content/connection-modes.md %} 1. From the Destinations catalog page in the Segment App, click **Add Destination**. -2. Search for "Regal Voice" in the Destinations Catalog, and select the "Regal Voice" destination. -3. Choose which Source should send data to the "Regal Voice" destination. +2. Search for "Regal.io" in the Destinations Catalog, and select the "Regal.io" destination. +3. Choose which Source should send data to the "Regal.io" destination. 4. Email support@regalvoice.com to get your "API key". -5. Enter the "API Key" in the "Regal Voice" destination settings in Segment. +5. Enter the "API Key" in the "Regal.io" destination settings in Segment. ## Page @@ -33,7 +33,7 @@ If you are not familiar with the Segment Specs, take a look to understand what t analytics.page() ``` -Segment sends Page calls to Regal Voice as a pageview. +Segment sends Page calls to Regal.io as a pageview. ## Screen @@ -44,7 +44,7 @@ If you are not familiar with the Segment Spec, take a look to understand what th [[SEGAnalytics sharedAnalytics] screen:@"Home"]; ``` -Segment sends Screen calls to Regal Voice as a screen. +Segment sends Screen calls to Regal.io as a screen. ## Identify @@ -59,19 +59,19 @@ analytics.identify({ }); ``` -Segment sends Identify calls to Regal Voice as an identify event. +Segment sends Identify calls to Regal.io as an identify event. -Identify events are used to create users and update user attributes. If an identify event contains a phone, Regal Voice will create a contact in your Audience. +Identify events are used to create users and update user attributes. If an identify event contains a phone, Regal.io will create a contact in your Audience. ## Track 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. -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. +Segment recommends calling `track` on any user or system event that you may want Regal.io to be able to use for lead scoring or as triggers or conditions when sending voice and sms campaigns. -Segment sends `track` calls to Regal Voice as a track event. Pass all attributes relevant to your use case into the `properties` object. +Segment sends `track` calls to Regal.io as a track event. Pass all attributes relevant to your use case into the `properties` object. -Regal Voice communications can be triggered proactively to a user based on their activity or inactivity - in order to nudge them through your funnel. +Regal.io communications can be triggered proactively to a user based on their activity or inactivity - in order to nudge them through your funnel. 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). @@ -88,13 +88,13 @@ analytics.track('Loan Application Approved', { ## Collecting OptIn -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. +In order to trigger outbound calls or sms messages from Regal.io, 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: +There are 2 options for how you can let Regal.io know a user has opted in: -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.) +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.io 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.io to subscribe a user, there must already be a phone provided for that user.) -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. +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.io by adding an optIn object. 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: @@ -126,6 +126,6 @@ Supported messaging channels are: `sms`, `voice` and `email`. For the identify method, the `ip` field is required if you are opting in users server side. (If you are opting in users client side, Segment automatically adds ip to the context, so you are not required to add it to the optIn object) -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. +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.io ignores opt-ins that do not have a `timestamp` date. --- From 0aaa8a1cf6e906b9b1ead64cc67c611ae17df0d9 Mon Sep 17 00:00:00 2001 From: Thomas Gilbert Date: Thu, 20 Oct 2022 15:51:23 -0400 Subject: [PATCH 2/2] Update regal voice source name and support email address --- .../destinations/catalog/regal-voice/index.md | 6 ++-- .../catalog/cloud-apps/regal-voice/index.md | 30 +++++++++---------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/src/connections/destinations/catalog/regal-voice/index.md b/src/connections/destinations/catalog/regal-voice/index.md index 24585b2da1..760e6a32af 100644 --- a/src/connections/destinations/catalog/regal-voice/index.md +++ b/src/connections/destinations/catalog/regal-voice/index.md @@ -5,13 +5,13 @@ id: 5f33e746fad0d620b8a4b144 --- [Regal.io](https://www.regal.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a next-gen customer engagement platform that helps brands proactively engage and convert customers before they buy elsewhere. -Regal.io maintains this destination. For any issues with the destination, contact their [Regal.io support team](mailto:support@regalvoice.com). +Regal.io maintains this destination. For any issues with the destination, contact their [Regal.io support team](mailto:support@regal.io). > note "Note:" > Regal.io is available in the U.S only. > note "Note:" -> The Regal.io Destination is in beta, which means that they are still actively developing the destination. To join the beta program, or if you have any feedback to help improve the Regal.io Destination and its documentation, [contact the Regal.io support team](mailto:support@regalvoice.com)! +> The Regal.io Destination is in beta, which means that they are still actively developing the destination. To join the beta program, or if you have any feedback to help improve the Regal.io Destination and its documentation, [contact the Regal.io support team](mailto:support@regal.io)! ## Getting Started @@ -21,7 +21,7 @@ Regal.io maintains this destination. For any issues with the destination, contac 1. From the Destinations catalog page in the Segment App, click **Add Destination**. 2. Search for "Regal.io" in the Destinations Catalog, and select the "Regal.io" destination. 3. Choose which Source should send data to the "Regal.io" destination. -4. Email support@regalvoice.com to get your "API key". +4. Email support@regal.io to get your "API key". 5. Enter the "API Key" in the "Regal.io" destination settings in Segment. diff --git a/src/connections/sources/catalog/cloud-apps/regal-voice/index.md b/src/connections/sources/catalog/cloud-apps/regal-voice/index.md index 8478dd920d..a37a1275f1 100644 --- a/src/connections/sources/catalog/cloud-apps/regal-voice/index.md +++ b/src/connections/sources/catalog/cloud-apps/regal-voice/index.md @@ -1,30 +1,30 @@ --- -title: Regal Voice Source +title: Regal.io Source source-type: event id: 1QTd6JKw53 --- {% include content/source-region-unsupported.md %} -[Regal Voice](https://regalvoice.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a next-gen customer engagement platform built for B2C services brands to proactively reach out to customers on voice and sms before they buy elsewhere. +[Regal.io](https://regalvoice.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a next-gen customer engagement platform built for B2C services brands to proactively reach out to customers on voice and sms before they buy elsewhere. -This source is maintained by Regal Voice. For any issues with the source, [contact the Regal Voice Support team](mailto:support@regalvoice.com). +This source is maintained by Regal.io. For any issues with the source, [contact the Regal.io Support team](mailto:support@regal.io). > success "" -> **Good to know**: This page is about the Regal Voice Segment source, which sends data _into_ Segment. There's also a page about the [Regal Voice Segment destination](/docs/connections/destinations/catalog/regal-voice/), which receives data from Segment! +> **Good to know**: This page is about the Regal.io Segment source, which sends data _into_ Segment. There's also a page about the [Regal.io Segment destination](/docs/connections/destinations/catalog/regal-voice/), which receives data from Segment! ## Getting Started 1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**. -2. Search for "Regal Voice" in the Sources Catalog, select click Regal Voice, and click **Add Source**. +2. Search for "Regal.io" in the Sources Catalog, select click Regal.io, and click **Add Source**. 3. On the next screen, give the Source a nickname and configure any other settings. The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev). 5. Click **Add Source** to save your settings. -6. Copy the Write key from the Segment UI and email it to support@regalvoice.com. +6. Copy the Write key from the Segment UI and email it to support@regal.io. ## Events -The table below lists events that Regal Voice sends to Segment. These events appear as tables in your warehouse and as regular events in other Destinations. Regal Voice includes the `userId` if available. +The table below lists events that Regal.io sends to Segment. These events appear as tables in your warehouse and as regular events in other Destinations. Regal.io includes the `userId` if available. | Event name | Property description | | ---------------------------- | ----------------------------------------------------------------------------------------------------- | @@ -36,10 +36,10 @@ The table below lists events that Regal Voice sends to Segment. These events app | contact.attribute.edited | A contact's attributes were edited by an agent. | | contact.experiment.assigned | A contact was assigned to an experiment. | | scheduled.callback.requested | A callback was scheduled. | -| sms.conversation.completed | An SMS conversation between a contact and an agent was completed in the Regal Voice agent desktop. | -| sms.queued | An SMS was queued to be sent from Regal Voice to contact. | -| sms.sent | An SMS was sent from Regal Voice to contact. | -| sms.undelivered | An SMS was undelivered from Regal Voice to contact. | +| sms.conversation.completed | An SMS conversation between a contact and an agent was completed in the Regal.io agent desktop. | +| sms.queued | An SMS was queued to be sent from Regal.io to contact. | +| sms.sent | An SMS was sent from Regal.io to contact. | +| sms.undelivered | An SMS was undelivered from Regal.io to contact. | | sms.received | An SMS was received from a contact. | | task.canceled | A call or SMS task was canceled. | | task.created | A call or SMS task was created. | @@ -82,10 +82,10 @@ The table below lists events that Regal Voice sends to Segment. These events app | `media_url` | Media URL (if it was an MMS) | | `notes` | Task notes | | `objections` | Task objections | -| `phone` | The phone number the subscription updated was applied to; phone number is the unique identifier for a contact in Regal voice | +| `phone` | The phone number the subscription updated was applied to; phone number is the unique identifier for a contact in Regal.io | | `queue` | Task Queue | | `recording_link` | Call recording link | -| `regal_voice_phone` | Regal Voice phone number | +| `regal_voice_phone` | Regal.io phone number | | `regal_voice_phone_internal_name` | Internal name of phone line displayed to agents | `reserved_agent_email` | Email of the agent the task reservation is for | `reserved_agent_full_name` | Full name of the agent the task reservation is for @@ -93,7 +93,7 @@ The table below lists events that Regal Voice sends to Segment. These events app | `scheduling_agent_fullname` | Full name of the agent who scheduled the callback | | `scheduling_agent_id` | Email of the agent who scheduled the callback | | `sms_conversation_id` | Task ID for the conversation (if the SMS was part of a two-way conversation with an agent, rather than just an automated outbound sms) | -| `source` | Source of the subscription update. A source value that starts with "Brand." indicates that the subscription update was initiated by the Brand (outside of the Regal Voice platform). A source value that starts with "RegalVoice." indicates that the subscription update was initiated through the Regal Voice platform. | +| `source` | Source of the subscription update. A source value that starts with "Brand." indicates that the subscription update was initiated by the Brand (outside of the Regal.io platform). A source value that starts with "RegalVoice." indicates that the subscription update was initiated through the Regal.io platform. | | `started_at` | UTC timestamp when the conversation was started | | `talk_time` | Duration of conversation (ended_at - started_at) | | `target_agent_fullname` | Full name of the agent who contact (and all contact's tasks) are assigned to | @@ -111,4 +111,4 @@ Now that your Source is set up, you can connect it with Destinations. Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don't appear, check the [Event Delivery](https://segment.com/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting. -If there are any issues with how the events are arriving to Segment, [contact the Regal Voice support team](mailto:support@regalvoice.com). +If there are any issues with how the events are arriving to Segment, [contact the Regal.io support team](mailto:support@regal.io).