Skip to content

Latest commit

 

History

History
115 lines (79 loc) · 8.48 KB

marketo.md

File metadata and controls

115 lines (79 loc) · 8.48 KB
Raw

Marketo

This page contains the setup guide and reference information for the Marketo source connector.

Prerequisites

  • (Optional) Whitelist Airbyte's IP address if needed
  • An API-only Marketo User Role
  • An Airbyte Marketo API-only user
  • A Marketo API Custom Service
  • Marketo Client ID & Client Secret
  • Marketo Base URL

Setup guide

Step 1: Set up Marketo

Step 1.1: (Optional) whitelist Airbyte's IP address

If you don't have IP Restriction enabled in Marketo, skip this step.

If you have IP Restriction enabled in Marketo, you'll need to whitelist the IP address of the machine running your Airbyte instance. To obtain your IP address, run curl ifconfig.io from the node running Airbyte. You might need to enlist an engineer to help with this. Copy the IP address returned and keep it on hand.

Once you have the IP address, whitelist it by following the Marketo documentation for allowlisting IP addresses for API based access.

Step 1.2: Create an API-only Marketo User Role

Follow the Marketo documentation for creating an API-only Marketo User Role.

Step 1.3: Create an Airbyte Marketo API-only user

Follow the Marketo documentation to create an API only user

Step 1.4: Create a Marketo API custom service

Follow the Marketo documentation for creating a custom service for use with a REST API.

Make sure to follow the "Credentials for API Access" section in the Marketo docs to generate a Client ID and Client Secret. Once generated, copy those credentials and keep them handy for use in the Airbyte UI later.

Step 1.5: Obtain your Endpoint and Identity URLs provided by Marketo

Follow the Marketo documentation for obtaining your base URL. Specifically, copy your Endpoint without "/rest" and keep them handy for use in the Airbyte UI.

We're almost there! Armed with your Endpoint & Identity URLs and your Client ID and Secret, head over to the Airbyte UI to setup Marketo as a source.

Step 2: Set up the Marketo connector in Airbyte

For Airbyte Cloud:

  1. Log into your Airbyte Cloud account.
  2. In the left navigation bar, click Sources. In the top-right corner, click +new source.
  3. On the Set up the source page, enter the name for the Marketo connector and select Marketo from the Source type dropdown.
  4. Enter the start date, domain URL, client ID and secret
  5. Submit the form

For Airbyte OSS:

  1. Navigate to the Airbyte Open Source dashboard
  2. Set the name for your source
  3. Enter the start date
  4. Enter the domain URL
  5. Enter client ID and secret
  6. Click Set up source

Supported sync modes

The Marketo source connector supports the following sync modes:

  • Full Refresh | Overwrite
  • Full Refresh | Append
  • Incremental | Append
  • Incremental | Deduped

Supported Streams

This connector can be used to sync the following tables from Marketo:

  • activities_X where X is an activity type contains information about lead activities of the type X. For example, activities_send_email contains information about lead activities related to the activity type send_email. See the Marketo docs for a detailed explanation of what each column means.
  • activity_types. Contains metadata about activity types. See the Marketo docs for a detailed explanation of columns.
  • campaigns. Contains info about your Marketo campaigns. Marketo docs.
  • leads. Contains info about your Marketo leads. Marketo docs.
  • lists. Contains info about your Marketo static lists. Marketo docs.
  • programs. Contains info about your Marketo programs. Marketo docs.

Performance considerations

By default, Marketo caps all accounts to 50,000 API calls per day.

By default, this connector caps itself to 40,000 API calls per day. But you can also customize the maximum number of API calls this source connector makes per day to Marketo (which may be helpful if you have for example other applications which are also hitting the Marketo API). If this source connector reaches the maximum number you configured, it will not replicate any data until the next day.

If the 50,000 limit is too stringent, contact Marketo support for a quota increase.

Data type map

Integration Type Airbyte Type Notes
array array primitive arrays are converted into arrays of the types described in this table
int, long number
object object
string string ``
Namespaces No

Changelog

Version Date Pull Request Subject
0.1.11 2022-09-30 17445 Do not use temporary files for memory optimization
0.1.10 2022-09-30 17445 Optimize memory consumption
0.1.9 2022-09-28 17304 Migrate to per-stream sate.
0.1.7 2022-08-23 15817 Improved unit test coverage
0.1.6 2022-08-21 15824 Fix semi incremental streams: do not ignore start date, make one api call instead of multiple
0.1.5 2022-08-16 15683 Retry failed creation of a job instead of skipping it
0.1.4 2022-06-20 13930 Process failing creation of export jobs
0.1.3 2021-12-10 8429 Updated titles and descriptions
0.1.2 2021-12-03 8483 Improve field conversion to conform schema
0.1.1 2021-11-29 0000 Fix timestamp value format issue
0.1.0 2021-09-06 5863 Release Marketo CDK Connector