Skip to content

Commit 254eb2b

Browse files
committed
Mailmodo source documentation
1 parent 8850076 commit 254eb2b

File tree

1 file changed

+158
-0
lines changed
  • src/connections/sources/catalog/cloud-apps/mailmodo-source

1 file changed

+158
-0
lines changed
Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
2+
## Mailmodo Source
3+
4+
5+
[Mailmodo](https://www.mailmodo.com) is an email marketing platform that helps you create interactive emails powered by AMP. With our no-code editor, you can create interactive email in minutes and send engaging and personalized emails that boost conversions.
6+
7+
This source is maintained by Mailmodo. For any issues with the source, [contact their Support team](mailto:[email protected]).
8+
9+
10+
## Getting Started
11+
12+
#### Step 1: Add a new Mailmodo Source to Segment
13+
1. From your workspace’s [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click Add Source.
14+
2. Search for “Mailmodo” in the Sources Catalog, select click Mailmodo, and click Add Source.
15+
3. On the next screen, give the Source a nickname and configure any other settings.
16+
4. 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 it amongst your environments (e.g. Mailmodo_Campaigns).
17+
5. Click Add Source to save your settings.
18+
6. Copy the Write key from the Segment UI. You will need to input this key on the Mailmodo integration page.
19+
20+
#### Step 2: Enter connection details on Mailmodo
21+
1. Look for the Segment Source option on the Mailmodo Integration page. Click on the "Click to configure" option
22+
2. Enter your Write Key copied from Step 1 and select a Segment Region
23+
3. Click on "Test and Save" to complete the setup.
24+
4. If the provided write key is valid, Mailmodo will now act as a Segment source. To confirm the same, you can check the source debugger within Segment to see if the event arrived.
25+
26+
#### Step 3: Adding destination to Mailmodo Source
27+
Now that your Source is set up, you can connect it with Destinations.
28+
29+
30+
Log in to your downstream tools and make sure that the events are populating in your Debugger and that they contain all of the properties you expect. If something isn’t working as you expect, see the Destination docs for troubleshooting.
31+
32+
33+
If there are problems with how the events arrive at Segment, [contact the Mailmodo Support team]((mailto:[email protected])).
34+
35+
## Events
36+
37+
The following table lists events that Mailmodo sends to Segment. These events show up as tables in your Warehouse and as regular events in your other Destinations. Mailmodo will send campaign activity data only for those contacts for whom we have received identify calls previously from Segment.
38+
39+
<table>
40+
<tr>
41+
<td>Event Name</td>
42+
<td>Description</td>
43+
</tr>
44+
<tr>
45+
<td>Email Sent</td>
46+
<td>An email was successfully sent.</td>
47+
</tr>
48+
<tr>
49+
<td>Email Opened</td>
50+
<td>Contact opened an email.</td>
51+
</tr>
52+
<tr>
53+
<td>Link Clicked</td>
54+
<td>Contact clicked a link in an email.</td>
55+
</tr>
56+
<tr>
57+
<td>Email Form Submitted</td>
58+
<td>Contact submitted form or widget in an email.</td>
59+
</tr>
60+
<tr>
61+
<td>Email Marked as Spam</td>
62+
<td>Contact marked an email as spam.</td>
63+
</tr>
64+
<tr>
65+
<td>Email Bounced</td>
66+
<td>Contact email was bounced.</td>
67+
</tr>
68+
<tr>
69+
<td>Email Unsubscribed</td>
70+
<td>Contact unsubscribed from the email.</td>
71+
</tr>
72+
</table>
73+
74+
## Event Properties
75+
76+
This table lists event-specific properties Mailmodo sends to Segment:
77+
78+
<table>
79+
<tr>
80+
<td>Property Name</td>
81+
<td>Description</td>
82+
</tr>
83+
<tr>
84+
<td>email_id</td>
85+
<td>The guid of email address identifier stored in the Mailmodo system</td>
86+
</tr>
87+
<tr>
88+
<td>email_subject</td>
89+
<td> The subject line used for the email campaign</td>
90+
</tr>
91+
<tr>
92+
<td>email_type</td>
93+
<td>The email type used for the template</td>
94+
</tr>
95+
<tr>
96+
<td>template_id</td>
97+
<td>The unique identifier for the template</td>
98+
</tr>
99+
<tr>
100+
<td>template_name</td>
101+
<td> The name of the template used in the campaign</td>
102+
</tr>
103+
<tr>
104+
<td>campaign_id</td>
105+
<td> The unique identifier for the campaign</td>
106+
</tr>
107+
<tr>
108+
<td>campaign_name</td>
109+
<td>The name of the campaign</td>
110+
</tr>
111+
<tr>
112+
<td>campaign_type</td>
113+
<td> The value represents the type of campaign. Value can be - CONTACT_LIST (for the bulk campaign) or TRIGGERED (for the triggered campaign)</td>
114+
</tr>
115+
<tr>
116+
<td>campaign_trigger_source</td>
117+
<td>Applicable only for triggered campaigns. This field highlights the source of the triggered campaign (e.g. Journey, Rest API, etc.) </td>
118+
</tr>
119+
<tr>
120+
<td>apple_privacy_open</td>
121+
<td> Applicable only for email open events. This field informs whether the contact has opened the email on the Apple Mail client. The value can be true or false. </td>
122+
</tr>
123+
<tr>
124+
<td>link_id</td>
125+
<td> The unique identifier for the link in the template</td>
126+
</tr>
127+
<tr>
128+
<td>link_url</td>
129+
<td>The actual URL link in the template</td>
130+
</tr>
131+
<tr>
132+
<td>form_id</td>
133+
<td> The unique identifier of the form or widget submitted in the email </td>
134+
</tr>
135+
<tr>
136+
<td>form_name</td>
137+
<td> The name of the form or widget submitted in the email</td>
138+
</tr>
139+
<tr>
140+
<td>submission_type</td>
141+
<td> This field informs whether the submission was made via AMP or the web (aka HTML fallback)</td>
142+
</tr>
143+
<tr>
144+
<td>reason</td>
145+
<td> The field provides the reason for unsubscribed or bounced. </td>
146+
</tr>
147+
<tr>
148+
<td>is_hard_bounce</td>
149+
<td>The field informs if the bounce was a hard bounce. </td>
150+
</tr>
151+
</table>
152+
153+
## Sending Data To Mailmodo
154+
155+
The Mailmodo Source works only when you also connect Mailmodo as a Destination. With the Mailmodo Destination, you can use Segment to send identify and track calls to Mailmodo so you can target customers with interactive emails.
156+
157+
158+
Want to start sending data to Mailmodo? Learn how by reading the [Mailmodo Destination docs](https://support.mailmodo.com/en/support/solutions/articles/84000351518).

0 commit comments

Comments
 (0)