-
Notifications
You must be signed in to change notification settings - Fork 385
added-surveysparrow-source-and-destination-doc #5911
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
638347f
added-surveysparrow-source-and-destination-doc
surveysparrowuser 6c79f1c
changing properties
surveysparrowuser abaec11
Update src/connections/destinations/catalog/surveysparrow/index.md
surveysparrowuser 0ac609b
Update src/connections/destinations/catalog/surveysparrow/index.md
surveysparrowuser 4480f93
Update src/connections/destinations/catalog/surveysparrow/index.md
surveysparrowuser e20b319
Update src/connections/sources/catalog/cloud-apps/surveysparrow/index.md
surveysparrowuser f349119
Update src/connections/sources/catalog/cloud-apps/surveysparrow/index.md
surveysparrowuser a08056d
Update src/connections/sources/catalog/cloud-apps/surveysparrow/index.md
surveysparrowuser 886fdd3
Update src/connections/sources/catalog/cloud-apps/surveysparrow/index.md
surveysparrowuser 725a2ed
Update src/connections/sources/catalog/cloud-apps/surveysparrow/index.md
surveysparrowuser cb15ebf
Update src/connections/destinations/catalog/surveysparrow/index.md
surveysparrowuser 0e38b1e
Update src/connections/sources/catalog/cloud-apps/surveysparrow/index.md
surveysparrowuser b0b8e09
Update src/connections/sources/catalog/cloud-apps/surveysparrow/index.md
surveysparrowuser 8c41a12
folder name change and removed the tables
surveysparrowuser File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
44 changes: 44 additions & 0 deletions
44
src/connections/destinations/catalog/surveysparrow/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
Title: SurveySparrow (Actions) Destination | ||
--- | ||
{% include content/plan-grid.md name="actions" %} | ||
|
||
[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. | ||
surveysparrowuser marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
This destination is maintained by SurveySparrow. For any issues with the destination, [contact their Support team](mailto:[email protected]). | ||
|
||
## Getting started | ||
|
||
1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank"} search for "SurveySparrow" | ||
2. Select SurveySparrow and click **Add Destination** | ||
3. Select an existing Source to connect to SurveySparrow (Actions). | ||
4. Login to your [SurveySparrow](https://app.surveysparrow.com/) account, navigate to **Settings > Apps and Integrations > Create a Custom app**. | ||
surveysparrowuser marked this conversation as resolved.
Show resolved
Hide resolved
|
||
5. Fill in the details for custom app and choose **Select all** under Scope. Later, you can remove the scopes which are not required. | ||
surveysparrowuser marked this conversation as resolved.
Show resolved
Hide resolved
|
||
6. Click **Save** and copy the **Access Token**. | ||
7. Enter the **Access Token** in the SurveySparrow destination settings in Segment. | ||
|
||
## Action destination for Survey trigger event | ||
|
||
| Property Name | Type | Description | | ||
| ------------- |:-------------:| :----- | | ||
| `email` | string | Email of the contact to be created | | ||
| `phone` | string | Phone number of the contact to be created | | ||
| `share_type` | string | Share channel type (SMS, Email, Whatsapp | | ||
| `channel_id` | integer | Share Channel Id created in survey sparrow | | ||
| `survey_id` | integer | ID of the survey created | | ||
| `variables` | object | Can hold extra payload if necessary | | ||
|
||
|
||
## Action destination for Contact creation event | ||
|
||
| Property Name | Type | Description | | ||
| ------------- |:-------------:| :----- | | ||
| `full_name` | string | Full Name of contact | | ||
| `phone` | string | Phone number of the contact | | ||
| `mobile` | string | Mobile number of the contact | | ||
| `email | string | Email of contact | | ||
| `job_title` | string | Job Title of the contact | | ||
| `contact_type` | string | Type of contact [contact,employee] | | ||
surveysparrowuser marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
|
||
|
||
{% include components/actions-fields.html %} |
55 changes: 55 additions & 0 deletions
55
src/connections/sources/catalog/cloud-apps/surveysparrow/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
title: SurveySparrow Source | ||
--- | ||
surveysparrowuser marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[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. | ||
surveysparrowuser marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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. | ||
|
||
This source is maintained by SurveySparrow. For any issues with the source, [contact their Support team](mailto:[email protected]). | ||
|
||
## Getting started | ||
|
||
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank"} click **Add Source**. | ||
2. Search for "SurveySparrow" in the Sources Catalog, select SurveySparrow, and click **Add Source**. | ||
3. On the next screen, give the Source a name configure any other settings. | ||
surveysparrowuser marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- 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). | ||
surveysparrowuser marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
4. Click **Add Source** to save your settings. | ||
5. Copy the Write key from the Segment UI. | ||
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. | ||
|
||
## Stream | ||
|
||
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. | ||
|
||
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. | ||
surveysparrowuser marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Events | ||
|
||
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. | ||
|
||
| Event Name | Description | | ||
| ------------------ | ------------------------------------- | | ||
| Submission Completed | Survey response was submitted successfully | | ||
|
||
## Event Properties | ||
|
||
The table below list the properties included in the events listed above. | ||
surveysparrowuser marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
| Property Name | Description | | ||
| --------------- | ------------------------- | | ||
| `event` | Type of the event | | ||
| `survey` | Will hold all the properties data including surveys, answers,channel,expressions,variables | | ||
| `survey` | Meta details about the survey | | ||
| `contact` | Contact which has created the response | | ||
| `expressions` | Computed expressions data of the survey | | ||
| `variables` | Computed variables data of the survey | | ||
| `answers` | contains answer details of the entire survey | | ||
|
||
## Adding Destinations | ||
|
||
Now that your Source is set up, you can connect it with Destinations. | ||
|
||
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. | ||
surveysparrowuser marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
If there are any issues with how the events are arriving to Segment, [contact the SurveySparrow support team](mailto:[email protected]). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.