Platform Requirements
Four ongoing requirements to keep your App live. Learn what they are, why they matter, and how to fix issues if they occur.
Your App requires four active prerequisites to remain live. These aren't just one-time setup steps — they're ongoing requirements. If any of them lapses, your App is automatically suspended until you restore the missing prerequisite.
The Four Prerequisites
1. GitHub OAuth Connection
What it is: Your GitHub account must be connected to mctx. This allows mctx to access your repository and deploy your App's code.
Why it's required: Without GitHub access, mctx can't pull your code, deploy updates, or verify repository access.
How to fix: Reconnect your GitHub account at app.mctx.ai/dev/settings. Click Connect GitHub and authorize the GitHub OAuth app.
2. GitHub App Installation
What it is: The mctx GitHub App must be installed on your GitHub account or organization with access to your App's repository.
Why it's required: The GitHub App provides repository-level permissions for deployment automation, webhook delivery, and registry publishing.
How to fix: Reinstall the GitHub App at app.mctx.ai/dev/settings. Click Install GitHub App and grant access to your repository.
3. Verified Support Email
What it is: Your support email address must be verified via email confirmation. This is the address subscribers use to contact you.
Why it's required: Subscribers need a way to reach you for billing issues, support requests, or technical problems. An unverified or bounced email address prevents subscriber communication.
How to fix: Re-verify your support email at app.mctx.ai/dev/settings. Click Resend Verification Email, check your inbox, and click the verification link.
Common causes:
- Hard-bounced emails (mailbox full, domain doesn't exist)
- Spam complaints (email marked as spam)
- Expired verification (changed email without re-verifying)
4. Payout Setup
What it is: Your payout account must have both charges and payouts enabled. This allows mctx to collect subscriber payments and send you your revenue share (80%).
Why it's required: mctx operates on a paid-only model — servers without functioning payouts can't process subscriber charges.
How to fix: Resolve payout account issues at app.mctx.ai/dev/payouts. Click Manage Payout Account to access your payout dashboard. Common issues include:
- Pending verification (upload requested documents)
- Account under review (contact payout support)
- Bank account verification failed (update bank details)
- Disconnected account (reconnect via payout settings)
What Happens When Prerequisites Lapse
Automatic Suspension
If any prerequisite fails, mctx automatically suspends all your live servers:
- Subscribers see "temporarily unavailable" instead of your App
- Subscriber payments pause (they're not charged during suspension)
- You receive an in-app notification and email explaining the issue
Suspension is Immediate
Detection happens via multiple channels:
- Webhooks (payment provider, GitHub, email provider) — Real-time detection within seconds
- Daily reconciliation (1am UTC) — Safety net cron that catches any webhook events that were missed, delayed, or failed to process
- API validation (before every deployment) — Deployment gating prevents issues
This ensures problems are caught quickly, before subscribers encounter errors or billing issues.
How Reactivation Works
Reactivation behavior depends on why your App was suspended:
Automatic Restoration (External Issues)
When: Payouts are temporarily disabled for verification, then re-enabled.
What happens:
- Your App automatically returns to live status
- Subscribers can use your App immediately
- No action required from you
Example: Payouts were paused for routine account review, then cleared the same day.
Deploy to Restore (Deliberate Actions)
When: You disconnect a prerequisite (uninstall GitHub App, revoke OAuth, disconnect payout account).
What happens:
- Your App automatically returns to ready status
- You must click Deploy to make it live again
- Subscribers can't use your App until you deploy
Why the extra step: mctx treats deliberate disconnections as a signal you intended to take your App offline. The deploy requirement ensures you're ready to bring it back live.
Example: You uninstalled the mctx GitHub App (perhaps to clean up unused apps), then reinstalled it. Your App moves to ready status — click Deploy to restore it.
Missing Prerequisite Blocks Deploy
If you try to deploy while any prerequisite is missing, the deploy button is disabled with a message explaining which prerequisites are missing. Fix all issues first, then deploy.
Monitoring Your Server Status
Dashboard Indicators
Server list page (app.mctx.ai/dev/servers):
- Green "Live" badge — All prerequisites met, server is accessible
- Yellow "Ready" badge — Prerequisites met, but not deployed yet
- Red "Suspended" badge — One or more prerequisites missing
- Gray "Setup Required" badge — Initial payout setup not completed
Server detail page (app.mctx.ai/dev/servers):
- Status banner at top shows suspension reason if applicable
- Prerequisite checklist shows which requirements are missing
- Quick-fix links take you directly to the relevant settings page
Notifications
You'll receive notifications when:
- Server is suspended (lists affected servers and reason)
- Server is reactivated (lists restored servers and new status)
- Deployment blocked due to missing prerequisites
Notification delivery:
- In-app (red badge on notifications bell)
- Email (if email notifications enabled in app.mctx.ai/usr/settings)
Prevention Best Practices
Don't disconnect prerequisite integrations casually. If you need to remove access temporarily:
- Expect your servers to be suspended immediately
- Subscribers will see "temporarily unavailable" messages
- Plan for downtime until you restore prerequisites
Keep your support email active. Use an email address you control and monitor. Hard bounces or spam complaints trigger suspension.
Monitor payout notifications. Additional information may be requested for compliance reviews. Respond promptly to avoid payout disruption.
Test changes in test environment first. Use app-test.mctx.ai to validate changes before affecting production servers.
Common Scenarios
"I uninstalled the GitHub App by mistake"
Status: All your servers are now suspended with reason "GitHub App uninstalled"
Fix:
- Go to app.mctx.ai/dev/settings
- Click Install GitHub App
- Grant access to your repository
- Your servers return to
readystatus - Deploy each server to restore to
live
"Additional verification documents requested"
Status: Servers suspended with reason "Payout capability lost"
Fix:
- Check your email for a request for documents
- Go to app.mctx.ai/dev/payouts
- Click Manage Payout Account
- Upload requested documents in your payout dashboard
- Wait for verification (typically 1-2 business days)
- Servers automatically return to
liveonce verified
"My support email hard bounced"
Status: Servers suspended with reason "Support email hard bounced"
Fix:
- Update your email address at app.mctx.ai/dev/settings
- Click Update Support Email
- Check your new inbox for verification email
- Click verification link or enter 6-digit code
- Your servers return to
readystatus - Deploy each server to restore to
live
"I disconnected my payout account to switch to a different account"
Status: Servers suspended with reason "Payout account disconnected"
Fix:
- Go to app.mctx.ai/dev/payouts
- Click Connect Payout Account
- Complete payout setup with new account
- Your servers return to
readystatus - Deploy each server to restore to
live
Troubleshooting
Dashboard shows "Live" but subscribers report errors
Cause: Status may not be synced between database and edge network.
Fix: Click Deploy Server to force a status sync. If issue persists, contact support.
Deploy button enabled but deployment fails
Cause: Prerequisite validation passed, but deployment encountered a different error (build failure, health check timeout, etc.).
Fix: Check deployment logs on your server detail page. Common issues:
- Repository deleted or made private
- Build script failed (missing dependencies, syntax errors)
- Health check timeout (server didn't respond within 30 seconds)
Received suspension notification but don't know which prerequisite failed
Check: Go to your server detail page (app.mctx.ai/dev/servers). The status banner shows the specific suspension reason.
Common reasons:
- "Payout account disconnected" → Reconnect at payout settings
- "GitHub App uninstalled" → Reinstall at developer settings
- "Support email hard bounced" → Re-verify at developer settings
- "Payout capability lost" → Resolve payout account issue
Next Steps
Prerequisites are designed to be set-once, maintained-automatically. If you keep your integrations connected and your support email active, you won't encounter suspension issues.
Related guides:
- Set Up Payouts — Initial payout setup walkthrough
- Add Support Email — Support email verification process
- Connect GitHub — GitHub OAuth and App installation
See something wrong? Report it or suggest an improvement — your feedback helps make these docs better.