Skip to content

Commit 8c2fd50

Browse files
albert-yualbert-yu
committed
Add navattic source doc
1 parent 4dddace commit 8c2fd50

File tree

1 file changed

+116
-2
lines changed
  • src/connections/sources/catalog/cloud-apps/navattic

1 file changed

+116
-2
lines changed

‎src/connections/sources/catalog/cloud-apps/navattic/index.md

Lines changed: 116 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,118 @@
11
---
2-
title: 'Navattic Source'
2+
title: "Navattic Source"
33
hidden: true
4-
---
4+
---
5+
6+
[Navattic](https://navattic.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a no-code tool which enables go-to-market teams to build beautiful, interactive demos of their products to excite and engage prospects.
7+
8+
This source is maintained by Navattic. For any issues with the source, [contact their Support team](mailto:[email protected]).
9+
10+
## Getting Started
11+
12+
> (delete after reading) Include clear, succinct steps including hyperlinks to where customers can locate the place in your app to enter their Segment writekey.
13+
14+
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**.
15+
2. Search for "Navattic" in the Sources Catalog, select Navattic, and click **Add Source**.
16+
3. On the next screen, give the Source a nickname configure any other settings.
17+
18+
- The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname 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).
19+
20+
4. Click **Add Source** to save your settings.
21+
5. Copy the Write key from the Segment UI and log in to your Navattic account - navigate to Integrations > Segment and paste the key. Hit "Save" to connect.
22+
6. Choose which Navattic events to send to Segment, as well as which demos (projects) to activate for this integration.
23+
24+
## Stream
25+
26+
Navattic uses our stream Source component to send Segment event data. It uses a server-side `track`, and `identify` methods 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.
27+
28+
Navattic generates its own ID for each visitor to your product demo. This ID will be passed as both the `userId` and `anonymousId` when pushing Navattic events to Segment.
29+
30+
## Events
31+
32+
The table below lists possible events that Navattic sends to Segment. With the exception of IDENTIFY_USER, all events are sent to the [Tracks table in Segment](https://segment.com/docs/connections/storage/warehouses/schema/#tracks-table). Additionally, every Navattic includes the `userId` and `anonymousId` (which are the same), which are Navattic-generated for each user.
33+
34+
<table>
35+
<tr>
36+
<td>Event Name</td>
37+
<td>Description</td>
38+
</tr>
39+
<tr>
40+
<td>IDENTIFY_USER</td>
41+
<td>A visitor submitted an email, usually through a form fill. This sends to the <a href="https://segment.com/docs/connections/storage/warehouses/schema/#identifies-table">Identifies table in Segment</a>.</td>
42+
</tr>
43+
<tr>
44+
<td>VIEW_STEP</td>
45+
<td>A visitor viewed a step in the demo</td>
46+
</tr>
47+
<tr>
48+
<td>START_FLOW</td>
49+
<td>A visitor started a flow</td>
50+
</tr>
51+
<tr>
52+
<td>COMPLETE_FLOW</td>
53+
<td>A visitor has completed a flow</td>
54+
</tr>
55+
<tr>
56+
<td>NAVIGATE</td>
57+
<td>A visitor clicked on a link from within the demo</td>
58+
</tr>
59+
<tr>
60+
<td>OPEN_CHECKLIST</td>
61+
<td>A visitor expanded a checklist</td>
62+
</tr>
63+
<tr>
64+
<td>CLOSE_CHECKLIST</td>
65+
<td>A visitor collapsed a checklist</td>
66+
</tr>
67+
<tr>
68+
<td>COMPLETE_TASK</td>
69+
<td>A visitor completed a checklist task</td>
70+
</tr>
71+
<tr>
72+
<td>CONVERTED</td>
73+
<td>A visitor viewed a step tagged "Mark as converted"</td>
74+
</tr>
75+
</table>
76+
77+
## Event Properties
78+
79+
The table below list the properties included in the events listed above.
80+
81+
<table>
82+
<tr>
83+
<td>Property Name</td>
84+
<td>Description</td>
85+
</tr>
86+
<tr>
87+
<td>project</td>
88+
<td>An object containing the demo's (project's) ID and name.</td>
89+
</tr>
90+
<tr>
91+
<td>checklist</td>
92+
<td>An object containing the checklist's ID and name. Populated only if the demo contains a checklist</td>
93+
</tr>
94+
<tr>
95+
<td>flow</td>
96+
<td>An object containing the current flow's ID and name.</td>
97+
</tr>
98+
<tr>
99+
<td>step</td>
100+
<td>An object containing the current flow step's ID, name, and index (<code>step.indx</code>)</td>
101+
</tr>
102+
<tr>
103+
<td>session_id</td>
104+
<td>A string that uniquely identifies this visitor's current session</td>
105+
</tr>
106+
<tr>
107+
<td>url</td>
108+
<td>If the event is NAVIGATE, then this property contains the URL of the link that the visitor clicked on. Otherwise, it is empty.</td>
109+
</tr>
110+
</table>
111+
112+
## Adding Destinations
113+
114+
Now that your Source is set up, you can connect it with Destinations.
115+
116+
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](https://segment.com/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.
117+
118+
If there are any issues with how the events are arriving to Segment, [contact the Navattic support team](mailto:[email protected]).

0 commit comments

Comments
 (0)