Platform 2 Guide — This article applies to the new platform. Looking for classic platform docs? Browse the Platform 1 collection.
Why: Connect your app with Systeme.io to automate member account creation, manage access based on purchases or cancellations, and keep your member data in sync. This integration saves you time and ensures a seamless experience for your subscribers.
Navigate: App Station > Security & Technical > Integrations > Systeme.io
Quick Start
Go to App Station and navigate to Security & Technical > Integrations > Systeme.io.
Enter your Systeme.io API key.
Copy the provided webhook URL into your Systeme.io Account Settings under Webhooks.
(Optional) Set a webhook secret in Systeme.io that matches the one in your app.
Map your Systeme.io price plan IDs to the corresponding access levels in your app.
Detailed Setup Instructions
Overview of the Integration
The Systeme.io integration allows for bidirectional communication between your app and Systeme.io. This means:
Inbound Webhooks: Systeme.io sends events like
SALE_NEWandSALE_CANCELEDto your app. This allows your app to automatically create users and manage their access levels based on their purchases.Outbound API Sync: Your app can send updates back to Systeme.io, such as custom fields and tags, based on user actions within your app.
Setting Up the Integration
Access the Integration Settings
Navigate to App Station and select Security & Technical > Integrations > Systeme.io.
Enter Your API Key
Obtain your API key from your Systeme.io account (found under Profile > Public API keys) and enter it in the provided field.
Configure the Webhook
Copy the webhook URL displayed in your app and paste it into the Webhooks section of your Systeme.io Account Settings.
(Optional) If you want to enhance security, set a webhook secret in Systeme.io that matches the one in your app.
Map Price Plans to Access Levels
You can either manually map your Systeme.io price plan IDs to the corresponding access levels in your app or allow the system to auto-discover them after a test purchase.
Set Up Event Tag Mappings (Optional)
Configure how events from your app will trigger tag additions or removals in Systeme.io. For example, you might want to add a tag when access is granted.
Understanding Webhook Events
Your app will respond to specific events sent from Systeme.io:
SALE_NEW: This event creates a user if they do not already exist, grants or reactivates access, and confirms renewals.
SALE_CANCELED: This event revokes access based on the order ID provided.
Outbound Custom Fields
When your app syncs data back to Systeme.io, it can create custom fields if they do not already exist. These fields include:
mk_subscription_status: Current subscription status of the user.mk_access_level: The name of the current access level.mk_signup_date: The date the user signed up.mk_last_login: The date of the user's last login (if tracked).
Important Notes
Ensure that your integration is set up correctly to avoid any issues with member access and data synchronization.
Remember that the integration requires the
systeme_integrationfeature, which is available in the Growth tier.