Skip to content

Commit 41bcbe8

Browse files
authored
Merge pull request #5911 from surveysparrowuser/develop
added-surveysparrow-source-and-destination-doc
2 parents f39e023 + 8c41a12 commit 41bcbe8

File tree

2 files changed

+81
-0
lines changed
  • src/connections
    • destinations/catalog/actions-surveysparrow
    • sources/catalog/cloud-apps/surveysparrow

2 files changed

+81
-0
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: SurveySparrow (Actions) Destination
3+
hidden: true
4+
beta: true
5+
---
6+
{% include content/plan-grid.md name="actions" %}
7+
8+
[SurveySparrow](https://surveysparrow.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is an end-to-end omnichannel experience management platform that bundles Customer Experience and Employee Experience tools such as NPS, Offline, Chat, Classic, and 360 Surveys which are mobile-first, highly engaging, and user-friendly.
9+
10+
This destination is maintained by SurveySparrow. For any issues with the destination, [contact their Support team](mailto:[email protected]).
11+
12+
## Getting started
13+
14+
1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank"} search for "SurveySparrow"
15+
2. Select SurveySparrow and click **Add Destination**
16+
3. Select an existing Source to connect to SurveySparrow (Actions).
17+
4. Log in to your [SurveySparrow](https://app.surveysparrow.com/) account, then navigate to **Settings > Apps and Integrations > Create a Custom app**.
18+
5. Fill in the details for the custom app and choose **Select all** under Scope. Later, you can remove any scopes that are not required.
19+
6. Click **Save** and copy the **Access Token**.
20+
7. Enter the **Access Token** in the SurveySparrow destination settings in Segment.
21+
22+
{% include components/actions-fields.html %}
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: SurveySparrow Source
3+
id: di2sOHoscX
4+
hidden: true
5+
beta: true
6+
---
7+
[SurveySparrow](https://surveysparrow.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is an end-to-end omnichannel experience management platform that bundles Customer Experience and Employee Experience tools such as NPS, Offline, Chat, Classic, and 360 Surveys which are mobile-first, highly engaging, and user-friendly.
8+
9+
This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations.
10+
11+
This source is maintained by SurveySparrow. For any issues with the source, [contact their Support team](mailto:[email protected]).
12+
13+
## Getting started
14+
15+
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank"} click **Add Source**.
16+
2. Search for "SurveySparrow" in the Sources Catalog, select SurveySparrow, and click **Add Source**.
17+
3. On the next screen, give the Source a name, then configure any other settings.
18+
19+
- The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SurveySparrow_Prod, SurveySparrow_Staging, SurveySparrow_Dev).
20+
21+
4. Click **Add Source** to save your settings.
22+
5. Copy the Write key from the Segment UI.
23+
6. Log in to your SurveySparrow account - navigate to Settings > Apps and Integrations > Segment Source Integration and paste the Write key and select the Segment data processing region to connect.
24+
25+
## Stream
26+
27+
SurveySparrow uses our stream Source component to send Segment event data. It uses a server-side (`track`) method to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL.
28+
29+
The default behavior is for SurveySparrow to pass the hash value of the email address and mobile number of the respondent as the `anonymousId`. There are cases in which SurveySparrow does not have an associated email address or mobile number, in which case a random hash will be passed in as the `anonymousId`.
30+
31+
## Events
32+
33+
The table below lists events that SurveySparrow sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. SurveySparrow includes the `anonymousId` if available.
34+
35+
| Event Name | Description |
36+
| ------------------ | ------------------------------------- |
37+
| Submission Completed | Survey response was submitted successfully |
38+
39+
## Event Properties
40+
41+
The table below lists the properties included in the events listed above.
42+
43+
| Property Name | Description |
44+
| --------------- | ------------------------- |
45+
| `event` | Type of the event |
46+
| `survey` | Will hold all the properties data including surveys, answers,channel,expressions,variables |
47+
| `survey` | Meta details about the survey |
48+
| `contact` | Contact which has created the response |
49+
| `expressions` | Computed expressions data of the survey |
50+
| `variables` | Computed variables data of the survey |
51+
| `answers` | contains answer details of the entire survey |
52+
53+
## Adding Destinations
54+
55+
Now that your Source is set up, you can connect it with Destinations.
56+
57+
Log in to 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](/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.
58+
59+
If there are any issues with how the events are arriving to Segment, [contact the SurveySparrow support team](mailto:[email protected]).

0 commit comments

Comments
 (0)