Artisan IMG > ConvertKit (convertkit) (ce4f804a-8ca8-40ff-bde7-1dec7e9ac2b7)
Artisan IMG > ConvertKit (convertkit) (ce4f804a-8ca8-40ff-bde7-1dec7e9ac2b7)

ConvertKit
2.0

ConvertKit is an email marketing tool empowering companies to connect with their followers and grow their businesses.

Overview
Copy

ConvertKit is a service connector, enabling users to automate their email marketing processes and build their audience more effectively.

Authentication
Copy

When using the ConvertKit connector, the first thing you will need to do is go to your Tray.io account page, and select the workflow you wish to work on. Once in the workflow builder itself, search and drag the ConvertKit connector from the connectors panel (on the left hand side) onto your workflow.

With the new ConvertKit connector step highlighted, in the properties panel on the right, click on the Authenticate tab followed by 'Add new authentication' (located under the 'Authentication' field).

This will result in a Tray.io authentication pop-up window. The first page will ask you to name your authentication, and state which type of authentication you wish to create ('Organization' or 'Personal').

As you can see, the next page asks you for your 'API Secret'.

In order to get this field, head to your ConvertKit dashboard. Click on the 'General' menu option under your profile.

To get the 'API Secret' click on 'Show' under 'API Secret' and copy the value.

Once you have added these fields to your Tray.io authentication popup window, click on the 'Create authentication' button. Go back to your settings authentication field (within the workflow builder properties panel), and select the recently added authentication from the dropdown options now available.

Your connector authentication setup should now be complete.

Available Operations
Copy

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Example Usage
Copy

TRAY POTENTIAL: Tray.io is extremely flexible. By design there is no fixed way of working with it - you can pull whatever data you need from other services and work with it using our core and helper connectors. This demo which follows shows only one possible way of working with Tray.io and the ConvertKit connector. Once you've finished working through this example please see our Introduction to working with data and jsonpaths page and Data Guide for more details.

Below is an example of a way in which you could potentially use the ConvertKit connector, to list forms from your account and list subscribers for each form.

The steps will be as follows:

  1. Setup using a manual trigger and list forms

  2. Loop through the forms using loop collection

  3. List subscriptions for each form

The final outcome should look like this:

1 - Setup Trigger & List Forms
Copy

Once you have clicked 'Create new workflow' from your main Tray.io dashboard named it, select the Manual trigger from the trigger options available:

After you have been redirected to the Tray.io workflow dashboard, from the connectors panel on the left, add a ConvertKit connector to your second step. Set the operation to 'List forms'.

USER TIP: Feel free to re-name your steps as you go along, to make things clearer for yourself and other potential users of this workflow. Usually the operation name itself is enough however please note that there is also a 'Description' field available under the Describe tab.

You have now successfully configured a workflow that gives you a list of forms available in your account.

2 - Looping Through Forms with Loop Collection
Copy

Next, search for the Loop collection connector within your connector panel, and drag it into your workflow as your next step. Set your operations to 'Loop list'.

The Loop Collection connector allows you to iterate through a list of results. In this example, we will use it to iterate through the data found within the previous 'List forms' connector step.

In order to specify the list you want to loop through, start by using the 'List' mapping icon (found next to the list input field, within the properties panel) to generate the connector-snake.

While hovering over the 'convertkit-1' step (with the tail end of the connector-snake), select forms from the list of output properties displayed. This will auto-populate a jsonpath within your 'List' input field, and update the type selector to jsonpath.

For more clarification on the pathways you have available, open the Debug panel to view your step's Input and Output.

JSONPATHS: For more information on what jsonpaths are and how to use jsonpaths with Tray.io, please see our pages on Basic data concepts and Mapping data between steps

CONNECTOR-SNAKE: The simplest and easiest way to generate your jsonpaths is to use our feature called the Connector-snake. Please see the main page for more details.

With the Loop Collection configured, we can now interact with each of our forms.

3 - List Subscriptions for Each Form
Copy

The last step is to drag a ConvertKit connector inside of the Loop Collection step itself. Set the operation to 'List subscriptions by form'. As you can see, the 'Form ID' field is required.

Like in the previous step, use the connector-snake and hover it over the 'loop-1' step and select id.

To debug at any stage, click on 'Debug' at the top of the page and click on the workflow run you would like to debug.

Now we can list subscriptions for each form that we have on our account.

BEST PRACTICES: Whenever you do decide to create your own workflow, be sure to check out some of our key articles such as: