You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/sources/catalog/cloud-apps/iterable/index.md
+32-82Lines changed: 32 additions & 82 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,13 +12,13 @@ In your favorite BI or analytics tool, you'll be able to analyze all your cross-
12
12
13
13
## Getting Started
14
14
15
-
If you have previously enabled sending email events using the Iterable destination during our beta (using a project write key), you do not need to create new Iterable source. Your email data will continue to flow as normal.
15
+
If you have previously enabled sending email events using the Iterable destination during the beta period (using a project write key), you do not need to create new Iterable source. Your email data will continue to flow as normal.
16
16
17
17
1. From your workspace's `segment.com/<your-workspace>/sources` page, click **Add source**.
18
18
19
19
2. Choose Iterable.
20
20
21
-
3. 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 autopopulates the schema name. For example, the source name `Iterable` creates the schema `iterable`.
21
+
3. 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 `Iterable` creates the schema `iterable`.
22
22
23
23
4. The next page ("Overview") will surface your **Segment write key for Iterable.** Copy this write key.
24
24
@@ -34,91 +34,41 @@ That's it! As you send emails, events will now be sent to your destinations and
34
34
35
35
**Stream**
36
36
37
-
Iterable uses our stream Source component to send Segment email events. 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.
37
+
Iterable uses Segment's stream Source component to send Segment email events. 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.
38
38
39
39
The default behavior is for Iterable to pass the `userId` associated with the email recipient as the `userId`. There are cases in which Iterable does not have an associated `userId`, in which case the email address will be passed in as the `anonymousId`.
40
40
41
41
## Collections
42
42
43
-
Collections are the groupings of data we pull from your Source. In your warehouse, each collection gets its own table, as well as a `tracks` table that aggregates all the events into a single table.
43
+
Collections are the groupings of data Segment pulls from your Source. In your warehouse, each collection gets its own table, as well as a `tracks` table that aggregates all the events into a single table.
| Email Bounced | Event | The receiving server could not or would not accept message. |
48
+
| Email Delivered | Event | The message was successfully delivered to the receiving server. |
49
+
| Email Link Clicked | Event | The recipient clicked a link within the message. Enable Click Tracking to receive this event. |
50
+
| Email Marked as Spam | Event | The recipient marked message as spam. |
51
+
| Email Opened | Event | The recipient has opened the HTML message. Enable Open Tracking to receive event |
52
+
| Hosted Unsubscribe Click | Event | The user navigated to the email preference center through a `hostedUnsubscribeUrl` link. |
53
+
| In App Clicked | Event | An in-app click event indicates that a user tapped a link or button in an in-app message. |
54
+
| In App Delivered | Event | Indicates that an in-app message arrived on a user's device. It does not mean that the user viewed the message. |
55
+
| In App Opened | Event | Indicates that an in-app message displayed in an app, either because it appeared on arrival or because the user selected it in the inbox. |
56
+
| In App Sent | Event | Indicates that Iterable sent an in-app message to a user. It does not mean that the user received the message. |
57
+
| Mobile App Uninstalled | Event | Ghost message sent 12 hours after original push delivered results in rejection from receiving server. |
58
+
| Push Bounced | Event | The receiving server could not or would not accept message. |
59
+
| Push Delivered | Event | The message was successfully delivered to the receiving server. |
60
+
| Push Opened | Event | The user was shown a push notification by the client app. |
61
+
| SMS Bounced | Event | The receiving server could not or would not accept message. |
62
+
| SMS Clicked | Event | The user has clicked a link within an SMS message. |
63
+
| SMS Delivered | Event | The message was successfully delivered to the receiving server. |
64
+
| SMS Received | Event | The user has sent an inbound SMS that was received by server. |
65
+
| Subscribed | Event | The user subscribes to a messaging channel. |
66
+
| Unsubscribed | Event | The recipient clicked a on message's subscription management link. |
67
+
| Web Push Clicked | Event | The user clicked on a web push notification. |
68
+
| Web Push Delivered | Event | A web Push was successfully delivered to the receiving server. |
69
+
70
+
44
71
45
-
<table>
46
-
<tr>
47
-
<td>**Collection**</td>
48
-
<td>**Type**</td>
49
-
<td>**Description**</td>
50
-
</tr>
51
-
<tr>
52
-
<td>Email Delivered</td>
53
-
<td>Event</td>
54
-
<td>Message has been successfully delivered to the receiving server</td>
55
-
</tr>
56
-
<tr>
57
-
<td>Email Opened</td>
58
-
<td>Event</td>
59
-
<td>Recipient has opened the HTML message. You need to enable Open Tracking for getting this type of event</td>
60
-
</tr>
61
-
<tr>
62
-
<td>Email Bounced</td>
63
-
<td>Event</td>
64
-
<td>Receiving server could not or would not accept message</td>
65
-
</tr>
66
-
<tr>
67
-
<td>Email Link Clicked</td>
68
-
<td>Event</td>
69
-
<td>Recipient clicked on a link within the message. You need to enable Click Tracking for getting this type of event</td>
70
-
</tr>
71
-
<tr>
72
-
<td>Email Subscribed</td>
73
-
<td>Event</td>
74
-
<td>User subscribes to a messaging channel</td>
75
-
</tr>
76
-
<tr>
77
-
<td>Email Unsubscribed</td>
78
-
<td>Event</td>
79
-
<td>Recipient clicked on message's subscription management link</td>
80
-
</tr>
81
-
<tr>
82
-
<td>Email Marked as Spam</td>
83
-
<td>Event</td>
84
-
<td>Recipient marked message as spam</td>
85
-
</tr>
86
-
<tr>
87
-
<td>Push Delivered</td>
88
-
<td>Event</td>
89
-
<td>Message has been successfully delivered to the receiving server</td>
90
-
</tr>
91
-
<tr>
92
-
<td>Push Opened</td>
93
-
<td>Event</td>
94
-
<td>User has been shown push notification by client app</td>
95
-
</tr>
96
-
<tr>
97
-
<td>Push Bounced</td>
98
-
<td>Event</td>
99
-
<td>Receiving server could not or would not accept message</td>
100
-
</tr>
101
-
<tr>
102
-
<td>Mobile App Uninstalled</td>
103
-
<td>Event</td>
104
-
<td>Ghost message sent 12 hours after original push delivered results in rejection from receiving server</td>
105
-
</tr>
106
-
<tr>
107
-
<td>SMS Send</td>
108
-
<td>Event</td>
109
-
<td>Message has been successfully delivered to the receiving server</td>
110
-
</tr>
111
-
<tr>
112
-
<td>SMS Bounced</td>
113
-
<td>Event</td>
114
-
<td>Receiving server could not or would not accept message</td>
115
-
</tr>
116
-
<tr>
117
-
<td>SMS Received</td>
118
-
<td>Event</td>
119
-
<td>User has sent an inbound SMS that was received by server</td>
120
-
</tr>
121
-
</table>
122
72
123
73
<!-- Example: To query the Email Delivered table, you'd write a query like this:
124
74
@@ -133,4 +83,4 @@ from iterable.email_delivered
133
83
134
84
## Send data to Iterable
135
85
136
-
The Iterable Source works better when you also connect Iterable as a destination. With the Iterable **Destination**, you can use Segment to send Iterable user and event data from which you trigger email campaigns. Want to start sending website or mobile data **_TO_** Iterable? Head on over to our[Iterable destination docs](/docs/connections/destinations/catalog/iterable/).
86
+
The Iterable Source works better when you also connect Iterable as a destination. With the Iterable **Destination**, you can use Segment to send Iterable user and event data from which you trigger email campaigns. For more information, see the[Iterable destination docs](/docs/connections/destinations/catalog/iterable/).
0 commit comments