Skip to content

Commit 5d5186e

Browse files
Merge pull request #4234 from segmentio/thomas/formsort
add docs for formsort
2 parents 3008ee9 + 6d77420 commit 5d5186e

File tree

1 file changed

+63
-2
lines changed
  • src/connections/sources/catalog/cloud-apps/formsort

1 file changed

+63
-2
lines changed
Lines changed: 63 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,65 @@
11
---
2-
title: 'Formsort Source'
2+
title: "Formsort Source"
3+
id: f02zgzAWMG
34
hidden: true
4-
---
5+
---
6+
7+
[Formsort](https://formsort.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a low code form builder empowering product and growth teams to build and optimize highly complex, customizable flows. Increase form conversion by over 20% - without the dev time.
8+
9+
10+
This source is maintained by Formsort. For any issues with the source, [contact the Formsort support team](mailto:[email protected]).
11+
12+
## Getting Started
13+
14+
1. From your Segment UI’s Sources page click on “Add Source”.
15+
2. Search for “Formsort” within the Sources Catalog and confirm by clicking “Connect”.
16+
3. Give the source a nickname and follow the set up flow to “Add Source”. The nickname is a label used in the Segment interface, and Segment creates a related schema name which you query against in your warehouse. The nickname can be whatever you like, but Segment recommends sticking to something that reflects the source itself and distinguishes amongst your environments (Eg. formsort-prod or formsort-dev).
17+
4. Copy the Write key from the Segment UI and log in to your Formsort workspace - navigate to **Flows** > **Integrations** > **Segment** and paste the key.
18+
5. You can choose what events will be emitted by responders and change other settings.
19+
6. Press **Save** to connect.
20+
21+
## Events
22+
23+
The table below lists events that Formsort sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. The default behavior is for Formsort to pass the `responderUuid` associated with the user as the `userId`. This can be changed in the Formsort integration.
24+
25+
| Property Name | Description |
26+
| ------------- | -------------------------------------------------------------------------------------------------------------------------- |
27+
| EmailCollected | Responder's email was collected successfully, and the email has the data classification of "responder_email" |
28+
| FlowClosed | Responder clicked the exit button to leave the flow |
29+
| FlowFinalized | Responder has finished the flow and they are redirected or shown the completion screen |
30+
| FlowLoaded | Flow has finished loading |
31+
| PhoneCollected | Responder's phone number was collected successfully, and the phone number has the data classification of "responder_phone" |
32+
| StepCompleted | Responder completed the step |
33+
| StepLoaded | Step was loaded |
34+
| UrlOpened | Responder clicked a link and was redirected to a new URL |
35+
36+
## Event Properties
37+
38+
The following table lists event properties included with all events Segment receives from Formsort.
39+
40+
| Property Name | Description |
41+
| -------------- | -------------------------------- |
42+
| `event` | Flow event type |
43+
| `flowLabel` | Label of the flow |
44+
| `variantLabel` | Label of the variant |
45+
| `variantUuid` | UUID of the variant |
46+
| `responderUuid` | UUID of the responder |
47+
| `userId` | Identifying id for the responder |
48+
49+
This table lists event-specific properties Formsort sends to Segment:
50+
51+
| Property Name | Description |
52+
| ------------- | ----------------------------------------------------------------------------------- |
53+
| stepId | For step events, the name of the step |
54+
| stepIndex | For step events, the index of the step in the flow. |
55+
| msSpentOnStep | For StepCompleted events, the time in milliseconds the responder spent on the step. |
56+
57+
Optionally, form answers submitted by responders can also be included in events sent to Segment. If enabled, responder answers will appear in an `answers` object for each event.
58+
59+
## Adding Destinations
60+
61+
Now that your source is set up, you can connect it to destinations.
62+
63+
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.
64+
65+
If there are any issues with how the events are arriving to Segment, [contact the Formsort support team](mailto:[email protected]).

0 commit comments

Comments
 (0)