Mailshake integration summary

Stitch’s Mailshake integration replicates data using the . Refer to the Schema 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

Singer Community

Stitch plan

Standard

API availability

Available

Singer GitHub repository

singer-io/tap-mailshake

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

  1. Sign into your Mailshake account.
  2. Click Extensions > API.
  3. If your account already has an API key, it will display in the Your Access section of the page.

    Otherwise, click the Create 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

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Mailshake icon.

  4. 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_mailshake in the destination. Note: Schema names cannot be changed after you save the integration.

  5. In the API Key field, paste the Mailshake API key you retrieved in Step 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 data equal 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 of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 4: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication 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:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding 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:

  1. Individual tables and columns

  2. All tables and columns

Click the tabs to view instructions for each selection method.

  1. In the integration’s Tables to Replicate tab, locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
  1. Click into the integration from the Stitch Dashboard page.
  2. Click the Tables to Replicate tab.

  3. In the list of tables, click the box next to the Table Names column.
  4. In the menu that displays, click Track all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab

  5. Click the Finalize 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, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

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

campaigns

The campaigns table contains info about your team’s campaigns.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

created

Useful links

campaigns schema on GitHub

Mailshake API method

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

campaignId

INTEGER

id

INTEGER

isPaused

BOOLEAN

object

STRING

replyToID

INTEGER

subject

STRING

type

STRING

object

STRING

sender

OBJECT

created

DATE-TIME

emailAddress

STRING

fromName

STRING

id

STRING

object

STRING

title

STRING

url

STRING

clicks

The clicks table contains info about recent click activity.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

actionDate

Useful links

clicks schema on GitHub

Mailshake API method

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

created

DATE-TIME

id

INTEGER

object

STRING

title

STRING

id

INTEGER

isDuplicate

BOOLEAN

link

STRING

object

STRING

parent

OBJECT

id

INTEGER

message

OBJECT

id

INTEGER

object

STRING

subject

STRING

type

STRING

object

STRING

type

STRING

recipient

OBJECT

action

STRING

created

DATE-TIME

emailAddress

STRING

fields

OBJECT

first

STRING

fullName

STRING

id

INTEGER

isPaused

BOOLEAN

last

STRING

object

STRING

leads

The leads table contains info about the leads in your Mailshake account.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

created

Useful links

leads schema on GitHub

Mailshake API method

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

emailAddress

STRING

first

STRING

fullName

STRING

id

INTEGER

last

STRING

object

STRING

campaign

OBJECT

created

DATE-TIME

id

INTEGER

object

STRING

title

STRING

created

DATE-TIME

id

INTEGER

lastStatusChangeDate

DATE-TIME

object

STRING

openedDate

DATE-TIME

recipient

OBJECT

created

DATE-TIME

emailAddress

STRING

fields

OBJECT

first

STRING

fullName

STRING

id

INTEGER

last

STRING

object

STRING

status

STRING

opens

The opens table contains info about recently opened emails.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

actionDate

Useful links

opens schema on GitHub

Mailshake API method

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

created

DATE-TIME

id

INTEGER

object

STRING

title

STRING

id

INTEGER

isDuplicate

BOOLEAN

object

STRING

parent

OBJECT

id

INTEGER

message

OBJECT

id

INTEGER

object

STRING

subject

STRING

type

STRING

object

STRING

type

STRING

recipient

OBJECT

action

STRING

created

DATE-TIME

emailAddress

STRING

fields

OBJECT

first

STRING

fullName

STRING

id

INTEGER

isPaused

BOOLEAN

last

STRING

object

STRING

recipients

The recipients table contains info about the recipients in a campaign.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

created

Useful links

recipients schema on GitHub

Mailshake API method

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

The replies table contains info about recent replies to your emails.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

actionDate

Useful links

replies schema on GitHub

Mailshake API method

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

created

DATE-TIME

id

INTEGER

object

STRING

title

STRING

externalConversationID

STRING

externalID

STRING

externalRawMessageID

STRING

id

INTEGER

object

STRING

parent

OBJECT

id

INTEGER

message

OBJECT

id

INTEGER

object

STRING

subject

STRING

type

STRING

object

STRING

type

STRING

plainTextBody

STRING

rawBody

STRING

recipient

OBJECT

action

STRING

created

DATE-TIME

emailAddress

STRING

fields

OBJECT

first

STRING

fullName

STRING

id

INTEGER

isPaused

BOOLEAN

last

STRING

object

STRING

subject

STRING

type

STRING

senders

The senders table contains info about your team’s senders.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

created

Useful links

senders schema on GitHub

Mailshake API method

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

The sent_messages table contains info about recently sent emails.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

actionDate

Useful links

sent_messages schema on GitHub

Mailshake API method

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

created

DATE-TIME

id

INTEGER

object

STRING

title

STRING

externalConversationID

STRING

externalID

STRING

externalRawMessageID

STRING

from

OBJECT

address

STRING

first

STRING

fullName

STRING

last

STRING

object

STRING

id

INTEGER

message

OBJECT

id

INTEGER

object

STRING

subject

STRING

type

STRING

object

STRING

plainTextBody

STRING

rawBody

STRING

recipient

OBJECT

action

STRING

created

DATE-TIME

emailAddress

STRING

fields

OBJECT

first

STRING

fullName

STRING

id

INTEGER

isPaused

BOOLEAN

last

STRING

object

STRING

subject

STRING

to

ARRAY

address

STRING

first

STRING

fullName

STRING

last

STRING

object

STRING

type

STRING

team_members

The team_members table contains info about the individual members of your team.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

teamID

Useful links

team_members schema on GitHub

Mailshake API method

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


Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.