Platform 2 Guide — This article applies to the new platform. Looking for classic platform docs? Browse the Platform 1 collection.
Why: Streamline your email subscriber management by connecting your app to Kit. This integration automatically syncs subscriber data and tags based on app events, saving you time and ensuring your members receive the right communications.
Navigate: App Station > Settings > Integrations > Kit
Quick Start
Click on Kit in the Integrations section of the App Station.
Enter your Kit API key and click Connect.
Configure your event mappings to determine which tags to add or remove.
Set up your field mappings to sync custom fields from your app to Kit.
Save your settings and test the connection to ensure everything is working.
Detailed Sections
Connecting Your Kit Account
To start using the Kit integration, you need to connect your Kit account:
Go to the Integrations section in the App Station.
Click on Kit.
Enter your Kit API key in the provided field.
Click Connect to establish the link between your app and Kit.
Configuring Event Mappings
Event mappings allow you to define which Kit tags should be added or removed based on specific events in your app. Here’s how to set them up:
In the Kit integration settings, find the Event Mappings section.
Map each event to the corresponding Kit tags. For example:
For the event
user.signed_up, you might want to add a tag like "New Subscriber".For
subscription.canceled, you could remove tags related to active subscriptions.
You can refer to the list of supported events to see which events you can map:
user.signed_up: Create/upsert subscriber
checkout.completed: Tag "purchased"
subscription.started: Tag paying members
access.granted: Tag with access level
Setting Up Field Mappings
Field mappings allow you to sync custom fields from your app to Kit. This ensures that your subscriber data is consistent and up-to-date.
In the Kit integration settings, locate the Field Mappings section.
You can use the default mappings or customize them according to your needs. For instance:
Map your app’s
lastNameto Kit’smk_last_name.Ensure that the subscription details like billing cycle and status are also mapped correctly.
Understanding Sync Events
The integration automatically syncs subscriber data based on specific events. Here’s a brief overview of how it works:
When a member signs up or makes a purchase, an event is triggered in your app.
This event is processed, and the corresponding actions (like adding tags or updating subscriber information) are executed in Kit.
You can monitor the sync status and connection health in the Kit integration settings.
Tip: Regularly check the sync status to ensure that your subscriber data is up to date and that there are no issues with the integration.
Testing the Connection
After setting up your Kit integration, it’s essential to test the connection:
In the Kit integration settings, look for the Test Connection button.
Click it to verify that your API key is valid and that the connection to Kit is successful.
If the test is successful, you’ll see a confirmation message. If there’s an error, double-check your API key and settings.