Skip to content

Commit f61861f

Browse files
committed
add readme
1 parent e1603bb commit f61861f

File tree

1 file changed

+134
-0
lines changed
  • src/connections/destinations/catalog/actions-survicate

1 file changed

+134
-0
lines changed
Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
---
2+
rewrite: true
3+
title: Survicate (Actions) Destination
4+
id: 5c922eae1761cd0001a71707
5+
---
6+
[Survicate](https://survicate.com/integrations/egment-survey/?utm_source=segment&utm_medium=referral){:target="_blank”} is a complete toolkit for customer feedback.
7+
8+
This destination is maintained by Survicate. For any issues with the destination, [contact the Survicate Support team](mailto:[email protected]).
9+
10+
11+
12+
## Getting Started
13+
14+
15+
1. From the Segment web app, click **Destinations**.
16+
2. Search for "Survicate" in the Catalog, select it, and choose which of your sources to connect the destination to.
17+
3. Enter the "Workspace Key" into your Segment Settings UI which you can find from your [Survicate Workspace Settings](https://panel.survicate.com/o/0/w/0/settings/web-surveys){:target="_blank"}.
18+
19+
## Identify
20+
21+
If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. An example call would look like:
22+
23+
```
24+
analytics.identify('userId123', {
25+
26+
jobTitle: 'CEO',
27+
companySize: '50'
28+
});
29+
```
30+
When you call Identify, we pass Segment traits as respondents' attributes to Survicate. They can be used to trigger web surveys or filter survey results.
31+
32+
All traits passed in Identify calls will be available in Survicate - once you view a respondent profile or export survey data.
33+
34+
All `camelCase` attribute keys are translated to `snake_case`.
35+
36+
37+
All *object attributes* will be flattened to attributes prefixed by object key. All *array attributes* will be omitted.
38+
39+
```
40+
analytics.identify('1234', {
41+
address: {
42+
street: '6th St',
43+
city: 'San Francisco',
44+
state: 'CA',
45+
postalCode: '94103',
46+
country: 'USA'
47+
},
48+
categories: ['startup','SaaS']
49+
});
50+
```
51+
52+
The above described call creates following respondent's traits in Survicate:
53+
54+
| key | value |
55+
| ------------------- | ------------- |
56+
| id | 1234 |
57+
| address_street | 6th St |
58+
| address_city | San Francisco |
59+
| address_state | CA |
60+
| address_postal_code | 94103 |
61+
| address_country | USA |
62+
63+
*Categories* attribute is omitted as it is an array attribute.
64+
65+
## Group
66+
67+
If you're not familiar with the Segment Specs, take a look to understand what the [Group method](/docs/connections/spec/group/) does. An example call would look like:
68+
69+
```
70+
analytics.group('group123', {
71+
name: 'Company Inc.'
72+
});
73+
```
74+
75+
All Group traits will be passed to respondent attributes with `group_` prefix. All `camelCase` attribute keys are translated to `snake_case`. All *object attributes* will be flattened to attributes prefixed by object key. All *array attributes* will be omitted.
76+
77+
```
78+
analytics.group('group123', {
79+
name: 'Company Inc.',
80+
address: {
81+
street: '6th St',
82+
city: 'San Francisco',
83+
state: 'CA',
84+
postalCode: '94103',
85+
country: 'USA'
86+
},
87+
categories: ['startup','SaaS']
88+
});
89+
```
90+
91+
The above described call creates the following respondent's traits in Survicate:
92+
93+
| key | value |
94+
| ------------------------- | ------------- |
95+
| group_id | group123 |
96+
| group_name | Company Inc. |
97+
| group_address_street | 6th St |
98+
| group_address_city | San Francisco |
99+
| group_address_state | CA |
100+
| group_address_postal_code | 94103 |
101+
| group_address_country | USA |
102+
103+
*Categories* attribute is omitted as it is an array attribute.
104+
105+
## Track
106+
107+
A Segment track call, f.ex:
108+
```
109+
analytics.track('plan_purchased', {
110+
plan: 'Pro Annual',
111+
accountType : 'Facebook'
112+
});
113+
```
114+
115+
will trigger a Survicate call that sends the event name and properties to Survicate.
116+
117+
If you want to trigger your survey on a Segment event, you are able to do that by setting that condition in the panel in the targeting tab in the section: "When a user triggers an event" under "Where would you like to show the survey".
118+
119+
When the Segment event fires and other targeting conditions you've set in the panel are met - your survey will show.
120+
121+
Event properties are optional.
122+
123+
### Sending survey answers to Segment
124+
125+
Once the Segment integration is enabled in Survicate Integrations tab, it starts sending track events from your client-side source. Here's a sample call that will be triggered when a survey is answered.
126+
127+
```
128+
analytics.track('survicate_survey_answered', {
129+
answer: 'Great suppport!',
130+
answer_type: 'text',
131+
question: 'What makes us stand out from the competition?',
132+
survey: 'Advantages Over Competition Research',
133+
});
134+
```

0 commit comments

Comments
 (0)