Overview
The Integrations section is your connection hub for linking Perkstar with the other business tools and platforms you use every day. By integrating your loyalty program with your existing technology stack, you create a unified ecosystem where data flows automatically between systems, eliminating manual work and ensuring consistency across platforms.
What you can do in the Integrations section:
View all active integrations with third-party applications
Connect new platforms to Perkstar with one-click authorisation
Access your unique API key for custom integrations
Monitor integration status and health
Review integration details and connection dates
Disconnect integrations you no longer need
Check your plan's integration capacity and usage
Tip: Integrations eliminate data silos and manual data entry, saving hours of administrative work. When your loyalty platform connects to your CRM, POS system, email marketing tool, or e-commerce platform, customer data syncs automatically, transactions trigger loyalty rewards instantly, and your team sees a complete view of customer engagement across all touchpoints.
Who should manage integrations:
Account owners: Full access to all integration features
Technical administrators: Configure and troubleshoot integrations
IT staff: Implement custom API integrations
Marketing managers: Connect email and marketing platforms
Before You Begin
Requirements:
Active Perkstar account
Account owner or administrator permissions
Active accounts on third-party platforms you want to integrate
API credentials or authorization access for third-party services
What You'll Need:
Depending on the integration type:
For pre-built integrations: Login credentials for the third-party service
For API integrations: Your Perkstar API key (available in this section)
For custom integrations: Technical knowledge or developer support
For all integrations: Understanding of what data you want to sync
Understanding Integration Types
Pre-built integrations:
One-click connection to supported platforms
Guided setup with minimal technical knowledge required
Automatic data field mapping
Examples: Popular CRM, email marketing, POS systems
API integrations:
Custom connections using Perkstar's API
Requires technical implementation
Complete flexibility in data flow and automation
Examples: Proprietary systems, custom applications, advanced workflows
Accessing the Integrations Section
How to Navigate to Integrations
From your dashboard:
Log in to your Perkstar account
Click Settings (⚙️ icon) in the left-hand menu
Click the Integrations tab at the top of the Settings screen
Note: The Integrations screen displays all integration management tools and options.
Integrations Screen Layout
The Integrations section is organized into four main areas:
Plan and Capacity Tile: Shows your current plan and integration limits
API Key Section: Your unique API key for custom integrations
Active Integrations: List of currently connected platforms
Add Integration: Available platforms you can connect
Understanding Your Integration Capacity
Plan and Integration Limits
At the top of the Integrations screen, you'll see a tile displaying:
Current subscription plan:
Your plan tier (Starter, Professional, Business, etc.)
Integration allowance for your plan
Integration usage:
Number of active integrations currently connected
Total number of integrations allowed on your plan
Remaining integration slots available
Note: Example display: "Professional Plan: 5 of 10 integrations used" or "Starter Plan: 2 of 3 integrations used"
What Counts as an Integration
Each connected platform counts as one integration against your limit:
Pre-built platform connections (CRM, email marketing, POS)
Active webhooks (if counted separately on your plan)
Custom API implementations (may count differently by plan)
Upgrading for More Integrations
If you've reached your limit:
Review active integrations and disconnect unused ones
Upgrade to a higher-tier plan with more integration capacity
Contact support about add-on integration packs (if available)
To upgrade:
Navigate to Settings → Plan tab
Select "Upgrade your current plan"
Choose a plan with higher integration limits
Working with Your API Key
What is an API Key?
Info: Your API key is a unique identifier that allows third-party applications and custom code to securely access your Perkstar account data. Think of it as a password specifically for systems (not humans) to interact with your account programmatically.
What API keys enable:
Custom integrations with proprietary systems
Automated data transfers between platforms
Real-time synchronization of customer and transaction data
Building custom applications on top of Perkstar
Advanced automation beyond pre-built integrations
Accessing Your API Key
To view and copy your API key:
Navigate to Settings → Integrations tab
Locate the API Key tile (below the plan information)
Your API key displays as a long alphanumeric string
Click the Copy button to copy the key to your clipboard
Using your API key:
Paste the key into third-party applications that support Perkstar API
Provide to developers building custom integrations
Include in API requests as authentication header
Never share publicly or commit to version control systems
API Documentation
Tip: Next to your API key, you'll find a link to API Documentation with available endpoints, authentication requirements, request/response formats, code examples, rate limits, error codes, and implementation best practices.
When to use API documentation:
Building custom integrations from scratch
Troubleshooting API connection issues
Understanding available data fields and endpoints
Implementing advanced automation workflows
Training developers on Perkstar API capabilities
API Key Security Best Practices
Protecting your API key:
Never share your API key:
Don't post in public forums or documentation
Don't commit to public GitHub repositories
Don't include in client-side JavaScript (visible to anyone)
Don't share via unsecured email or messaging
Secure storage:
Store in environment variables, not hardcoded in code
Use secret management systems (AWS Secrets Manager, Azure Key Vault)
Limit access to only team members who need it
Document where API key is stored for team reference
Access control:
Only provide API key to trusted developers and systems
Use separate API keys for different integrations if possible
Revoke and regenerate keys if compromised
Regularly audit who has access to API keys
Monitoring usage:
Track API calls to detect unusual activity
Set up alerts for unexpected usage patterns
Review API logs periodically
Investigate any unauthorized access immediately
Regenerating Your API Key
When to regenerate:
API key has been compromised or exposed publicly
Developer who had access left your organization
Suspicious API activity detected
Regular security rotation (every 6-12 months recommended)
Integrations need to be rebuilt from scratch
How to regenerate:
Contact Perkstar support (regeneration may not be available in UI)
Request new API key
Update all active integrations with new key
Test all integrations to ensure they still work
Revoke old key after confirming new key works
Warning: Regenerating your API key will break all existing API integrations until you update them with the new key. Plan this carefully and update integrations immediately.
Managing Active Integrations
Understanding the Active Integrations Table
The Active Integrations section displays all currently connected platforms in a table format with the following columns:
Name:
The platform or service name
Examples: "Mailchimp," "Salesforce," "Shopify," "Custom CRM Integration"
Integration ID:
Unique identifier for this specific integration
Used for technical troubleshooting and API references
Automatically generated when integration is created
Date:
When the integration was first connected
Helps you track how long integration has been active
Useful for auditing and review purposes
Status:
Current operational state of the integration
Common statuses:
Active: Integration working normally
Error: Connection issue or sync failure
Paused: Integration temporarily disabled
Reconnect Required: Authorization expired, needs re-authentication
Details:
Link or button to view more information about the integration
Click to see detailed configuration, sync history, and settings
Viewing Integration Details
To view detailed information about an integration:
Locate the integration in the Active Integrations table
Click Details in the rightmost column
Review the integration details page
Integration details typically include:
Configuration settings and field mappings
Last sync date and time
Sync frequency (real-time, hourly, daily)
Data being synchronized (customers, transactions, cards)
Error logs (if any issues occurred)
Connection health metrics
Options to edit, pause, or disconnect
Monitoring Integration Health
Signs of healthy integration:
Status shows "Active"
Last sync time is recent (within expected frequency)
No error messages in logs
Data appearing correctly in both systems
Warning signs:
Status shows "Error" or "Reconnect Required"
Last sync time is outdated (hours or days old)
Error messages in integration logs
Data missing or inconsistent between systems
What to do if integration shows errors:
Click Details to view error messages
Check common issues:
Authorization expired (re-authorize)
API rate limits exceeded (wait and retry)
Invalid credentials (update)
Service temporarily down (check third-party status)
Follow troubleshooting steps in error message
Contact support if error persists
Pausing an Integration
When to pause an integration:
Temporary data quality issues in one system
Troubleshooting sync problems
Making changes to field mappings or settings
Testing integration configuration changes
Seasonal pause for inactive business periods
How to pause (if available):
Open integration details
Click Pause or Disable button
Confirm the pause
Integration stops syncing but configuration is preserved
To resume:
Open integration details
Click Resume or Enable
Integration resumes syncing from current state
Disconnecting an Integration
Before disconnecting:
Export any data you need from the integration
Understand what happens to synced data (usually preserved in both systems)
Notify team members who rely on the integration
Document why you're disconnecting for future reference
How to disconnect:
Open integration details page
Locate Disconnect, Remove, or Delete button
Review warning about disconnection impact
Confirm removal
Integration removed from Active Integrations table
After disconnecting:
Integration no longer counts against your plan limit
Data stops syncing between systems
Historical data typically remains in both systems
You can reconnect later if needed (may require reconfiguration)
Adding New Integrations
Viewing Available Integrations
Info: The Add Integration section displays all platforms and services that support pre-built connections with Perkstar.
Common integration categories:
Customer Relationship Management (CRM):
Salesforce, HubSpot, Zoho CRM, Pipedrive
Sync customer profiles and interaction history
Unified customer view across platforms
Email Marketing:
Mailchimp, Constant Contact, Klaviyo, SendGrid
Automatically add loyalty customers to email lists
Trigger campaigns based on loyalty activity
Segment customers by loyalty tier or points
Point of Sale (POS):
Square, Clover, Toast, Lightspeed
Automatic loyalty point allocation at checkout
Real-time transaction syncing
Customer identification at register
E-commerce Platforms:
Shopify, WooCommerce, BigCommerce, Magento
Online purchase loyalty rewards
Customer account synchronization
Unified online and in-store loyalty tracking
Analytics and Business Intelligence:
Google Analytics, Tableau, Power BI
Loyalty data in comprehensive dashboards
ROI tracking and customer lifetime value
Combined loyalty and business metrics
Accounting and Finance:
QuickBooks, Xero, FreshBooks
Revenue tracking from loyalty program
Expense categorization for loyalty costs
Financial reporting integration
Connecting a New Integration
Step-by-step connection process:
1. Navigate to Add Integration section:
Scroll down to the bottom of the Integrations screen
Browse available platforms
2. Select platform to connect:
Find the platform you want to integrate
Click the Connect button in the platform's row
3. Authorize the connection:
You'll be redirected to the third-party platform's login page
Log in with your credentials for that platform
Review permission requests carefully
Click Authorize, Allow, or Connect
4. Configure integration settings:
Select what data to sync (customers, transactions, cards)
Choose sync frequency (real-time, hourly, daily)
Map data fields between systems (email, phone, customer ID)
Set up any platform-specific options
5. Test the integration:
Trigger a test sync (button usually provided)
Verify data appears correctly in both systems
Check that no errors occur
6. Activate the integration:
Click Save or Activate
Integration moves to Active Integrations table
Automatic syncing begins
Field Mapping
Info: Field mapping connects data fields between Perkstar and the third-party platform, ensuring information flows to the correct places.
Common field mappings:
Perkstar "Customer Email" → CRM "Email Address"
Perkstar "Phone Number" → Email Marketing "Mobile Phone"
Perkstar "Customer Name" → POS "Customer Full Name"
Perkstar "Points Balance" → CRM "Loyalty Points"
Perkstar "Last Visit Date" → Analytics "Last Transaction"
Best practices for field mapping:
Match fields carefully (incorrect mapping causes data inconsistencies)
Use consistent customer identifiers (email or phone) across all systems
Test with sample data before activating
Document your field mapping for team reference
Review mapping when either system's fields change
Sync Frequency Options
Real-time sync:
Data transfers immediately when changes occur
Best for: POS integrations, live customer data
Higher API usage, may have costs or rate limits
Hourly sync:
Data updates every hour
Best for: Most business operations, balanced approach
Good compromise between freshness and API usage
Daily sync:
Data updates once per day at scheduled time
Best for: Historical reporting, less time-sensitive data
Minimal API usage, suitable for large datasets
Manual sync:
You trigger sync when needed
Best for: Testing, troubleshooting, infrequent updates
Complete control, no automatic API calls
Integration Use Cases by Business Type
Retail Stores
Recommended integrations:
POS System (Square, Clover):
Automatic loyalty points at checkout
Customer identification by phone or email
Transaction history syncing
Email Marketing (Mailchimp):
Welcome emails for new loyalty members
Re-engagement campaigns for inactive customers
Birthday offers and special promotions
CRM (Salesforce):
Complete customer purchase history
Loyalty tier visibility for sales staff
Targeted outreach based on purchase behavior
Restaurants and Cafés
Recommended integrations:
POS System (Toast, Square):
Points for food and beverage purchases
Online ordering loyalty integration
Split bill loyalty allocation
Google Analytics:
Track loyalty program impact on revenue
Customer lifetime value analysis
Campaign effectiveness measurement
Accounting (QuickBooks):
Revenue categorization (loyalty vs. regular)
Expense tracking for loyalty program costs
Financial reporting
Salons and Spas
Recommended integrations:
Booking System (Mindbody, Vagaro):
Points for appointments booked
Integration with service history
Automatic loyalty points at check-in
Email Marketing (Constant Contact):
Appointment reminders with loyalty balance
Service promotion campaigns
Birthday and anniversary offers
CRM (HubSpot):
Customer service preferences tracking
Loyalty tier visibility for personalized service
Follow-up automation after appointments
E-commerce Businesses
Recommended integrations:
E-commerce Platform (Shopify, WooCommerce):
Points for online purchases
Loyalty tier discounts at checkout
Customer account synchronization
Email Marketing (Klaviyo):
Abandoned cart recovery with loyalty incentives
Post-purchase campaigns
VIP customer segmentation
Analytics (Google Analytics):
Loyalty program ROI tracking
Customer lifetime value by segment
Conversion rate impact analysis
Best Practices for Integration Management
Integration Strategy
Start with high-impact integrations:
Identify which integrations will save the most time
Prioritize systems you use most frequently
Connect one integration at a time to avoid overwhelm
Test thoroughly before adding next integration
Plan for data quality:
Ensure customer data is clean before integrating
Establish data standards (name format, phone format, etc.)
Remove duplicates in all systems before syncing
Document data quality rules for team
Consider data flow direction:
Perkstar → Other system (export loyalty data)
Other system → Perkstar (import customer data)
Bidirectional (both systems update each other)
Choose based on which system is "source of truth"
Regular Maintenance
Weekly checks:
Review Active Integrations for error statuses
Verify recent sync times are current
Check integration logs for warnings
Test critical integrations with sample transactions
Monthly audits:
Review all active integrations—are they still needed?
Disconnect unused integrations to free capacity
Update any credentials that are expiring soon
Verify data quality in both systems
Quarterly reviews:
Assess integration ROI (time saved, errors prevented)
Look for new integration opportunities
Update field mappings if data structures changed
Review security (API key rotation, access audit)
Team Coordination
Documentation:
Maintain list of all active integrations and their purposes
Document field mapping for each integration
Note who is responsible for each integration
Keep record of troubleshooting steps that worked
Access management:
Limit integration management to technical staff
Don't share API keys with entire team
Provide view-only access where possible
Create process for requesting new integrations
Change communication:
Notify team before adding or removing integrations
Test changes during low-traffic periods
Have rollback plan if integration causes issues
Document all changes for audit trail
Data Privacy and Compliance
Privacy considerations:
Only sync data that's necessary for integration purpose
Review third-party platform's privacy policy
Ensure integrations comply with GDPR, CCPA, etc.
Get customer consent for data sharing if required
Security:
Use platforms with strong security practices
Enable two-factor authentication on integrated accounts
Regularly review integration permissions
Revoke access when team members leave
Data retention:
Understand how long third-party platforms keep data
Know what happens to data if you disconnect integration
Plan for data deletion if required by regulations
Export critical data before disconnecting
Troubleshooting Integrations
Integration Shows "Error" Status
Step-by-step troubleshooting:
Click Details to view error message
Read the specific error description
Note error code if provided
Common causes and solutions:
"Authorization expired": Re-authorize the integration by clicking Reconnect
"API rate limit exceeded": Wait for rate limit to reset (usually hourly or daily)
"Invalid credentials": Update API key or login credentials
"Service unavailable": Check third-party platform's status page for outages
Test the connection:
Try manual sync (if available)
Verify you can log into third-party platform separately
Check if third-party platform is experiencing issues
Contact support:
If error persists after basic troubleshooting
Provide integration ID, error message, and timestamp
Describe what you've tried already
Data Not Syncing
Problem: Integration shows "Active" but data isn't appearing in other system
Troubleshooting steps:
Check sync timing:
When was last sync? (View in integration details)
What is sync frequency? (Real-time, hourly, daily)
For non-real-time, wait for next scheduled sync
Verify field mapping:
Are fields mapped correctly?
Are there empty fields that should have data?
Try syncing a test record with complete data
Check filters or conditions:
Some integrations only sync records meeting certain criteria
Review integration settings for filters
Ensure test data meets filter conditions
Look for rate limits:
Have you exceeded API call limits?
Check integration logs for throttling messages
Reduce sync frequency if hitting limits
Verify permissions:
Does integration have permission to write data?
Check third-party platform user permissions
Re-authorize integration to refresh permissions
Duplicate Customer Records
Problem: Same customer appearing multiple times in one or both systems
Causes:
Inconsistent customer identifiers (email vs. phone)
Different name formats (John Smith vs. J. Smith)
Multiple accounts in one system
Case sensitivity issues (john@email.com vs. John@email.com)
Solutions:
Standardize matching criteria:
Choose email or phone as primary identifier
Configure integration to match on that field
Use same format in both systems
Clean up existing duplicates:
Merge duplicates in both systems before syncing
Use deduplication tools if available
Export, clean, and re-import if necessary
Prevent future duplicates:
Enforce unique identifiers in both systems
Standardize data entry (all lowercase email, consistent phone format)
Set up duplicate detection alerts
Integration Connecting But Not Working
Problem: Integration connects successfully but doesn't function as expected
Troubleshooting:
Review integration configuration:
Are you syncing the correct data types?
Is bidirectional sync configured properly?
Are update triggers set correctly?
Test with known data:
Create test customer in Perkstar
Verify it appears in third-party system
Make change and verify it syncs back
Delete test data after verification
Check integration documentation:
Review Perkstar's integration guide for specific platform
Check third-party platform's integration documentation
Look for known issues or limitations
Verify API key and permissions:
Confirm API key is correct (copy-paste carefully)
Check API key hasn't been regenerated
Ensure API key has necessary permissions
Frequently Asked Questions
How many integrations can I connect?
The number depends on your subscription plan. Your plan's integration limit is displayed at the top of the Integrations screen. Starter plans typically allow 2-3 integrations, while higher tiers allow 10-20 or more.
Do integrations count against my customer or card limits?
No. Integration limits are separate from your customer database size and loyalty card limits. However, integrations may sync customers into Perkstar, which would count toward your customer limit.
Can I use my API key with multiple integrations?
Yes. Your API key can be used for multiple custom integrations and third-party tools. Each connection using the same API key will authenticate as your account.
What happens to my data if I disconnect an integration?
Disconnecting stops future syncing, but data already in both systems typically remains. For example, customers synced from your CRM will stay in Perkstar. Always verify with specific integration documentation before disconnecting.
Can I reconnect an integration after disconnecting?
Yes. You can reconnect at any time by clicking the Connect button again. You'll need to reconfigure settings and field mappings, but the integration will function normally once reconnected.
Is my API key the same as my login password?
No. Your API key is specifically for system-to-system connections, not for logging into Perkstar. Never share your API key publicly, but you can provide it to trusted developers or third-party applications.
How often does data sync between systems?
Sync frequency depends on the integration configuration. Options typically include real-time (immediate), hourly, daily, or manual. You can usually adjust frequency in integration settings.
Can I customize what data is synced?
Most integrations allow you to select which data types to sync (customers, transactions, loyalty cards, etc.) and how fields map between systems. Configuration options vary by integration.
What should I do if an integration is using old data?
Trigger a manual sync to refresh data. In integration details, look for "Sync Now" or similar button. If manual sync doesn't help, disconnect and reconnect the integration to force full resync.
Can I see a history of data synced?
Most integrations provide sync logs in the Details view, showing when syncs occurred, how many records were transferred, and any errors. Log detail level varies by integration.
Do I need technical knowledge to set up integrations?
Pre-built integrations (Connect button) require minimal technical knowledge—just login credentials for the other platform. Custom API integrations require programming knowledge or developer assistance
.
Can I integrate with a platform not in the Add Integration list?
Yes, using the API key. If a platform supports REST APIs or webhooks, you can build a custom integration. Refer to Perkstar API documentation for guidance, or contact a developer.
What happens if I regenerate my API key?
All integrations using the old API key will stop working immediately. You must update every custom integration with the new API key. Pre-built integrations (OAuth-based) are typically not affected.
How secure are integrations?
Integrations use industry-standard security practices including HTTPS encryption, OAuth 2.0 authentication, and API key protection. Always follow security best practices: don't share API keys, use strong passwords, and regularly audit integrations.
Can multiple team members manage integrations?
Account owners and administrators can typically access the Integrations section. It's best to limit integration management to technical staff who understand the implications of connecting and disconnecting systems.
Tip: Need more help? Contact Perkstar support for assistance with specific integrations, API documentation, troubleshooting connection issues, or recommendations for your business type.