Skip to content

Commit 3b87953

Browse files
tcgilbertmarkzegarelli
andauthored
Add docs for new Insider source (#3870)
* Add docs for new Insider source * edits Co-authored-by: markzegarelli <[email protected]>
1 parent 8644e96 commit 3b87953

File tree

1 file changed

+89
-0
lines changed
  • src/connections/sources/catalog/cloud-apps/insider

1 file changed

+89
-0
lines changed
Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
title: Insider Source
3+
id: pNvQ9udVMy
4+
---
5+
6+
[Insider](https://useinsider.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) Growth Management Platform (GMP) helps digital marketers drive growth across the funnel. Insider GMP helps marketers deliver personalized journeys across the web, mobile web, mobile apps, messaging, email, and ad channels using the unified data.
7+
8+
Take your company’s marketing analysis to the next level by adding Insider as a Source to Segment. Insider will automatically collect cross-channel messaging channel events like `Email Clicked`, `App Push Opened` and `SMS Clicked`, forward them to your destinations and load them into your data warehouse.
9+
10+
This source is maintained by Insider. For any issues with the source,[contact Insider Support team](mailto:[email protected]).
11+
12+
## Getting Started
13+
14+
1. From the [Source catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**.
15+
2. Search for **Insider** in the Sources Catalog, select click Insider, and click **Add Source**.
16+
3. On the next screen, give the Source a name and add any labels to help you organize and filter your sources. You can give the source any name, but Segment recommends a name that reflects the source itself, as this name auto-populates the schema name. For example, the source name `Insider` creates the schema `insider`.
17+
4. Click **Add Source** to save your settings.
18+
5. After configuring settings, contact your Insider Customer Success Manager to set up the Segment Source Integration using your writekey.
19+
20+
## Components
21+
22+
**Stream**
23+
24+
Insider 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.
25+
26+
The default behavior is for Insider to pass the `uuid` (unique user ID) associated with the user as the `userId`. This is the same `userId` that Insider originally receives from the downstream destination with Segment. You can easily change the identity attribute to `email`, `phone number`, `uuid`, or any _custom attribute_. If the selected identifier is not present or you want to pass additional identifier under `anonymousID`, Insider is capable of sending a secondary selected identifier as `anonymousID`.
27+
28+
## Events
29+
30+
The table below lists events that Insider sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations.
31+
32+
33+
| Event Name | Event Description |
34+
| ---------------------------- | ------------------------------------------------------------------------- |
35+
| Email Delivered | An email was successfully delivered to user. |
36+
| Email Open | User opened the email campaign. |
37+
| Email Clicked | User clicked a link in the email campaign. |
38+
| Email Bounced | User’s receiving mail server did not accept it. |
39+
| Email Unsubscribe | User no longer wants to receive marketing emails. |
40+
| WhatsApp Reply | User clicked any button in WhatsApp Message. |
41+
| WhatsApp Reply First Button | User clicked the first quick reply button. |
42+
| WhatsApp Reply Second Button | User clicked the second quick reply button. |
43+
| WhatsApp Reply Third Button | User clicked the third quick reply button. |
44+
| WhatsApp Reply Auto Reply | User replied to WhatsApp message in a template that includes quick reply. |
45+
| WhatsApp Reply Other Reply | User replied to WhatsApp message in any template. |
46+
| WhatsApp Opt Out | User no longer wants to receive marketing WhatsApp marketing messages. |
47+
| SMS Click | User clicked a link in the SMS message. |
48+
| SMS Delivered | An SMS was successfully delivered to user. |
49+
| SMS Unsubscribe | User no longer wants to receive marketing SMS marketing messages. |
50+
| Journey Enter | User entered a Journey. |
51+
| Journey Exited | User exited from a Journey. |
52+
| InApp Seen | User has seen the InApp campaign. |
53+
| Push Delivered | App Push message delivered to user. |
54+
| Push Session | User clicked an App Push. |
55+
| Session Start From Push | App is opened by clicking an App Push |
56+
| Session Start | Every time App is opened |
57+
| Lead Collected | A new lead has been collected. |
58+
59+
60+
> info ""
61+
> Insider sends any custom events you define to Segment for use in downstream tools.
62+
63+
## Event Properties
64+
65+
The table below list the properties included in the events listed above.
66+
67+
| Parameter Name | Description |
68+
| --------------- | ------------------------------------------------------------------------------- |
69+
| `campaign_id` | ID of the campaign |
70+
| `campaign_name` | Name of the campaign |
71+
| `ip_address` | IP address of the user |
72+
| `user_agent` | The user agent responsible for the event. This is usually a web browser. |
73+
| `variation_id` | Variation ID of a campaign |
74+
| `journey_id` | ID of the journey users entered. Used in the Events segment, and Exit Criteria. |
75+
| `variant_id` | Variant ID of a campaign. |
76+
| `name` | Name of the journey users entered. |
77+
| `reason` | The reason of the Journey Enter event. |
78+
79+
> info ""
80+
> Insider sends any custom event parameters you define to Segment for use in downstream tools.
81+
82+
83+
## Adding Destinations
84+
85+
Now that your Source is set up, you can connect it with Destinations.
86+
87+
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.
88+
89+
If there are any issues with how the events are arriving to Segment, [contact the Insider support team](mailto:[email protected]).

0 commit comments

Comments
 (0)