Skip to content

Commit c064b1b

Browse files
prathamesh-88markzegarelli
and
markzegarelli
authored
VWO Cloud Update (#4827)
* VWO Cloud update for FullStack * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md Co-authored-by: markzegarelli <[email protected]> * Update src/connections/destinations/catalog/actions-vwo-cloud/index.md * formatting fix for code sample --------- Co-authored-by: markzegarelli <[email protected]>
1 parent 35ee923 commit c064b1b

File tree

1 file changed

+148
-2
lines changed
  • src/connections/destinations/catalog/actions-vwo-cloud

1 file changed

+148
-2
lines changed

src/connections/destinations/catalog/actions-vwo-cloud/index.md

Lines changed: 148 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ versions:
1010

1111
{% include content/plan-grid.md name="actions" %}
1212

13-
[VWO](https://vwo.com/) is an optimization platform that allows websites to run experiments on their platforms to derive insights from visitor behavior and harness the results to amp up the conversion rate. Apart from experimentation, it also provides for personalization of the platform for different cohorts, full stack implementation, and direct deployment of the changes determined through experimentation.
13+
[VWO](https://vwo.com/){:target="_blank"} is an optimization platform that allows websites to run experiments on their platforms to derive insights from visitor behavior and harness the results to amp up the conversion rate. Apart from experimentation, it also provides for personalization of the platform for different cohorts, full stack implementation, and direct deployment of the changes determined through experimentation.
1414

1515
> info ""
16-
> The events and attributes that are transferred from Segment to your VWO account will appear under [Unregistered Events](https://help.vwo.com/hc/en-us/articles/8676443712537-Working-with-Events-in-VWO#:~:text=UNREGISTERED%20EVENTS%3A%20These%20are%20the,UNREGISTERED%20EVENTS.){:target="_blank"} and [Unregistered Attributes](https://help.vwo.com/hc/en-us/articles/8681465703705-Working-with-Attributes-in-VWO#:~:text=UNREGISTERED%20ATTRIBUTES%3A%20These%20are%20the,UNREGISTERED%20ATTRIBUTES.){:target="_blank"} sections, respectively. You need to save these events and attributes to VWO for further use.
16+
> The events and attributes that are transferred from Segment to your VWO account will appear under [UNREGISTERED EVENTS](https://help.vwo.com/hc/en-us/articles/8676443712537-Working-with-Events-in-VWO#:~:text=UNREGISTERED%20EVENTS%3A%20These%20are%20the,UNREGISTERED%20EVENTS.){:target="_blank"} and [UNREGISTERED ATTRIBUTES](https://help.vwo.com/hc/en-us/articles/8681465703705-Working-with-Attributes-in-VWO#:~:text=UNREGISTERED%20ATTRIBUTES%3A%20These%20are%20the,UNREGISTERED%20ATTRIBUTES.){:target="_blank"} sections, respectively. You need to save these events and attributes to VWO for further use.
1717
1818
## Benefits of VWO Cloud Mode(Actions) vs VWO Classic
1919

@@ -32,6 +32,152 @@ VWO Cloud Mode (Actions) provides the following benefits over the classic VWO de
3232
6. To customize the mapping of actions, follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings). Mappings in Segment allow you to control the events and attributes that are sent to VWO.
3333
7. Enable the destination using the toggle switch.
3434

35+
> info ""
36+
> VWO requires you to include a `vwo_uuid` key for all calls made in cloud-mode. The value of this key must be the VWO UUID(in the case of a website) or the User ID (in the case of FullStack). Track and Page calls require the `vwo_uuid` in the *properties* object. For Identify calls, you can place `vwo_uuid` in the *traits* object.
37+
38+
## Using VWO Cloud mode destination with Web
39+
40+
> info ""
41+
> VWO recommends using the [VWO Web Mode destination](/docs/connections/destinations/catalog/actions-vwo-web/) for web pages as it requires minimal to no additional setup.
42+
43+
1. Install the VWO SmartCode on your website following VWO's guide [Configuring SmartCode for Your Website](https://help.vwo.com/hc/en-us/articles/360019422834-Configuring-SmartCode-for-Your-Website){:target="_blank"}
44+
2. Create a VWO campaign on your website.
45+
3. When a visitor lands on your website VWO generates a `_vwo_uuid` cookie that acts as a unique identifier for the visitor. To learn more about the VWO UUID, see VWO's article [How to locate your VWO UUID](https://help.vwo.com/hc/en-us/articles/360034891513-How-to-Locate-your-VWO-UUID-){:target="_blank"}.
46+
4. Pass the value of the `_vwo_uuid` cookie with every call to Segment in the `vwo_uuid` key. Track and Page calls require the `vwo_uuid` in the *properties* object. For Identify calls, you can place `vwo_uuid` in the *traits* object.<br><br>To automate this step, you can use [Segment Analytics.js middleware](/docs/connections/sources/catalog/libraries/website/javascript/middleware/) and use the following script on your website. This script fetches the VWO UUID from the cookie and adds it to the segment payload so that you don’t have to do the same manually.
47+
48+
```html
49+
<script>
50+
analytics.addSourceMiddleware(({ payload, next, integrations }) => {
51+
const getCookie = function (name) {
52+
const value = `; ${document.cookie}`;
53+
const parts = value.split(`; ${name}=`);
54+
if (parts.length === 2) return parts.pop().split(";").shift();
55+
};
56+
const event = payload.obj;
57+
const vwoUuid = getCookie("_vwo_uuid");
58+
switch (event.type) {
59+
case "track":
60+
case "page":
61+
payload.obj.properties.vwo_uuid = vwoUuid;
62+
break;
63+
case "identify":
64+
payload.obj.traits.vwo_uuid = vwoUuid;
65+
break;
66+
}
67+
next();
68+
});
69+
</script>
70+
```
71+
72+
All the events triggered in Segment will be available under **UNREGISTERED EVENTS** in the **Data360 > Events** section in VWO. For more information about Events in VWO Data360, see VWO's article [Working with Events in VWO](https://help.vwo.com/hc/en-us/articles/8676443712537-Working-with-Events-in-VWO){:target="_blank"}.
73+
74+
75+
## Use VWO Cloud mode destination with VWO FullStack
76+
77+
To use the VWO Cloud mode destination with the VWO FullStack suite, link your VWO FullStack environment with Segment using the environment’s SDK key. After that's done, integrate your VWO account with Segment.
78+
79+
To link your VWO FullStack environment with Segment:
80+
81+
1. From your VWO dashboard, navigate to the nav bar on the left > **FullStack > Projects** and select the appropriate project.
82+
2. Under the **Environments** section, click the **Copy** button corresponding to the environment that you want to link to Segment.
83+
3. In the **VWO SDK Key** field in the destination settings in Segment, paste the copied SDK key from the previous step.
84+
4. Click **Save Changes**.
85+
86+
To integrate Segment with VWO FullStack:
87+
88+
1. Initialize VWO FullStack SDK. Follow the steps for your server in VWO's [Quick Start Guide](https://developers.vwo.com/docs/quick-start-guide){:target="_blank"}.
89+
2. To track visitors in VWO, provide the user IDs of the visitors, which were used to track them in the VWO FullStack campaign. Pass that same User ID as `vwo_uuid` with all calls to Segment. Track and Page calls require the `vwo_uuid` in the *properties* object. For Identify calls, you can place `vwo_uuid` in the *traits* object..
90+
3. All the events triggered in Segment will be available under **UNREGISTERED EVENTS** section which can be accessed by navigating from the left navbar > **Data360 > Events**.
91+
92+
## Supported Segment Calls in VWO
93+
94+
VWO Supports the following calls, as specified in the [Segment Spec](/docs/connections/spec/).
95+
96+
### Track
97+
The [Track](/docs/connections/spec/track/) call records any actions your visitors perform, along with any properties that describe the action. Each action is known as an event.
98+
99+
The destination forwards these events to VWO Data360 where they can be seen under the **UNREGISTERED EVENTS** section in **Data360 > Events** in VWO. These events can be registered and used as [Metrics](https://help.vwo.com/hc/en-us/articles/8675547113625-Working-with-Metrics-in-VWO){:target="_blank"} in VWO.
100+
101+
**Sample payload for Track Call to the destination**
102+
103+
```js
104+
analytics.track("Segment Test Event", {
105+
"vwo_uuid": "<VWO UUID or User ID>",
106+
"property1": "value1"
107+
});
108+
```
109+
110+
**Corresponding JavaScript event that would generate the above payload**
111+
112+
```js
113+
{
114+
"type": "track",
115+
"event": "<Event Name>",
116+
"properties": {
117+
"vwo_uuid": "<VWO UUID or User ID>",
118+
"property1": "value1"
119+
}
120+
}
121+
```
122+
123+
> info ""
124+
> Event names are prepended with `segment.` before they're sent to VWO. If an event named "**ctaClick**" is triggered in Segment, it appears as `segment.ctaClick` under **UNREGISTERED EVENTS** in VWO.
125+
126+
### Identify
127+
The [Identify](/docs/connections/spec/identify/) call associates a visitor with their actions and captures their traits.
128+
129+
The destination forwards these traits to VWO Data360 where they can be seen under the **UNREGISTERED ATTRIBUTES** section in the **Data360 > Attributes** in VWO. These attributes can be registered and used to create [segments in VWO](https://help.vwo.com/hc/en-us/articles/8976459309465-Working-with-Segments-in-VWO-Data360){:target="_blank"}. For more information about Attributes in VWO Data360, see [Working with Attributes in VWO](https://help.vwo.com/hc/en-us/articles/8681465703705-Working-with-Attributes-in-VWO){:target="_blank"}.
130+
131+
**Sample payload for Identify call to the destination**
132+
133+
```js
134+
{
135+
"type": "identify",
136+
"traits": {
137+
"vwo_uuid": "<VWO UUID or User ID>",
138+
"trait1": "value1"
139+
}
140+
}
141+
```
142+
143+
**Corresponding JavaScript event that would generate the above payload**
144+
145+
```js
146+
analytics.identify({
147+
"vwo_uuid": "<VWO UUID or User ID>",
148+
"trait1": "value1"
149+
});
150+
```
151+
152+
> info ""
153+
> Each trait key will be prepended with “**segment.**” before sending to VWO. So if a trait named "**trait1**" is sent in Segment, it’ll appear as "**segment.trait1**" under UNREGISTERED ATTRIBUTES in VWO.
154+
155+
156+
### Page
157+
The [Page](/docs/connections/spec/page/){:target="_blank"} call records when a visitor arrives at a page of your website, along with any optional properties about the page. When received, the destination triggers VWO’s Page Visit event.
158+
159+
> info ""
160+
> Use Page calls with web pages only. Server-side sources in VWO's FullStack Suite do not support the Page Visit event.
161+
162+
**Sample payload for Page Call to the destination**
163+
164+
```js
165+
{
166+
"type": "page",
167+
"properties": {
168+
"vwo_uuid": "<VWO UUID or User ID>"
169+
}
170+
}
171+
172+
```
173+
174+
**Corresponding JavaScript event that would generate the above payload**
175+
176+
```js
177+
analytics.page({
178+
"vwo_uuid": "<VWO UUID or UserID>",
179+
});
180+
```
35181
<!-- The line below renders a table of connection settings (if applicable), Pre-built Mappings, and available actions. -->
36182

37183
{% include components/actions-fields.html %}

0 commit comments

Comments
 (0)