- Getting started
- Account management
- Security
- Destinations
- Integrations
- SaaS
- Overview
- 3PL Central
- ActiveCampaign
- AdRoll
- Amplitude
- AppsFlyer
- Asana
- Autopilot
- BigCommerce
- Braintree
- Bronto
- Campaign Manager
- Campaign Monitor
- Chargebee
- Chargify
- CircleCI
- Close.io
- Club Speed
- Codat
- COVID-19 Public Data
- Crossbeam
- Darksky
- Deputy
- Desk
- Dixa
- Doorbell.io
- eBay
- Eloqua
- Facebook Ads
- Freshdesk
- Front
- FullStory
- GitHub
- GitLab
- Google Ads
- Google Ads (AdWords)
- Google Analytics
- Google Analytics (AdWords)
- Google Analytics 360
- Google Analytics 4
- Google ECommerce
- Google Search Console
- Google Sheets
- Harvest
- Harvest Forecast
- Heap
- Help Scout
- HubSpot
- iLEVEL
- Impact
- Intacct
- Intercom
- Invoiced
- Iterable
- JIRA
- Klaviyo
- Kustomer
- Lever
- LinkedIn Ads
- Listrak
- LivePerson
- Looker
- LookML
- MailChimp
- Mailshake
- Mambu
- Marketo
- Microsoft Advertising
- Microsoft Teams
- Mixpanel
- NetSuite
- NetSuite Suite Analytics
- Onfleet
- Outbrain
- Outreach
- Pardot
- Pendo
- Pepperjam
- Pipedrive
- Quick Base
- QuickBooks
- Recharge
- Recurly
- Referral SaaSquatch
- Revinate
- RingCentral
- SaaSOptics
- Sailthru
- Salesforce
- Salesforce Marketing Cloud
- Selligent
- SendGrid Core
- ShipHero
- Shippo
- Shopify
- Slack
- Snapchat Ads
- Square
- Stripe
- SurveyMonkey
- Taboola
- TikTok Ads
- Toggl
- Trello
- Twilio
- Twitter Ads
- Typeform
- UJET
- Urban Airship
- UserVoice
- Wootric
- Workday RaaS
- Xero
- Yotpo
- Zendesk Chat
- Zendesk Support
- Zoom
- Zuora
- Databases
- Overview
- Amazon Aurora MySQL RDS
- Amazon Aurora PostgreSQL RDS
- Amazon DynamoDB
- Amazon Microsoft SQL Server RDS
- Amazon MySQL RDS
- Amazon Oracle RDS
- Amazon PostgreSQL RDS
- Amazon S3 CSV
- Google CloudSQL MySQL
- Google CloudSQL PostgreSQL
- Heroku
- Magento
- MariaDB
- Microsoft Azure MySQL
- Microsoft Azure SQL Database
- Microsoft SQL Server
- MongoDB
- MongoDB Atlas
- MySQL
- Oracle
- PostgreSQL
- Responsys
- SFTP
- Webhooks
- All integrations
- Connection cloning
- Connect other data sources
- SaaS
- Extracting data
- Loading data
- Analysis tools
- Troubleshooting
- Developers
- Changelog
Get started with a free trial today
Already have an account? Sign in
Mailshake (v1)
Mailshake is currently in beta. The info in this guide is subject to change.
This integration is powered bySinger's Mailshake tap. For support,visit the GitHub repo orjoin the Singer Slack.
Mailshake integration summary
Stitch’s Mailshake integration replicates data using the . Refer to theSchema section for a list of objects available for replication.
Mailshake feature snapshot
A high-level look at Stitch's Mailshake (v1) integration, including release status, useful links, and the features supported in Stitch.
| STITCH | |||
| Release status | Beta | Supported by | |
| Stitch plan | Standard | API availability | Available |
| Singer GitHub repository | |||
| REPLICATION SETTINGS | |||
| Anchor Scheduling | Supported | Advanced Scheduling | Supported |
| Table-level reset | Unsupported | Configurable Replication Methods | Unsupported |
| DATA SELECTION | |||
| Table selection | Supported | Column selection | Supported |
| Select all | Supported | ||
| TRANSPARENCY | |||
| Extraction Logs | Supported | Loading Reports | Supported |
Connecting Mailshake
Step 1: Retrieve your Mailshake API key
- Sign into your Mailshake account.
- ClickExtensions > API.
If your account already has an API key, it will display in theYour Access section of the page.
Otherwise, click theCreate API Key button. Your API key will display on the page.
Keep this page open - you’ll need it to complete the next step.
Step 2: Add Mailshake as a Stitch data source
- Sign into your Stitch account.
On the Stitch Dashboard page, click theAdd Integration button.
Click theMailshake icon.
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Mailshake” would create a schema called
stitch_mailshakein the destination.Note: Schema names cannot be changed after you save the integration.- In theAPI Key field, paste the Mailshake API key you retrieved inStep 1.
Step 3: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Mailshake integration. This means that dataequal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond Mailshake’s default setting of1 year. For a detailed look at historical replication jobs, check out theSyncing Historical SaaS Data guide.
Step 4: Create a replication schedule
In theReplication Frequency section, you’ll create the integration’sreplication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Mailshake integrations support the following replication scheduling methods:
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See theUnderstanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate.Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For Mailshake integrations, you can select:
Individual tables and columns
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’sTables to Replicate tab, locate a table you want to replicate.
To track a table, click thecheckbox next to the table’s name. A blue checkmark means the table is set to replicate.
To track a column, click thecheckbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click theFinalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
Click theTables to Replicate tab.
- In the list of tables, click the box next to theTable Names column.
In the menu that displays, clickTrack all Tables and Fields:
- Click theFinalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up Mailshake, itsSync Status may show asPending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, aPending status indicates that Stitch is in the process of scheduling the initial replication job for the integration.This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to theAnchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Mailshake table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is forversion 1 of this integration.
This is the latest version of the Mailshake integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs >customers), while case is maintained in PostgreSQL destinations (CusTomERs >CusTomERs). Refer to theLoading Guide for your destination for more info.
campaigns
Thecampaigns table contains info about your team’s campaigns.
Key-based Incremental | |
Primary Key | id |
Replication Key | created |
| Useful links |
| Join campaigns with | on |
|---|---|
| clicks | campaigns.id = clicks.campaign.id campaigns.messages.id = clicks.campaign.id campaigns.messages.id = clicks.parent.message.id |
| leads | campaigns.id = leads.campaign.id campaigns.messages.id = leads.campaign.id |
| opens | campaigns.id = opens.campaign.id campaigns.messages.id = opens.campaign.id campaigns.messages.id = opens.parent.message.id |
| recipients | campaigns.id = recipients.campaignId campaigns.messages.id = recipients.campaignId |
| replies | campaigns.id = replies.campaign.id campaigns.messages.id = replies.campaign.id campaigns.messages.id = replies.parent.message.id |
| sent_messages | campaigns.id = sent_messages.campaign.id campaigns.messages.id = sent_messages.campaign.id campaigns.messages.id = sent_messages.message.id |
| senders | campaigns.sender.id = senders.id |
actionDate DATE-TIME | |||||||
archived BOOLEAN | |||||||
created DATE-TIME | |||||||
endedAt DATE-TIME | |||||||
id INTEGER | |||||||
isPaused BOOLEAN | |||||||
messages ARRAY
| |||||||
object STRING | |||||||
sender OBJECT
| |||||||
title STRING | |||||||
url STRING |
clicks
Theclicks table contains info about recent click activity.
Key-based Incremental | |
Primary Key | id |
Replication Key | actionDate |
| Useful links |
| Join clicks with | on |
|---|---|
| campaigns | clicks.campaign.id = campaigns.id clicks.campaign.id = campaigns.messages.id clicks.parent.message.id = campaigns.messages.id |
| leads | clicks.campaign.id = leads.campaign.id clicks.recipient.id = leads.recipient.id |
| opens | clicks.campaign.id = opens.campaign.id clicks.parent.message.id = opens.parent.message.id clicks.recipient.id = opens.recipient.id |
| recipients | clicks.campaign.id = recipients.campaignId clicks.recipient.id = recipients.id |
| replies | clicks.campaign.id = replies.campaign.id clicks.parent.message.id = replies.parent.message.id clicks.recipient.id = replies.parent.message.id |
| sent_messages | clicks.campaign.id = sent_messages.campaign.id clicks.parent.message.id = sent_messages.message.id clicks.recipient.id = sent_messages.recipient.id |
actionDate DATE-TIME | ||||||||||
campaign OBJECT
| ||||||||||
id INTEGER | ||||||||||
isDuplicate BOOLEAN | ||||||||||
link STRING | ||||||||||
object STRING | ||||||||||
parent OBJECT
| ||||||||||
recipient OBJECT
|
leads
Theleads table contains info about the leads in your Mailshake account.
Key-based Incremental | |
Primary Key | id |
Replication Key | created |
| Useful links |
| Join leads with | on |
|---|---|
| campaigns | leads.campaign.id = campaigns.id leads.campaign.id = campaigns.messages.id |
| clicks | leads.campaign.id = clicks.campaign.id leads.recipient.id = clicks.recipient.id |
| opens | leads.campaign.id = opens.campaign.id leads.recipient.id = opens.recipient.id |
| recipients | leads.campaign.id = recipients.campaignId leads.recipient.id = recipients.id |
| replies | leads.campaign.id = replies.campaign.id leads.recipient.id = replies.parent.message.id |
| sent_messages | leads.campaign.id = sent_messages.campaign.id leads.recipient.id = sent_messages.recipient.id |
| team_members | leads.assignedTo.id = team_members.id |
assignedTo OBJECT
| ||||||||
campaign OBJECT
| ||||||||
created DATE-TIME | ||||||||
id INTEGER | ||||||||
lastStatusChangeDate DATE-TIME | ||||||||
object STRING | ||||||||
openedDate DATE-TIME | ||||||||
recipient OBJECT
| ||||||||
status STRING |
opens
Theopens table contains info about recently opened emails.
Key-based Incremental | |
Primary Key | id |
Replication Key | actionDate |
| Useful links |
| Join opens with | on |
|---|---|
| campaigns | opens.campaign.id = campaigns.id opens.campaign.id = campaigns.messages.id opens.parent.message.id = campaigns.messages.id |
| clicks | opens.campaign.id = clicks.campaign.id opens.parent.message.id = clicks.parent.message.id opens.recipient.id = clicks.recipient.id |
| leads | opens.campaign.id = leads.campaign.id opens.recipient.id = leads.recipient.id |
| recipients | opens.campaign.id = recipients.campaignId opens.recipient.id = recipients.id |
| replies | opens.campaign.id = replies.campaign.id opens.parent.message.id = replies.parent.message.id opens.recipient.id = replies.parent.message.id |
| sent_messages | opens.campaign.id = sent_messages.campaign.id opens.parent.message.id = sent_messages.message.id opens.recipient.id = sent_messages.recipient.id |
actionDate DATE-TIME | ||||||||||
campaign OBJECT
| ||||||||||
id INTEGER | ||||||||||
isDuplicate BOOLEAN | ||||||||||
object STRING | ||||||||||
parent OBJECT
| ||||||||||
recipient OBJECT
|
recipients
Therecipients table contains info about the recipients in a campaign.
Key-based Incremental | |
Primary Key | id |
Replication Key | created |
| Useful links |
| Join recipients with | on |
|---|---|
| campaigns | recipients.campaignId = campaigns.id recipients.campaignId = campaigns.messages.id |
| clicks | recipients.campaignId = clicks.campaign.id recipients.id = clicks.recipient.id |
| leads | recipients.campaignId = leads.campaign.id recipients.id = leads.recipient.id |
| opens | recipients.campaignId = opens.campaign.id recipients.id = opens.recipient.id |
| replies | recipients.campaignId = replies.campaign.id recipients.id = replies.parent.message.id |
| sent_messages | recipients.campaignId = sent_messages.campaign.id recipients.id = sent_messages.recipient.id |
action STRING |
campaignId INTEGER |
created DATE-TIME |
emailAddress STRING |
fields OBJECT |
first STRING |
fullName STRING |
id INTEGER |
last STRING |
object STRING |
replies
Thereplies table contains info about recent replies to your emails.
Key-based Incremental | |
Primary Key | id |
Replication Key | actionDate |
| Useful links |
| Join replies with | on |
|---|---|
| campaigns | replies.campaign.id = campaigns.id replies.campaign.id = campaigns.messages.id replies.parent.message.id = campaigns.messages.id |
| clicks | replies.campaign.id = clicks.campaign.id replies.parent.message.id = clicks.parent.message.id replies.parent.message.id = clicks.recipient.id |
| leads | replies.campaign.id = leads.campaign.id replies.parent.message.id = leads.recipient.id |
| opens | replies.campaign.id = opens.campaign.id replies.parent.message.id = opens.parent.message.id replies.parent.message.id = opens.recipient.id |
| recipients | replies.campaign.id = recipients.campaignId replies.parent.message.id = recipients.id |
| sent_messages | replies.campaign.id = sent_messages.campaign.id replies.parent.message.id = sent_messages.message.id replies.parent.message.id = sent_messages.recipient.id |
actionDate DATE-TIME | ||||||||||
body STRING | ||||||||||
campaign OBJECT
| ||||||||||
externalConversationID STRING | ||||||||||
externalID STRING | ||||||||||
externalRawMessageID STRING | ||||||||||
id INTEGER | ||||||||||
object STRING | ||||||||||
parent OBJECT
| ||||||||||
plainTextBody STRING | ||||||||||
rawBody STRING | ||||||||||
recipient OBJECT
| ||||||||||
subject STRING | ||||||||||
type STRING |
senders
Thesenders table contains info about your team’s senders.
Key-based Incremental | |
Primary Key | id |
Replication Key | created |
| Useful links |
| Join senders with | on |
|---|---|
| campaigns | senders.id = campaigns.sender.id |
created DATE-TIME |
emailAddress STRING |
fromName STRING |
id STRING |
object STRING |
offerType STRING |
sent_messages
Thesent_messages table contains info about recently sent emails.
Key-based Incremental | |
Primary Key | id |
Replication Key | actionDate |
| Useful links |
| Join sent_messages with | on |
|---|---|
| campaigns | sent_messages.campaign.id = campaigns.id sent_messages.campaign.id = campaigns.messages.id sent_messages.message.id = campaigns.messages.id |
| clicks | sent_messages.campaign.id = clicks.campaign.id sent_messages.message.id = clicks.parent.message.id sent_messages.recipient.id = clicks.recipient.id |
| leads | sent_messages.campaign.id = leads.campaign.id sent_messages.recipient.id = leads.recipient.id |
| opens | sent_messages.campaign.id = opens.campaign.id sent_messages.message.id = opens.parent.message.id sent_messages.recipient.id = opens.recipient.id |
| recipients | sent_messages.campaign.id = recipients.campaignId sent_messages.recipient.id = recipients.id |
| replies | sent_messages.campaign.id = replies.campaign.id sent_messages.message.id = replies.parent.message.id sent_messages.recipient.id = replies.parent.message.id |
actionDate DATE-TIME | ||||||||||
body STRING | ||||||||||
campaign OBJECT
| ||||||||||
externalConversationID STRING | ||||||||||
externalID STRING | ||||||||||
externalRawMessageID STRING | ||||||||||
from OBJECT
| ||||||||||
id INTEGER | ||||||||||
message OBJECT
| ||||||||||
object STRING | ||||||||||
plainTextBody STRING | ||||||||||
rawBody STRING | ||||||||||
recipient OBJECT
| ||||||||||
subject STRING | ||||||||||
to ARRAY
| ||||||||||
type STRING |
team_members
Theteam_members table contains info about the individual members of your team.
Key-based Incremental | |
Primary Key | id |
Replication Key | teamID |
| Useful links |
| Join team_members with | on |
|---|---|
| leads | team_members.id = leads.assignedTo.id |
emailAddress STRING |
first STRING |
fullName STRING |
id INTEGER |
isDisabled BOOLEAN |
isTeamAdmin BOOLEAN |
last STRING |
object STRING |
teamBlockedDate DATE-TIME |
teamID INTEGER |
teamName BOOLEAN |
| Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free tosubmit a pull request with your suggestions,open an issue on GitHub, orreach out to us.