Platform 2 Guide — This article applies to the new platform. Looking for classic platform docs? Browse the Platform 1 collection.
Why: Seamlessly connect your app to Kit to manage email subscribers and tags automatically. This integration helps you keep your subscriber list up-to-date based on app events, allowing you to focus on creating great content for your members.
Navigate: App Station > Settings > Integrations > Kit
Quick Start
Click on Kit in the Integrations section of your App Station.
Enter your Kit API key and click Save.
Configure your event mappings to determine which events trigger tag actions.
Set up your field mappings to sync custom fields from your app to Kit.
Test the connection to ensure everything is working smoothly.
Detailed Setup Instructions
Connecting Your Kit Account
To start using the Kit integration, you'll need to connect your Kit account:
Go to the Integrations section in your App Station.
Click on Kit.
Enter your Kit API key in the designated field.
Click Save to establish the connection.
Configuring Event Mappings
Event mappings determine which app events will trigger actions in Kit, such as adding or removing tags. Here’s how to set them up:
In the Kit integration settings, locate the Event Mappings section.
Define the events you want to track. For example:
user.signed_up: Add a tag for new subscribers.
subscription.started: Tag subscribers who start a subscription.
subscription.canceled: Remove tags for canceled subscriptions and add a "canceled" tag.
You can customize these mappings based on your needs.
Setting Up Field Mappings
Field mappings allow you to sync custom fields from your app to Kit. To configure this:
Find the Field Mappings section in the Kit integration settings.
Map your app's fields to Kit's custom fields. For example:
Map lastName to mk_last_name.
Map subscriptionStatus to mk_subscription_status.
This ensures that subscriber data is accurately reflected in Kit.
Understanding Supported Events
The Kit integration supports various events that trigger actions in Kit. Here are some key events:
user.signed_up: Creates or updates a subscriber in Kit.
subscription.started: Tags the subscriber as a paying member.
subscription.canceled: Removes the active tag and adds a "canceled" tag.
access.granted: Tags the subscriber with their access level.
These events help you manage your subscriber list effectively.
Testing the Integration
After setting up your Kit integration, it's important to test the connection:
In the Kit integration settings, click on the Test Connection button.
If the connection is successful, you will see a confirmation message.
This step ensures that your API key is valid and that the integration is functioning correctly.
Monitoring Sync Status
You can monitor the health of your Kit connection and sync status directly from the integration settings. Look for indicators that show the last sync time and any errors that may have occurred.
Tip: Regularly check the sync status to ensure your subscriber data is always up-to-date.