ConvertKit

ConvertKit is the hub for audience growth, marketing automation, and digital products selling.

Data integration: Skyvia supports importing data to and from ConvertKit, exporting ConvertKit data to CSV files, and replicating ConvertKit data to relational databases.

Backup: Skyvia Backup does not support ConvertKit backup.

Query: Skyvia Query supports ConvertKit.

Establishing Connection

To establish a connection to ConvertKit in Skyvia, you must specify the API secret.

Getting Credentials

To obtain the API secret, you have to log in to ConvertKit and perform the following actions:

  1. Click the username in the top right corner of the page and select Settings.
  2. In the left menu, select Advanced.
  3. Click Show in the API Secret box.
  4. Copy the API Secret.

API Secret

Creating Connection

Paste the obtained value into the API secret box in Skyvia.

Connection

Additional Connection Parameters

Suppress Extended Requests

ConvertKit API returns only part of the fields for some objects when querying multiple records. To query the values of additional fields, Skyvia performs additional extended requests for each record of such an object. However, this can decrease performance and significantly increase the number of API calls. The list of additional fields is the following:

Object Field
Broadcasts Description, Content, Public, PublishedAt, SendAt, ThumbnailALT, ThumbnailUrl, EmailAddress, EmailLayoutTemplate
Sequences SendTime, SendTimeZone, RecipientRules_LandingPages, RecipientRules_Courses, RecipientRules_Tags, RecipientRules_Lists, Mon, Tue, Wed, Thr, Fri, Sat, Sun, SendTimeZoneAbbr, EmailTemplates

The SequencesEmailTemplates object is read through the Sequence object. It means that Skyvia reads the Sequence object first obtaining the EmailTemplates field using the extended requests, and then gets the existing SequencesEmailTemplates records for each SequenceId.

To reduce the number of API calls, select the Suppress Extended Requests checkbox. However, please note that some of the fields in such objects will not be available in Skyvia (will return empty values) even if they have values in ConvertKit because its API does not return them without extended requests.

Connector Specifics

Object Peculiarities

Subscribers

Subscribers table stores the list of confirmed (active subscribers). You can find canceled subscribers in the CancelledSubscribers table. You can select the unsubscribed users’ records from CancelledSubscribers. You can get the specific unsubscribed users’ records from the Subscriptions table only using the filter by Id. Such records are displayed with the canceled state value.

Purchases

The TranzactionId field is required for INSERT operation. Skyvia updates the record if the mapped TranzactionId value already exists in the table. If the TranzactionId value is absent in the table, Skyvia inserts the record.

Broadcasts

For successful import into the Broadcasts table, at least one of the fields Subject, Description or Content must be mapped.

Incremental Replication and Synchronization support

Replication with Incremental Updates is supported for the following objects: Broadcasts, CancelledSubscribers, Forms, FormSubscriptions, Sequences, SequenceSubscriptions, Subscribers, SubscriberTags, Tags, TagSubscriptions.

Incremental Replication considers only the new records because all the objects contain only the CreatedDate field, and there is no UpdatedDate field, which is required for replicating the updated records.

Skyvia does not support Synchronization for ConvertKit.

DML Operations Supports

Operation Object
INSERT, UPDATE, DELETE Broadcasts, CustomFields
INSERT, DELETE TagSubscriptions
UPDATE Subscribers
INSERT FormSubscriptions, Purchases, SequenceSubscriptions, Tags

Stored Procedures

Skyvia represents part of the supported ConvertKit features as stored procedures. You can call a stored procedure, for example, as a text of the command in the ExecuteCommand action in a Target component of a Data Flow or in Query.

UnsubscribeSubscriber

The following command unsubscribes an email address from all forms and sequences.

call UnsubscribeSubscriber(:Email)

DestroyWebhook

To delete webhook, use the command

call DestroyWebhook(:id)

CreateWebhook

The following command creates a webhook that will be called when a subscriber event occurs.

call CreateWebhook(:target_url,:event)

PARAMETER NAME DESCRIPTION
Target_url The URL that will receive subscriber data when the event is triggered
Event JSON object that includes the trigger name and extra information about the event, for example { "name": "subscriber.subscriber_activate" }

These are the available event types:

  • “subscriber.subscriber_activate”
  • “subscriber.subscriber_unsubscribe”
  • “subscriber.form_subscribe”, required parameter :form_id [Integer]
  • “subscriber.course_subscribe”, required parameter :course_id [Integer]
  • “subscriber.course_complete”, required parameter :course_id [Integer]
  • “subscriber.link_click”, required parameter :initiator_value [String] as a link URL
  • “subscriber.product_purchase”, required parameter :product_id [Integer]
  • “subscriber.tag_add”, required parameter :tag_id [Integer]
  • “subscriber.tag_remove”, required parameter :tag_id [Integer]
  • “purchase.purchase_create”

For example call CreateWebhook('http://example.com/incoming','{"name": "subscriber.subscriber_activate"}')

Supported Actions

Skyvia supports all the common actions for ConvertKit.

On This Page