Skip to content

Commit ce6c396

Browse files
authored
Merge pull request #5623 from namit1Flow/1flow-web
1Flow-web doc
2 parents ebe524f + 49e1780 commit ce6c396

File tree

1 file changed

+78
-0
lines changed
  • src/connections/destinations/catalog/1flow-web

1 file changed

+78
-0
lines changed
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
title: 1Flow Web (Actions) Destination
3+
hidden: true
4+
versions:
5+
- name: '1Flow Web (Actions) Destination'
6+
link: '/docs/connections/destinations/catalog/1flow-web'
7+
8+
---
9+
[1Flow](https://1flow.ai/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is a leading in-app user survey and messaging platform for Mobile app and SaaS businesses.
10+
11+
{% include content/plan-grid.md name="actions" %}
12+
13+
1Flow is an easy-to-use, yet powerful in-app survey and messaging software.
14+
Using 1Flow, you can reach users in-the-moment while they are interacting with your website or mobile app, to collect highly contextual user insights that help you improve your product offering and customer experience.
15+
16+
When you use the 1Flow Web (Actions) Destination, Segment loads the [1Flow SDK](https://1flow.ai/docs/install-sdk/javascript){:target="_blank"} for you. The 1Flow library enables you to track and identify user events on your website and interact with the 1Flow messenger window.
17+
{% include content/ajs-upgrade.md %}
18+
## Benefits of 1Flow Web Mode (Actions) Destination
19+
20+
After you install both Segment and 1Flow's Segment Plugin for the web:
21+
1. You can track events and identify users
22+
2. Segment passes the event and user payload directly to 1Flow
23+
3. 1Flow then uses this information to trigger surveys and identify users
24+
25+
26+
## Getting started
27+
1. From Segment, navigate to **Connections > Catalog**, then select **Destinations**.
28+
2. Search for and select **1Flow Web (Actions) Destination**.
29+
3. Click **Configure 1Flow Web (Actions) Destination**
30+
4. Select the web source that will send data to 1Flow web (Actions) and follow the steps to name your destination. The web source chosen must use [Analytics.js 2.0](/docs/connections/source/catalog/libraries/website/javascript).
31+
5. On the **Settings** tab, input your 1Flow "PROJECTAPIKEY" and other destinations settings.
32+
6. Follow the step in the Destinations Actions docs to [customizing mappings](/docs/connections/destinations/action/#customizing-mappings).
33+
7. Enable the destination and configured mappings.
34+
35+
```suggestion
36+
{% include components/actions-fields.html %}
37+
## Supported methods
38+
39+
### Identify
40+
If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. Below is an example of how a Segment Identify event maps to an invocation of the 1flow SDK:
41+
42+
```window._1flow('identify', 'userId', {
43+
'name': 'Jane Doe',
44+
'company': 'ACME, Inc.'
45+
'email': 'jane.doe@gmail.com',
46+
'plan': 'Premium'
47+
'total_spend': 880
48+
});
49+
50+
```
51+
When you call Segment's Identify method, it will be equivalent to `logUser` of 1Flow.
52+
- Segment's `userId` is `userID` in 1Flow
53+
- Segment's `traits` is `userDetails` in 1Flow
54+
55+
### Track
56+
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. Below is an example of how a Segment Track event maps to an invocation of the 1flow SDK:
57+
58+
```
59+
60+
window._1flow('track', 'event name', {
61+
'record_id':'1234abcdef56',
62+
'quantity': 1
63+
});
64+
65+
```
66+
Any value passed in `name`, will be eventName and if you have passed any event property, then it will be event `parameters`.
67+
68+
69+
## Troubleshooting
70+
71+
### Requests to 1Flow return a 404 response
72+
If you are seeing 404 responses in your browser's network tab, you've likely encountered one of two issues:
73+
74+
- You set the wrong App ID on the 1Flow Actions (Web) destination settings page.
75+
- You set the wrong Regional Data Hosting value on the 1Flow Actions (Web) destination settings page. 1Flow gates regional endpoints by plan level, so you may not have access to EU data hosting.
76+
77+
### 1Flow does not support rETL event batching
78+
The 1Flow (Web) Actions destination does not support the bulk contacts endpoint, and therefore is unable to support batching events in rETL.

0 commit comments

Comments
 (0)