# ConvertKit Integration

## Why ConvertKit?

Several of our customers have requested a [ConvertKit](https://convertkit.com/) integration as it's cheaper than Mailchimp, and a bit more focused on ease-of-use and striking designs.

{% embed url="<https://convertkit.com/>" %}

## Enabling ConvertKit

<figure><img src="/files/McpmlCoRZosl8duALYTY" alt=""><figcaption><p>ConvertKit Options</p></figcaption></figure>

Visit the ConvertKit settings in the Integrations tab. Click on "Enable ConvertKit." You'll be prompted to enter your ConvertKit API key and secret key.

{% content-ref url="/pages/RjZz6qVjfOrWhwwqaAXh" %}
[Finding the Plugin Settings](/comment-edit-pro/getting-started/finding-the-plugin-settings.md)
{% endcontent-ref %}

<figure><img src="/files/BeM7dclq8QnYH7pX4aCX" alt=""><figcaption><p>Prompt for API and Secret Keys</p></figcaption></figure>

### Retrieving the API Keys

Log in to your ConvertKit account and go to the settings screen, which you can get to by clicking on your avatar on the top right.

<figure><img src="/files/nDvXS4NGaZozBUReQ5Df" alt=""><figcaption><p>Settings Screen Option</p></figcaption></figure>

Once on the settings page, scroll down until you see the Advanced section. Click on the Advanced section to get your API keys.

<figure><img src="/files/uNHH2KhMylGz5DEIHvUu" alt=""><figcaption><p>Advanced Tab on the Settings Screen</p></figcaption></figure>

You will then be presented with your API Key and API Secret. These keys are what you would input into the ConvertKit integration.

<figure><img src="/files/26bgNGxtIhIqh65xE8kS" alt=""><figcaption><p>Your ConvertKit API Key and Secret</p></figcaption></figure>

### Adding the Keys to the Integration

Input your API Key and Secret Key into the settings and click on "Connect to ConvertKit."

<figure><img src="/files/YCNreGD0RleWUuuUuN4o" alt=""><figcaption><p>Click Connect to ConvertKit to Test Your Credentials</p></figcaption></figure>

If your credentials are correct, you'll be able to select between adding subscribers to a form, or add subscribers to just tags.

### Selecting a Form or Just Tags

<figure><img src="/files/GKgvsu1GZXmBZcn3ylnu" alt=""><figcaption><p>Select Forms and Tags, or Just Tags</p></figcaption></figure>

{% hint style="info" %}
**Using Forms**: a current best practice is to create a phantom form and attach your subscribers based on the form name. The benefit of using forms over tags is that tagged subscribers are automatically subscribed with no double-opt-in. If a subscriber is attached to a form, it will ensure double-opt-in so you don't get in trouble with the spam police.
{% endhint %}

If you are choosing the form route, simply click on the form you'd like the subscribers added to.

{% hint style="warning" %}
**Using Tags**: if you choose to use Tags instead of forms, please be aware that users will be added without the 2nd opt-in in the double-opt-in workflow.
{% endhint %}

### Adding Tags to Subscribers

Additionally, you can add tags to the subscribers. If a tag doesn't exist, you can create a new one.

<figure><img src="/files/VE4DOMiVOdHwUjh3VWng" alt=""><figcaption><p>Add Tags to Subscribers</p></figcaption></figure>

### Adding Custom Fields to Subscribers

Adding Custom Fields to subscribers allows you to pass on extra information about that user to ConvertKit.

When you view a user's profile, these custom fields will be present.

<figure><img src="/files/wemdhjHDmy0iQfrdteRF" alt=""><figcaption><p>Map a Custom Field to a Comment Field or Use a Custom Value</p></figcaption></figure>

You can also use custom values for the custom field. Just select "Custom Value" from the dropdown and you'll be presented with a text box. Click the "X" button to go back to the dropdown.

<figure><img src="/files/LN0Se3glqMtLnePPXsmi" alt=""><figcaption><p>Custom Fields With Mapped Name and Custom Comment Status</p></figcaption></figure>

The last options allow you to set what the user sees on the frontend. You can set the opt-in checkbox text, and also whether the checkbox is enabled by default. To comply with spam rules, it is highly recommended to have this unchecked. Most countries require double-opt-in.

<figure><img src="/files/t1Iorf5jW5gxabDT4yw6" alt=""><figcaption><p>Custom Sign Up Label and Option for Checking the Checkbox by Default</p></figcaption></figure>

## What the User Sees

<figure><img src="/files/rtrMVPtqSD4s9bkTMRSe" alt=""><figcaption><p>Users See a Subscriber Checkbox</p></figcaption></figure>

The users see a subscribe checkbox above the comment submit button.

<figure><img src="/files/kRKgthHcMqovmC53XPrH" alt=""><figcaption><p>Comment Form Filled Out with Checkbox Checked</p></figcaption></figure>

Once the comment is posted, the commenter is sent a subscribe email.

<figure><img src="/files/fpRO1uVMUz0N4r5lT3e7" alt=""><figcaption><p>The Confirmation Email for Your Newsletter</p></figcaption></figure>

### The Added Subscriber

If all is well, the subscriber is added to ConvertKit with the custom fields and tags associated with the subscriber.

<div><figure><img src="/files/18myCDGxuiq9ADY07erw" alt=""><figcaption><p>Subscriber with Subscriber Information</p></figcaption></figure> <figure><img src="/files/2VomWKzTkyTN9fUadm4H" alt=""><figcaption><p>Subscriber With Tags Shown</p></figcaption></figure></div>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.dlxplugins.com/comment-edit-pro/features-overview/integrations/convertkit-integration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
