Skip to content

Commit 638347f

Browse files
added-surveysparrow-source-and-destination-doc
1 parent 9d44ec6 commit 638347f

File tree

2 files changed

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

2 files changed

+97
-0
lines changed
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
Title: SurveySparrow (Actions) Destination
2+
---
3+
{% include content/plan-grid.md name="actions" %}
4+
5+
[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.
6+
7+
This destination is maintained by SurveySparrow. For any issues with the destination, [contact their Support team](mailto:[email protected]).
8+
9+
## Getting started
10+
11+
1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank"} search for "SurveySparrow"
12+
2. Select SurveySparrow and click **Add Destination**
13+
3. Select an existing Source to connect to SurveySparrow (Actions).
14+
4. Login to your [SurveySparrow](https://app.surveysparrow.com/) account, navigate to **Settings > Apps and Integrations > Create a Custom app**.
15+
5. Fill in the details for custom app and choose **Select all** under Scope. Later, you can remove the scopes which are not required.
16+
6. Click **Save** and copy the **Access Token**.
17+
7. Enter the **Access Token** in the SurveySparrow destination settings in Segment.
18+
19+
## Action destination for Survey trigger event
20+
21+
| Property Name | Type | Description |
22+
| ------------- |:-------------:| :----- |
23+
| `email` | string | Email of the contact to be created |
24+
| `phone` | string | Phone number of the contact to be created |
25+
| `share_type` | string | Share channel type (SMS, Email, Whatsapp |
26+
| `channel_id` | integer | Share Channel Id created in survey sparrow |
27+
| `survey_id` | integer | ID of the survey created |
28+
| `variables` | object | Can hold extra payload if necessary |
29+
30+
31+
## Action destination for Contact creation event
32+
33+
| Property Name | Type | Description |
34+
| ------------- |:-------------:| :----- |
35+
| `full_name` | string | Full Name of contact |
36+
| `phone` | string | Phone number of the contact |
37+
| `mobile` | string | Mobile number of the contact |
38+
| `email | string | Email of contact |
39+
| `job_title` | string | Job Title of the contact |
40+
| `contact_type` | string | Type of contact [contact,employee] |
41+
42+
43+
44+
{% include components/actions-fields.html %}
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
title: SurveySparrow Source
2+
---
3+
[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.
4+
5+
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.
6+
7+
This source is maintained by SurveySparrow. For any issues with the source, [contact their Support team](mailto:[email protected]).
8+
9+
## Getting started
10+
11+
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank"} click **Add Source**.
12+
2. Search for "SurveySparrow" in the Sources Catalog, select SurveySparrow, and click **Add Source**.
13+
3. On the next screen, give the Source a name configure any other settings.
14+
15+
- 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. SourceName_Prod, SourceName_Staging, SourceName_Dev).
16+
17+
4. Click **Add Source** to save your settings.
18+
5. Copy the Write key from the Segment UI.
19+
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.
20+
21+
## Stream
22+
23+
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.
24+
25+
The default behavior is for SurveySparrow to pass the hash value of email and mobile number of respondent as the anonymousId. There are cases in which SurveySparrow does not have an associated email or mobile number, in which case a random hash will be passed in as the anonymousId.
26+
27+
## Events
28+
29+
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.
30+
31+
| Event Name | Description |
32+
| ------------------ | ------------------------------------- |
33+
| Submission Completed | Survey response was submitted successfully |
34+
35+
## Event Properties
36+
37+
The table below list the properties included in the events listed above.
38+
39+
| Property Name | Description |
40+
| --------------- | ------------------------- |
41+
| `survey` | Survey details from which the response came |
42+
| `answers` | Responses of the Survey |
43+
| `channel` | Share channel which is used to trigger the Survey |
44+
| `expressions` | Expressions value of the Survey |
45+
| `variables` | Variables value of the Survey |
46+
47+
## Adding Destinations
48+
49+
Now that your Source is set up, you can connect it with Destinations.
50+
51+
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](/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.
52+
53+
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)