Set up Stripe in your app from the AI chat. Install Stripe, create products, test checkout, claim your Stripe sandbox, and activate live payments when ready.
Listen to this page18 min 11 sec
Base44 lets you set up Stripe payments directly from the AI chat in your app editor. You can ask the chat to install Stripe and create a checkout flow for your app. Everything starts in a safe Stripe test environment, so you can run test payments before you connect your live Stripe account and go live.
Example store where customers can browse products and pay through a Stripe-powered checkout
This flow was released in January 2026 and replaces the old Stripe flow.
Start by asking the Base44 chat to install Stripe for your app. Base44 sets everything up in a test environment so you can experiment without real charges.
Note: Stripe is available on the Builder plan and above.
To install Stripe:
Go to your app editor.
Ask the AI chat to set up payments on your app. For example, you can ask: Connect a payment method so I can take payments from customers.
Review the reply from Base44 describing that it will set up Stripe payments for your app in a test environment and click Install Stripe.
Installing Stripe from the AI chat
When you have installed Stripe, go to Dashboard → Integrations → Stripe to see the setup guide.
Ask the AI chat to create your products. For example, you can ask the chat:Create 3 products for my store:
Classic Baseball Hat’ – $20
Wool Beanie – $25
Sun Visor – $18
The products and prices are created directly in Stripe, and you’ll see and manage them from your Stripe Dashboard. If you want to change or add products later, you can ask the AI chat to do it for you.Base44 then uses those Stripe products and prices when it builds your checkout flows. It doesn’t create a separate product database for you automatically.
After Stripe is installed, you can test your checkout flow using Stripe’s test card. This helps you confirm that the customer journey, from product selection to payment, behaves as expected.
Note: The checkout flow only runs on your published app, not in the editor preview. Make sure you publish your app first, then open the live site to run your test payment.
To run a test payment:
Click Dashboard in your app editor.
Click Integrations.
Click Stripe.
Click Try a test payment and then Copy Card Number so you can paste it during checkout.
Publish your app.
Go through the checkout flow and at the payment step, enter:
When you are happy with how the test flow works, claim your sandbox by connecting your own Stripe account or creating a new one. This step links the test environment in Base44 to your Stripe account so you can move toward a live setup.You can ask the AI chat to claim your Stripe sandbox, or you can do it yourself from your app’s dashboard.
Important:
You have 60 days to claim your Stripe sandbox.
Make sure you connect the correct Stripe account for your business. This is the account that receives your payouts when you go live.
To claim your Stripe sandbox:
Click Dashboard in your app editor.
Click Integrations.
Click Stripe.
Click Claim your Stripe sandbox.
Click Claim & Go Live.
Follow the prompts to sign in to your existing Stripe account, or create a new Stripe account if you do not have one yet.
Complete any onboarding details that Stripe asks for, such as business and bank information.
When you return to Base44, check in Setup to confirm that the Claim your Stripe sandbox step shows as complete.
After you claim your sandbox, Base44 activates live payments for you. Once your Stripe account finishes activating, Base44 creates your live API keys automatically, so you no longer need to find and paste them from Stripe. This switches your app from test mode to live mode, where real charges are created when customers complete checkout.To activate live payments:
Click Dashboard in your app editor.
Click Integrations.
Click Stripe.
Open the Add your live API keys from Stripe step. While your account finishes connecting, you see Waiting for your Stripe account to finish activating. This usually happens automatically.
If Stripe still needs more information, click Resume setup in Stripe and complete any onboarding details Stripe asks for, such as business and bank information.
Once your Stripe account is active, your live keys are added automatically and your app starts accepting real payments. To track your revenue, transactions, and subscriptions from your app dashboard, see Tracking payments in your app.
To use your own keys instead, click Enter keys manually, paste your live publishable and secret keys from your Stripe Dashboard, then click Save API keys. Payments you take with these keys show in your Transactions list from the time you save them.
Activating live payments in Base44
If you enter a restricted key, it must allow account reads and webhook management. Base44 can’t save a key without these permissions.
After connecting Stripe in the AI chat and activating live payments, you are ready to set up real payment flows in your app. Each flow should send a logged in person to Stripe Checkout and, on the success page, confirm the payment and update their account while they are still logged in, instead of relying on webhooks alone.Use the example prompts below in the AI chat and adjust the details so they match what you want to sell and how your app should change someone’s access after they pay. You can copy them as-is or tweak them to describe exactly what you want your app to do.
If you plan to publish your app to the App Store or Google Play, don’t sell digital content in the mobile app, such as credits, subscriptions or digital products. Apple and Google require their own in-app purchase systems for it, and Base44 apps don’t support them yet. Learn what you can sell in selling in your app.
One-time payment for credits
Let your app users buy credits (e.g., “Buy 10 credits for $10”) and automatically update their account after payment.
What to type in the chat: I want to let my users buy credits in my app using Stripe. After a successful payment, the user should be returned to my app and their credits should be added to their account.
Verify the payment securely before adding credits.
Add the correct number of credits to the user’s account.
Make sure credits are only added once, even if the page is refreshed.
Optional follow-up: Add a “Buy 10 Credits” button to my homepage.
Sell a digital product (eBooks, online courses, digital art, etc.)
Let your app users purchase a downloadable item and unlock access after payment.
What to type in the chat: I want to sell a digital product in my app using Stripe (for example, an eBook or course). After a successful payment, the user should be returned to my app and get access to the download or content.
Record the purchase in my app.
Unlock the user’s access to the product.
Make sure the same payment can’t be used to unlock the product multiple times.
Sell physical products that need shipping
Let your app users buy items you ship to them, and collect their shipping address at checkout.
What to type in the chat:
I want to sell physical products in my app using Stripe.- Have Stripe Checkout ask for a shipping address when the cart has items I ship.- After a successful payment, save the order with the buyer's shipping address.- Show me each order and where to ship it on an admin page.
After a customer pays, you can also see the address they entered in the payment’s details in your Transactions list. See Payment details.
The shipping address a customer entered at checkout
Book a service (yoga, coaching, etc.)
Let your app users pay to book a time slot and save the appointment to their account.
What to type in the chat: I want to let my users book a paid service in my app using Stripe (for example, a yoga session or coaching call).
Let my users choose a service and time slot.
Handle the payment with Stripe.
After a successful payment, save the booking (service, time, user) to a bookings collection.
Show a clear confirmation in the app.
Prevent double‑booking, even if the user refreshes the page or retries the confirmation.
Start a subscription
Let your app users sign up for a recurring plan and tag them as subscribed.
What to type in the chat: Build a Stripe subscription flow where my users can sign up for a recurring plan.
Let my users choose a subscription plan in my app.
Handle the recurring payment with Stripe.
After a successful signup, mark the user as “Pro” (or subscribed) in their account.
Store the subscription details so I can manage cancellations or billing updates later.
Cancel a subscription
Allow your app users to cancel their plan and downgrade their access level.
What to type in the chat:Create a cancellation flow for subscriptions.
Let my users cancel their subscription, either from a page in my app or via the Stripe customer portal.
After a cancellation, update the user’s account so they lose their “Pro” / subscribed status.
Optionally, show a clear message or redirect them to a downgraded page or plan.
Issue a refund and revoke access
If a refund is processed, remove credits or block content access.
What to type in the chat: Set up a secure flow to handle Stripe refunds.
When a refund is processed, let an admin trigger a check from inside the app.
Verify that the refunded payment belongs to the correct user.
Revoke access or subtract credits from that user’s account.
Prevent the same refund from being processed more than once.
Optional follow-up: Create an admin page where I can enter a Stripe payment or session ID, review the details, and apply the refund-related changes (like removing access or credits) manually.
Sell tickets for an event
Let your app users buy a ticket for a one-time event and save their registration.
What to type in the chat: I want to sell tickets for an event in my app using Stripe.
Let my users buy a ticket for a specific event.
After a successful payment, save the attendee’s details (name, email, event) in an attendees list or collection.
Show a clear confirmation or thank-you page after purchase.
Optionally, generate a simple ticket or confirmation code the attendee can use at the event.
Accept tips or donations
Let your app users support your work or project with a one-time or monthly payment.
What to type in the chat: Create a flow to accept donations or tips in my app using Stripe.
Let my users choose a suggested amount (for example, $5, $10, $25) or enter a custom amount.
Handle the payment with Stripe.
After a successful payment, show a thank-you page or message.
Optionally, save each donation in a Donations collection linked to the user’s account.
Optional follow-up: Add a “Support Me” button to my About page that takes users into this donation flow.
Accept international payments
Let your app users pay from other countries using local currency or methods.
What to type in the chat: Set up my Stripe payments so they work well for international users.
Enable common international payment methods (for example, iDEAL, Bancontact, Apple Pay, Google Pay).
Use Stripe’s automatic currency conversion so my users can pay in their local currency.
Show prices in USD in my app, but let Stripe handle local pricing at checkout.
Make sure the checkout flow works smoothly for users in different countries.
Send branded invoices
Let your app users receive a professional invoice and pay later using a Stripe-hosted page.
What to type in the chat: Set up a Stripe invoicing flow in my app.
Let me generate and send an invoice to a user from my app.
Include a description, amount, and due date on each invoice.
Email the user a secure payment link they can use to pay the invoice.
After the invoice is paid, update the user’s record in my app (for example, mark the invoice as paid or unlock access).
Optional follow-up: Add an “Invoice a Client” button to my admin dashboard that starts this flow.
Build a simple marketplace (Advanced - Stripe Connect)
Let your app users sell their own products or services and receive direct payouts.
What to type in the chat: Create a basic marketplace in my app using Stripe Connect.
Let my users register as sellers and connect their own Stripe accounts.
When a customer buys something, route the payment to the correct seller.
Optionally, take a small platform fee from each transaction.
Track transactions and show each seller their earnings and payout history.
Stripe Connect is more advanced and may require additional setup or approval from Stripe.
Click a question below to learn more about setting up payments
Do test payments use real money?
No. When you follow step 2, payments are created in Stripe test mode. You use the test credit card number, and no real money moves between accounts.
Where can I see my transactions and refunds?
You can see every payment in your app dashboard. Click Payments, then Transactions, and click a payment to see its details, including any shipping address the customer entered. You can also refund a payment from there. See Tracking payments in your app.For payouts, fees and disputes, use your Stripe dashboard. Click Open Stripe dashboard on your app’s Payments page to open it.
Can I change products or pricing after I connect Stripe?
Yes. You can update products and pricing in your Stripe Dashboard at any time.Those changes apply to checkouts and subscriptions created through your Base44 app. If your app stores specific product or price IDs (for example, in your product data), make sure you update those references if you create new prices in Stripe rather than editing existing ones.
Do I need a business to use Stripe?
You don’t need to have a registered business to test things out. You can use Stripe’s sandbox (test) mode without entering real business details. But to accept real payments, Stripe requires verified business and banking information.
What kinds of payments can I accept in my Base44 app?
Once connected, your app can accept:
Credit and debit cards
Apple Pay and Google Pay
Local payment methods (like iDEAL, Bancontact, etc.)
Multiple currencies with automatic conversion
Can I charge users in my app on a recurring basis?
Yes. You can offer subscriptions or memberships in your Base44 app using Stripe. Stripe automatically handles recurring payments and renewals.
Can users manage their own billing in my app?
Yes. Once Stripe is connected, your app users can update their card details, view invoices, and manage subscriptions through Stripe’s secure billing portal.
How do I accept payments from customers in Israel?
Base44 doesn’t currently have a built-in payment solution for Israel. You can still accept payments by connecting the payment provider of your choice as an integration: ask the AI chat to connect your provider, and it sets up the integration for you.
How can I troubleshoot Stripe issues in my Base44 app?
If Stripe isn’t working as expected in your app, for example, nothing happens when a user clicks a “Pay” or “Checkout” button, you can view Function Logs in your Base44 dashboard to find out what’s going wrong.This works for any payment-related feature, whether you’re selling products, accepting bookings, or offering subscriptions.Here’s how to check the logs:
Click Dashboard in your app editor.
Go to Code → Functions.
Find the function related to your payment flow (e.g., createCheckout for a store).
Click on the function, then scroll to the Logs section.
The Logs show messages about what happened when the function ran. Look for red error messages. These can help pinpoint what went wrong
Example: If your app is a store and the createCheckout function fails, the logs might show:
“Product not found” → one of the items in the cart is missing or has an incorrect ID
“Invalid price” → a product is missing a price or set to 0
“Missing success_url” → Stripe doesn’t know where to send users after they pay
Once you find the error message, you can copy it and paste it into the AI chat to ask your Base44 app for help fixing it.
Why is my payment flow not working or showing a blank page after payment?
If your payment flow does not complete or you see a blank page after payment, it is usually caused by the app environment or redirect settings. If you are using Stripe, test your flow by following step 3 above. If you built a custom payment flow or use another provider, check the following:Common issues:
Preview vs published: Custom payment flows usually do not work correctly in preview. Always test payments on your published app, using the live URL.
Redirect URL problems: If you see redirect loops or a blank page after payment, check that your success and cancel URLs point to your published app domain, and that you are not mixing preview URLs with live payment callbacks.
Login requirements: If you require login to access your app or payment pages, make sure the success page after payment is still reachable for signed in people. Misconfigured auth can lead to blank pages after checkout.
Pop up vs same window: On mobile, some providers work better in a separate payment tab or pop-up. If you see issues when replacing the current page, consider opening the payment page in a new window if your provider supports it.
To fix the issue:
Check your browser console for errors.
In your Base44 dashboard, go to Code → Functions and review the logs for any payment related backend functions.
If you use webhooks, verify that your webhook URL is correct and that the endpoint is deployed and responding.
If you still cannot find the cause, copy any error messages from your console or function logs and paste them into the Base44 AI chat. Ask it to “help troubleshoot this payment flow step by step” and include details about your provider and setup.
Does using Stripe use Base44 integration credits?
Calling Stripe itself does not use Base44 integration credits. When your app calls Stripe using your own API keys through backend functions, the request goes directly from your backend function to Stripe. Base44’s built-in services are not involved.Integration credits are only used when your app uses Base44’s own built-in services.If your Stripe payment flow also triggers any of these built-in services, for example, sending a confirmation email via Base44’s SendEmail, those specific actions consume integration credits as normal. Stripe itself does not.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Base44 Support Documentation","colors":{"primary":"#FF6A00","light":"#FF8E5D","dark":"#FF6A00"},"logo":{"light":"https://mintcdn.com/base44/jhCpOaGylNweq32m/logo/new-brand-light.svg?fit=max\u0026auto=format\u0026n=jhCpOaGylNweq32m\u0026q=85\u0026s=7724705143e6cfece3b0a237be2a6890","dark":"https://mintcdn.com/base44/jhCpOaGylNweq32m/logo/new-brand-dark.svg?fit=max\u0026auto=format\u0026n=jhCpOaGylNweq32m\u0026q=85\u0026s=6c3ad8a8d1ae8299c119d554dc371843","href":"/"},"favicon":"https://mintcdn.com/base44/XkAHbvyG1CwOBCSP/images/base44-favicon.svg?fit=max\u0026auto=format\u0026n=XkAHbvyG1CwOBCSP\u0026q=85\u0026s=2a7fda75e5497e8b44f47f01bb3aa807","api":{"playground":{}},"background":{"color":{"light":"#FAF9F7","dark":"#1E1E24"}},"navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/changelog/product","label":"Changelog"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"footer":{"socials":{"twitter":"https://x.com/base44","discord":"https://discord.com/invite/ThpYPZpVts","linkedin":"https://www.linkedin.com/company/base44"}},"seo":{"metatags":{"canonical":"https://docs.base44.com","og:image":"https://docs.base44.com/images/base44-docs-og.png","og:image:width":"2400","og:image:height":"1260","twitter:image":"https://docs.base44.com/images/base44-docs-og.png","twitter:card":"summary_large_image"},"indexing":"all"},"integrations":{"mixpanel":{"projectToken":"cc6e9e106e4b833fc3a3819c11b74138"}},"contextual":{"options":["copy","view","mcp","cursor","vscode"],"display":"header"},"metadata":{"timestamp":false},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","default":true,"href":""},{"language":"pt-BR","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/pt-BR/changelog/product","label":"Registro de alterações"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"href":"pt-BR"},{"language":"es","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/es/changelog/product","label":"Registro de cambios"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"href":"es"},{"language":"he","hidden":true,"navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/he/changelog/product","label":"יומן שינויים"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"href":"he"},{"language":"ja","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/ja/changelog/product","label":"変更履歴"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"href":"ja"},{"language":"de","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/de/changelog/product","label":"Änderungsprotokoll"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"href":"de"},{"language":"fr","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/fr/changelog/product","label":"Notes de version"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"href":"fr"},{"language":"it","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/it/changelog/product","label":"Registro modifiche"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"href":"it"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"base44","hasAudioNarration":true,"actualSubdomain":"base44","customDomains":["docs.base44.com"],"gitSource":{"type":"github","owner":"base44-dev","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af19e3ea4e37073d30c4cd0","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"en","tag":"Developers","count":847},{"language":"en","tag":"APIs","count":592},{"language":"en","tag":"Apps API (Beta)","count":453},{"language":"de","tag":"Entwickler","count":140},{"language":"es","tag":"Desarrolladores","count":140},{"language":"fr","tag":"Développeurs","count":140},{"language":"he","tag":"מפתחים","count":140},{"language":"it","tag":"Sviluppatori","count":140},{"language":"ja","tag":"開発者","count":140},{"language":"pt-BR","tag":"Desenvolvedores","count":140},{"language":"en","tag":"API Reference","count":126},{"language":"en","tag":"Apps","count":109},{"language":"en","tag":"Skills","count":109},{"language":"en","tag":"Google Ads","count":90},{"language":"en","tag":"Workspace API (Beta)","count":75},{"language":"de","tag":"Apps","count":68},{"language":"es","tag":"Aplicaciones","count":68},{"language":"fr","tag":"Applications","count":68},{"language":"it","tag":"App","count":68},{"language":"ja","tag":"アプリ","count":68},{"language":"pt-BR","tag":"Apps","count":68},{"language":"he","tag":"אפליקציות","count":67},{"language":"en","tag":"CLI","count":59},{"language":"de","tag":"CLI","count":59},{"language":"es","tag":"CLI","count":59},{"language":"fr","tag":"CLI","count":59},{"language":"he","tag":"CLI","count":59},{"language":"it","tag":"CLI","count":59},{"language":"ja","tag":"CLI","count":59},{"language":"pt-BR","tag":"CLI","count":59},{"language":"en","tag":"Commands","count":57},{"language":"de","tag":"Commands","count":57},{"language":"es","tag":"Commands","count":57},{"language":"fr","tag":"Commands","count":57},{"language":"he","tag":"Commands","count":57},{"language":"it","tag":"Commands","count":57},{"language":"ja","tag":"Commands","count":57},{"language":"pt-BR","tag":"Commands","count":57},{"language":"de","tag":"Backend (Beta)","count":42},{"language":"es","tag":"Backend (Beta)","count":42},{"language":"fr","tag":"Backend (Beta)","count":42},{"language":"he","tag":"Backend (בטא)","count":42},{"language":"it","tag":"Backend (Beta)","count":42},{"language":"ja","tag":"バックエンド (Beta)","count":42},{"language":"pt-BR","tag":"Backend (Beta)","count":42},{"language":"de","tag":"Konto \u0026 Abrechnung","count":31},{"language":"de","tag":"SDKs","count":31},{"language":"es","tag":"Cuenta y facturación","count":31},{"language":"es","tag":"SDKs","count":31},{"language":"fr","tag":"Compte et facturation","count":31},{"language":"fr","tag":"SDKs","count":31},{"language":"he","tag":"חשבון וחיוב","count":31},{"language":"he","tag":"SDKs","count":31},{"language":"it","tag":"Account e fatturazione","count":31},{"language":"it","tag":"SDKs","count":31},{"language":"ja","tag":"アカウントと請求","count":31},{"language":"ja","tag":"SDKs","count":31},{"language":"pt-BR","tag":"Conta e faturamento","count":31},{"language":"pt-BR","tag":"SDKs","count":31},{"language":"de","tag":"Integrationen","count":24},{"language":"de","tag":"App SDK","count":24},{"language":"es","tag":"Integraciones","count":24},{"language":"es","tag":"App SDK","count":24},{"language":"fr","tag":"Intégrations","count":24},{"language":"fr","tag":"App SDK","count":24},{"language":"he","tag":"אינטגרציות","count":24},{"language":"he","tag":"App SDK","count":24},{"language":"it","tag":"Integrazioni","count":24},{"language":"it","tag":"App SDK","count":24},{"language":"ja","tag":"インテグレーション","count":24},{"language":"ja","tag":"App SDK","count":24},{"language":"pt-BR","tag":"Integrações","count":24},{"language":"pt-BR","tag":"App SDK","count":24},{"language":"de","tag":"Unternehmen","count":22},{"language":"es","tag":"Empresas","count":22},{"language":"fr","tag":"Entreprise","count":22},{"language":"he","tag":"ארגונים","count":22},{"language":"it","tag":"Aziende","count":22},{"language":"ja","tag":"エンタープライズ","count":22},{"language":"pt-BR","tag":"Empresas","count":22},{"language":"default","tag":"Developers","count":2},{"language":"default","tag":"APIs","count":2},{"language":"default","tag":"Audit Logs API","count":2},{"language":"default","tag":"API Reference","count":2},{"language":"default","tag":"audit-logs","count":2}],"searchSettings":{"showContentSnippets":true,"maxResults":10}},"assistantConfig":{"enableStarterQuestions":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"68f8934ac32e3459832881b0","deploymentId":"6792c6d6e85c02040dc386df","questionText":"Which plans come with a free domain?","status":"active","generatedBy":"manual","createdAt":"2025-10-22T08:18:18.293Z","updatedAt":"2025-10-22T08:18:18.293Z","__v":0},{"_id":"68f892c4c32e345983287064","deploymentId":"6792c6d6e85c02040dc386df","questionText":"How are credits used?","status":"active","generatedBy":"manual","createdAt":"2025-10-22T08:16:04.700Z","updatedAt":"2025-10-22T08:16:24.261Z","__v":0},{"_id":"68f892aec32e345983286ddf","deploymentId":"6792c6d6e85c02040dc386df","questionText":"How do I use Discuss mode?","status":"active","generatedBy":"manual","createdAt":"2025-10-22T08:15:42.469Z","updatedAt":"2025-10-22T08:15:42.469Z","__v":0}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","href":"/_mintlify/custom/base44/5b5842685c884e06/custom.css"}],"page":{"pagePath":"documentation/setting-up-your-app/setting-up-payments","slug":"/documentation/setting-up-your-app/setting-up-payments","pageMetadata":{"title":"Setting up Stripe","description":"Set up Stripe in your app from the AI chat. Install Stripe, create products, test checkout, claim your Stripe sandbox, and activate live payments when ready.","sidebarTitle":"Setting up Stripe","href":"/documentation/setting-up-your-app/setting-up-payments"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Set up Stripe in your app from the AI chat. Install Stripe, create products, test checkout, claim your Stripe sandbox, and activate live payments when ready.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,em:`em`,hr:`hr`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Accordion,AccordionGroup,CodeBlock,Frame,Heading,Info,Note,OptimizedImage,Tip,Warning}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Note)_missingMdxReference(`Note`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Base44 lets you set up Stripe payments directly from the AI chat in your app editor. You can ask the chat to install Stripe and create a checkout flow for your app. Everything starts in a safe Stripe test environment, so you can run test payments before you connect your live Stripe account and go live.`}),`\n`,_jsx(Frame,{caption:`Example store where customers can browse products and pay through a Stripe-powered checkout`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/base44/SkIHOaOBC5y_B2cQ/images/hatss.png?fit=max\u0026auto=format\u0026n=SkIHOaOBC5y_B2cQ\u0026q=85\u0026s=b9f57ea60c8d73a4a6e4b061a1e42dea`,alt:`A Hattery storefront with an Elevate Your Style hero and 3 featured hats`,className:`mint-mx-auto`,style:{width:`75%`},\"data-og-width\":`1038`,width:`1038`,\"data-og-height\":`947`,height:`947`,\"data-path\":`images/hatss.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/base44/SkIHOaOBC5y_B2cQ/images/hatss.png?w=280\u0026fit=max\u0026auto=format\u0026n=SkIHOaOBC5y_B2cQ\u0026q=85\u0026s=28a7dad28217ab6f1a20d3977f10dab8 280w, https://mintcdn.com/base44/SkIHOaOBC5y_B2cQ/images/hatss.png?w=560\u0026fit=max\u0026auto=format\u0026n=SkIHOaOBC5y_B2cQ\u0026q=85\u0026s=84144bbce3372cb2c0d235f050abb8a8 560w, https://mintcdn.com/base44/SkIHOaOBC5y_B2cQ/images/hatss.png?w=840\u0026fit=max\u0026auto=format\u0026n=SkIHOaOBC5y_B2cQ\u0026q=85\u0026s=25e3d078ce4e337538e085491f196565 840w, https://mintcdn.com/base44/SkIHOaOBC5y_B2cQ/images/hatss.png?w=1100\u0026fit=max\u0026auto=format\u0026n=SkIHOaOBC5y_B2cQ\u0026q=85\u0026s=69d1204f35acf2ba497b494846320d33 1100w, https://mintcdn.com/base44/SkIHOaOBC5y_B2cQ/images/hatss.png?w=1650\u0026fit=max\u0026auto=format\u0026n=SkIHOaOBC5y_B2cQ\u0026q=85\u0026s=652e82eb8cc5bf30eb65139218d1a9ed 1650w, https://mintcdn.com/base44/SkIHOaOBC5y_B2cQ/images/hatss.png?w=2500\u0026fit=max\u0026auto=format\u0026n=SkIHOaOBC5y_B2cQ\u0026q=85\u0026s=5c37ff40b5cd77f786ce5157a3233035 2500w`})}),`\n`,_jsx(Info,{children:_jsx(_components.p,{children:`This flow was released in January 2026 and replaces the old Stripe flow.`})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`step-1-|-install-stripe`,children:`Step 1 | Install Stripe`}),`\n`,_jsx(_components.p,{children:`Start by asking the Base44 chat to install Stripe for your app. Base44 sets everything up in a test environment so you can experiment without real charges.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Note:`}),` Stripe is available on the `,_jsx(_components.strong,{children:`Builder`}),` plan and above.`]})}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`To install Stripe:`})}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsx(_components.li,{children:`Go to your app editor.`}),`\n`,_jsxs(_components.li,{children:[`Ask the AI chat to set up payments on your app. For example, you can ask: `,_jsx(_components.code,{children:`Connect a payment method so I can take payments from customers.`})]}),`\n`,_jsxs(_components.li,{children:[`Review the reply from Base44 describing that it will set up Stripe payments for your app in a test environment and click `,_jsx(_components.strong,{children:`Install Stripe`}),`.`]}),`\n`]}),`\n`,_jsx(Frame,{caption:`Installing Stripe from the AI chat`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/stripeaichat.png?fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=0c9a28e7ce95e4cbb17c57c0f83f9221`,alt:`A screenshot of a chat request to connect payments and the reply with Install Stripe, outlined beside the app preview`,\"data-og-width\":`1850`,width:`1850`,\"data-og-height\":`1000`,height:`1000`,\"data-path\":`images/stripeaichat.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/stripeaichat.png?w=280\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=2da8b3a945e6c46c55c61a2810826022 280w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/stripeaichat.png?w=560\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=fa60c4aa1d046ed2162a315299528636 560w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/stripeaichat.png?w=840\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=2583d0bdce635d1a512156d4785c4b16 840w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/stripeaichat.png?w=1100\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=636228212a8f5f97d1414d16c825ef8f 1100w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/stripeaichat.png?w=1650\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=ec5a5ec0b710cef2f20493dd3ed75920 1650w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/stripeaichat.png?w=2500\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=b78797bd66516c2c6ccb29b7239ed3f7 2500w`})}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`When you have installed Stripe, go to `,_jsx(_components.strong,{children:`Dashboard`}),` → `,_jsx(_components.strong,{children:`Integrations`}),` → `,_jsx(_components.strong,{children:`Stripe`}),` to see the setup guide.`]})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`step-2-|-create-your-products`,children:`Step 2 | Create your products`}),`\n`,_jsx(_components.p,{children:`Ask the AI chat to create your products. For example, you can ask the chat:`}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`Create 3 products for my store:`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`Classic Baseball Hat’ – $20`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`Wool Beanie – $25`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`Sun Visor – $18`})}),`\n`]}),`\n`,_jsx(_components.p,{children:`The products and prices are created directly in Stripe, and you’ll see and manage them from your Stripe Dashboard. If you want to change or add products later, you can ask the AI chat to do it for you.`}),`\n`,_jsx(_components.p,{children:`Base44 then uses those Stripe products and prices when it builds your checkout flows. It doesn’t create a separate product database for you automatically.`}),`\n`,_jsx(Frame,{caption:`Creating products from the chat`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/base44/VilgCnF0z9rvpr-1/images/addingproducts.png?fit=max\u0026auto=format\u0026n=VilgCnF0z9rvpr-1\u0026q=85\u0026s=d3ef0dc6fb338f7cdb65f0c3f506133b`,alt:`AI chat with a create 3 products prompt outlined, beside the storefront it built`,\"data-og-width\":`1655`,width:`1655`,\"data-og-height\":`954`,height:`954`,\"data-path\":`images/addingproducts.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/base44/VilgCnF0z9rvpr-1/images/addingproducts.png?w=280\u0026fit=max\u0026auto=format\u0026n=VilgCnF0z9rvpr-1\u0026q=85\u0026s=8a8f1a6beac0cff78a03d63b914046fc 280w, https://mintcdn.com/base44/VilgCnF0z9rvpr-1/images/addingproducts.png?w=560\u0026fit=max\u0026auto=format\u0026n=VilgCnF0z9rvpr-1\u0026q=85\u0026s=1316627ed784621fa79e5ccca19c4c34 560w, https://mintcdn.com/base44/VilgCnF0z9rvpr-1/images/addingproducts.png?w=840\u0026fit=max\u0026auto=format\u0026n=VilgCnF0z9rvpr-1\u0026q=85\u0026s=f6a3380c8b354f9c212edd6cc7c18678 840w, https://mintcdn.com/base44/VilgCnF0z9rvpr-1/images/addingproducts.png?w=1100\u0026fit=max\u0026auto=format\u0026n=VilgCnF0z9rvpr-1\u0026q=85\u0026s=27566d0a670e270c52844053c11ef245 1100w, https://mintcdn.com/base44/VilgCnF0z9rvpr-1/images/addingproducts.png?w=1650\u0026fit=max\u0026auto=format\u0026n=VilgCnF0z9rvpr-1\u0026q=85\u0026s=20b51c2a2b3bb2350e010c46ed6a5761 1650w, https://mintcdn.com/base44/VilgCnF0z9rvpr-1/images/addingproducts.png?w=2500\u0026fit=max\u0026auto=format\u0026n=VilgCnF0z9rvpr-1\u0026q=85\u0026s=e40c747db5c6b4adf1c00161e42da7d0 2500w`})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`step-3-|-test-your-checkout-flow`,children:`Step 3 | Test your checkout flow`}),`\n`,_jsx(_components.p,{children:`After Stripe is installed, you can test your checkout flow using Stripe’s test card. This helps you confirm that the customer journey, from product selection to payment, behaves as expected.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Note:`}),` The checkout flow only runs on your published app, not in the editor preview. Make sure you publish your app first, then open the live site to run your test payment.`]})}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`To run a test payment:`})}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Dashboard`}),` in your app editor.`]}),`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Integrations`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Stripe`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Try a test payment`}),` and then `,_jsx(_components.strong,{children:`Copy Card Number`}),` so you can paste it during checkout.`]}),`\n`,_jsx(_components.li,{children:`Publish your app.`}),`\n`,_jsxs(_components.li,{children:[`Go through the checkout flow and at the payment step, enter:`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`The test card number`}),`\n`,_jsx(_components.li,{children:`Any future expiry date`}),`\n`,_jsx(_components.li,{children:`Any 3 digit CVC`}),`\n`]}),`\n`]}),`\n`,_jsx(_components.li,{children:`Complete the checkout to create a test payment.`}),`\n`]}),`\n`,_jsx(Frame,{caption:`Running a test payment`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/testpayment.png?fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=896fde3b0d369cfc88cdc59254548cc5`,alt:`A screenshot of the Stripe card on the Integrations page with the Try a test payment step and test card number outlined`,\"data-og-width\":`1440`,width:`1440`,\"data-og-height\":`556`,height:`556`,\"data-path\":`images/testpayment.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/testpayment.png?w=280\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=113b6f80f2a870339ed0cc11fa776b78 280w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/testpayment.png?w=560\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=0fa6bd774aa940121d6a1931757818d2 560w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/testpayment.png?w=840\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=0c926c2eb01dc6ce5422da7a837265cc 840w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/testpayment.png?w=1100\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=996f3e32f88a20ba59b87f65b0d99e6d 1100w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/testpayment.png?w=1650\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=ca1ede9960b56614eb871a66ac2bc95c 1650w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/testpayment.png?w=2500\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=0c9b7f7a3c3083bc0e4a039540df23b9 2500w`})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`step-4-|-claim-your-stripe-sandbox`,children:`Step 4 | Claim your Stripe sandbox`}),`\n`,_jsx(_components.p,{children:`When you are happy with how the test flow works, claim your sandbox by connecting your own Stripe account or creating a new one. This step links the test environment in Base44 to your Stripe account so you can move toward a live setup.`}),`\n`,_jsx(_components.p,{children:`You can ask the AI chat to claim your Stripe sandbox, or you can do it yourself from your app’s dashboard.`}),`\n`,_jsxs(Warning,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Important:`})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`You have 60 days to claim your Stripe sandbox.`}),`\n`,_jsx(_components.li,{children:`Make sure you connect the correct Stripe account for your business. This is the account that receives your payouts when you go live.`}),`\n`]})]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`To claim your Stripe sandbox:`})}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Dashboard`}),` in your app editor.`]}),`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Integrations`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Stripe`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Claim your Stripe sandbox`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Claim \u0026 Go Live`}),`.`]}),`\n`,_jsx(_components.li,{children:`Follow the prompts to sign in to your existing Stripe account, or create a new Stripe account if you do not have one yet.`}),`\n`,_jsx(_components.li,{children:`Complete any onboarding details that Stripe asks for, such as business and bank information.`}),`\n`,_jsxs(_components.li,{children:[`When you return to Base44, check in `,_jsx(_components.strong,{children:`Setup`}),` to confirm that the Claim your Stripe sandbox step shows as complete.`]}),`\n`]}),`\n`,_jsx(Frame,{caption:`Claiming your Stripe sandbox in Base44`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/sandbox1.png?fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=9a2b2b991c074d1b88fce560df17125b`,alt:`A screenshot of the Stripe card on the Integrations page with the Claim your Stripe sandbox step outlined`,\"data-og-width\":`1440`,width:`1440`,\"data-og-height\":`540`,height:`540`,\"data-path\":`images/sandbox1.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/sandbox1.png?w=280\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=ec6ad4482acf90310413e5c223a476ba 280w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/sandbox1.png?w=560\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=b28ac6ad0cea0592cb9a8e1b59f3f816 560w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/sandbox1.png?w=840\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=383b81a5b945df8a9edbacf350025d54 840w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/sandbox1.png?w=1100\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=7ea090299308a67ac846bd1315de8835 1100w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/sandbox1.png?w=1650\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=76683457f403ffbc8f8cb6f80572ded5 1650w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/sandbox1.png?w=2500\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=d71ae1ea328d95a3175307075413d066 2500w`})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`step-5-|-activate-live-payments`,children:`Step 5 | Activate live payments`}),`\n`,_jsx(_components.p,{children:`After you claim your sandbox, Base44 activates live payments for you. Once your Stripe account finishes activating, Base44 creates your live API keys automatically, so you no longer need to find and paste them from Stripe. This switches your app from test mode to live mode, where real charges are created when customers complete checkout.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`To activate live payments:`})}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Dashboard`}),` in your app editor.`]}),`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Integrations`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Stripe`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Open the `,_jsx(_components.strong,{children:`Add your live API keys from Stripe`}),` step. While your account finishes connecting, you see `,_jsx(_components.strong,{children:`Waiting for your Stripe account to finish activating`}),`. This usually happens automatically.`]}),`\n`,_jsxs(_components.li,{children:[`If Stripe still needs more information, click `,_jsx(_components.strong,{children:`Resume setup in Stripe`}),` and complete any onboarding details Stripe asks for, such as business and bank information.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Once your Stripe account is active, your live keys are added automatically and your app starts accepting real payments. To track your revenue, transactions, and subscriptions from your app dashboard, see `,_jsx(_components.a,{href:`/Setting-up-your-app/tracking-payments`,children:`Tracking payments in your app`}),`.`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`To use your own keys instead, click `,_jsx(_components.strong,{children:`Enter keys manually`}),`, paste your live publishable and secret keys from your Stripe Dashboard, then click `,_jsx(_components.strong,{children:`Save API keys`}),`. Payments you take with these keys show in your Transactions list from the time you save them.`]})}),`\n`,_jsx(Frame,{caption:`Activating live payments in Base44`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/stripe-api.png?fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=0007c535b1cc6880ef1b60b6a733a7dc`,alt:`A Stripe integration card with the test payment and sandbox steps ticked off, and the live API keys step waiting for the Stripe account to finish activating, offering Resume setup in Stripe or Enter keys manually`,\"data-og-width\":`1445`,width:`1445`,\"data-og-height\":`630`,height:`630`,\"data-path\":`images/stripe-api.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/stripe-api.png?w=280\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=bac242282e5d51ff75c383f682f920ec 280w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/stripe-api.png?w=560\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=954288890e992db1ac3b3214e8c5f46c 560w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/stripe-api.png?w=840\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=48fdb7025245f7817d5a5950849ffcb0 840w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/stripe-api.png?w=1100\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=106569203d8dee72181ae3637d01b0cb 1100w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/stripe-api.png?w=1650\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=814be3422e2fc2522a1f4827a6876378 1650w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/stripe-api.png?w=2500\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=e2636912b1479a0630bdc8f684b7111a 2500w`})}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`If you enter a restricted key, it must allow account reads and webhook management. Base44 can’t save a key without these permissions.`})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`setting-up-payment-flows`,children:`Setting up payment flows`}),`\n`,_jsx(_components.p,{children:`After connecting Stripe in the AI chat and activating live payments, you are ready to set up real payment flows in your app. Each flow should send a logged in person to Stripe Checkout and, on the success page, confirm the payment and update their account while they are still logged in, instead of relying on webhooks alone.`}),`\n`,_jsx(_components.p,{children:`Use the example prompts below in the AI chat and adjust the details so they match what you want to sell and how your app should change someone’s access after they pay. You can copy them as-is or tweak them to describe exactly what you want your app to do.`}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`If you plan to publish your app to the App Store or Google Play, don’t sell digital content in the mobile app, such as credits, subscriptions or digital products. Apple and Google require their own in-app purchase systems for it, and Base44 apps don’t support them yet. Learn what you can sell in `,_jsx(_components.a,{href:`/documentation/building-your-app/uploading-to-app-stores#selling-in-your-app`,children:`selling in your app`}),`.`]})}),`\n`,_jsxs(AccordionGroup,{children:[_jsxs(Accordion,{title:`One-time payment for credits`,id:`one-time-payment-for-credits`,children:[_jsx(_components.p,{children:`Let your app users buy credits (e.g., “Buy 10 credits for $10”) and automatically update their account after payment.`}),_jsxs(Tip,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`What to type in the chat:`}),_jsx(`br`,{}),`I want to let my users buy credits in my app using Stripe.`,_jsx(`br`,{}),`After a successful payment, the user should be returned to my app and their credits should be added to their account.`]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Verify the payment securely before adding credits.`}),`\n`,_jsx(_components.li,{children:`Add the correct number of credits to the user’s account.`}),`\n`,_jsx(_components.li,{children:`Make sure credits are only added once, even if the page is refreshed.`}),`\n`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Optional follow-up:`}),_jsx(`br`,{}),`Add a “Buy 10 Credits” button to my homepage.`]})]})]}),_jsxs(Accordion,{title:`Sell a digital product (eBooks, online courses, digital art, etc.)`,id:`sell-a-digital-product-ebooks-online-courses-digital-art-etc`,children:[_jsx(_components.p,{children:`Let your app users purchase a downloadable item and unlock access after payment.`}),_jsxs(Tip,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`What to type in the chat:`}),_jsx(`br`,{}),`I want to sell a digital product in my app using Stripe (for example, an eBook or course).`,_jsx(`br`,{}),`After a successful payment, the user should be returned to my app and get access to the download or content.`]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Record the purchase in my app.`}),`\n`,_jsx(_components.li,{children:`Unlock the user’s access to the product.`}),`\n`,_jsx(_components.li,{children:`Make sure the same payment can’t be used to unlock the product multiple times.`}),`\n`]})]})]}),_jsxs(Accordion,{title:`Sell physical products that need shipping`,id:`sell-physical-products-that-need-shipping`,children:[_jsx(_components.p,{children:`Let your app users buy items you ship to them, and collect their shipping address at checkout.`}),_jsxs(Tip,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`What to type in the chat:`})}),_jsx(CodeBlock,{numberOfLines:`5`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`I want to sell physical products in my app using Stripe.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`- Have Stripe Checkout ask for a shipping address when the cart has items I ship.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`- After a successful payment, save the order with the buyer's shipping address.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`- Show me each order and where to ship it on an admin page.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.p,{children:[`After a customer pays, you can also see the address they entered in the payment’s details in your Transactions list. See `,_jsx(_components.a,{href:`/Setting-up-your-app/tracking-payments#viewing-payment-details`,children:`Payment details`}),`.`]}),_jsx(Frame,{caption:`The shipping address a customer entered at checkout`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/apps-payments-transaction-shipping-address.png?fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=0e800f218cc7a258f86f82959e2ab8e7`,alt:`A screenshot of a payment's Order details with the Shipping address section outlined`,\"data-og-width\":`1590`,width:`1590`,\"data-og-height\":`690`,height:`690`,\"data-path\":`images/apps-payments-transaction-shipping-address.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/apps-payments-transaction-shipping-address.png?w=280\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=a2f2618fe41fad88f449f78d9429667a 280w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/apps-payments-transaction-shipping-address.png?w=560\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=06d804f3693e82ee37835c68be4becef 560w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/apps-payments-transaction-shipping-address.png?w=840\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=c4e8d69967f4b4ce10efd14e82102dbf 840w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/apps-payments-transaction-shipping-address.png?w=1100\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=79bd335f0e073ab2b797a33d76c2fc9b 1100w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/apps-payments-transaction-shipping-address.png?w=1650\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=ddca2dd0f1bdf038fe5e191699e2e633 1650w, https://mintcdn.com/base44/l9N0Mo9sVFrq109t/images/apps-payments-transaction-shipping-address.png?w=2500\u0026fit=max\u0026auto=format\u0026n=l9N0Mo9sVFrq109t\u0026q=85\u0026s=2c3707ad21aa347cb8bbfd07a57e3a91 2500w`})})]}),_jsxs(Accordion,{title:`Book a service (yoga, coaching, etc.)`,id:`book-a-service-yoga-coaching-etc`,children:[_jsx(_components.p,{children:`Let your app users pay to book a time slot and save the appointment to their account.`}),_jsxs(Tip,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`What to type in the chat:`}),_jsx(`br`,{}),`I want to let my users book a paid service in my app using Stripe (for example, a yoga session or coaching call).`]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Let my users choose a service and time slot.`}),`\n`,_jsx(_components.li,{children:`Handle the payment with Stripe.`}),`\n`,_jsx(_components.li,{children:`After a successful payment, save the booking (service, time, user) to a bookings collection.`}),`\n`,_jsx(_components.li,{children:`Show a clear confirmation in the app.`}),`\n`,_jsx(_components.li,{children:`Prevent double‑booking, even if the user refreshes the page or retries the confirmation.`}),`\n`]})]})]}),_jsxs(Accordion,{title:`Start a subscription`,id:`start-a-subscription`,children:[_jsx(_components.p,{children:`Let your app users sign up for a recurring plan and tag them as subscribed.`}),_jsxs(Tip,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`What to type in the chat:`}),_jsx(`br`,{}),`Build a Stripe subscription flow where my users can sign up for a recurring plan.`]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Let my users choose a subscription plan in my app.`}),`\n`,_jsx(_components.li,{children:`Handle the recurring payment with Stripe.`}),`\n`,_jsx(_components.li,{children:`After a successful signup, mark the user as “Pro” (or subscribed) in their account.`}),`\n`,_jsx(_components.li,{children:`Store the subscription details so I can manage cancellations or billing updates later.`}),`\n`]})]})]}),_jsxs(Accordion,{title:`Cancel a subscription`,id:`cancel-a-subscription`,children:[_jsx(_components.p,{children:`Allow your app users to cancel their plan and downgrade their access level.`}),_jsxs(Tip,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`What to type in the chat:`})}),_jsx(_components.p,{children:`Create a cancellation flow for subscriptions.`}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Let my users cancel their subscription, either from a page in my app or via the Stripe customer portal.`}),`\n`,_jsx(_components.li,{children:`After a cancellation, update the user’s account so they lose their “Pro” / subscribed status.`}),`\n`,_jsx(_components.li,{children:`Optionally, show a clear message or redirect them to a downgraded page or plan.`}),`\n`]})]})]}),_jsxs(Accordion,{title:`Issue a refund and revoke access`,id:`issue-a-refund-and-revoke-access`,children:[_jsx(_components.p,{children:`If a refund is processed, remove credits or block content access.`}),_jsxs(Tip,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`What to type in the chat:`}),_jsx(`br`,{}),`Set up a secure flow to handle Stripe refunds.`]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`When a refund is processed, let an admin trigger a check from inside the app.`}),`\n`,_jsx(_components.li,{children:`Verify that the refunded payment belongs to the correct user.`}),`\n`,_jsx(_components.li,{children:`Revoke access or subtract credits from that user’s account.`}),`\n`,_jsx(_components.li,{children:`Prevent the same refund from being processed more than once.`}),`\n`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Optional follow-up:`}),_jsx(`br`,{}),`Create an admin page where I can enter a Stripe payment or session ID, review the details, and apply the refund-related changes (like removing access or credits) manually.`]})]})]}),_jsxs(Accordion,{title:`Sell tickets for an event`,id:`sell-tickets-for-an-event`,children:[_jsx(_components.p,{children:`Let your app users buy a ticket for a one-time event and save their registration.`}),_jsxs(Tip,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`What to type in the chat:`}),_jsx(`br`,{}),`I want to sell tickets for an event in my app using Stripe.`]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Let my users buy a ticket for a specific event.`}),`\n`,_jsx(_components.li,{children:`After a successful payment, save the attendee’s details (name, email, event) in an attendees list or collection.`}),`\n`,_jsx(_components.li,{children:`Show a clear confirmation or thank-you page after purchase.`}),`\n`,_jsx(_components.li,{children:`Optionally, generate a simple ticket or confirmation code the attendee can use at the event.`}),`\n`]})]})]}),_jsxs(Accordion,{title:`Accept tips or donations`,id:`accept-tips-or-donations`,children:[_jsx(_components.p,{children:`Let your app users support your work or project with a one-time or monthly payment.`}),_jsxs(Tip,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`What to type in the chat:`}),_jsx(`br`,{}),`Create a flow to accept donations or tips in my app using Stripe.`]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Let my users choose a suggested amount (for example, $5, $10, $25) or enter a custom amount.`}),`\n`,_jsx(_components.li,{children:`Handle the payment with Stripe.`}),`\n`,_jsx(_components.li,{children:`After a successful payment, show a thank-you page or message.`}),`\n`,_jsx(_components.li,{children:`Optionally, save each donation in a Donations collection linked to the user’s account.`}),`\n`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Optional follow-up:`}),_jsx(`br`,{}),`Add a “Support Me” button to my About page that takes users into this donation flow.`]})]})]}),_jsxs(Accordion,{title:`Accept international payments`,id:`accept-international-payments`,children:[_jsx(_components.p,{children:`Let your app users pay from other countries using local currency or methods.`}),_jsxs(Tip,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`What to type in the chat:`}),_jsx(`br`,{}),`Set up my Stripe payments so they work well for international users.`]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Enable common international payment methods (for example, iDEAL, Bancontact, Apple Pay, Google Pay).`}),`\n`,_jsx(_components.li,{children:`Use Stripe’s automatic currency conversion so my users can pay in their local currency.`}),`\n`,_jsx(_components.li,{children:`Show prices in USD in my app, but let Stripe handle local pricing at checkout.`}),`\n`,_jsx(_components.li,{children:`Make sure the checkout flow works smoothly for users in different countries.`}),`\n`]})]})]}),_jsxs(Accordion,{title:`Send branded invoices`,id:`send-branded-invoices`,children:[_jsx(_components.p,{children:`Let your app users receive a professional invoice and pay later using a Stripe-hosted page.`}),_jsxs(Tip,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`What to type in the chat:`}),_jsx(`br`,{}),`Set up a Stripe invoicing flow in my app.`]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Let me generate and send an invoice to a user from my app.`}),`\n`,_jsx(_components.li,{children:`Include a description, amount, and due date on each invoice.`}),`\n`,_jsx(_components.li,{children:`Email the user a secure payment link they can use to pay the invoice.`}),`\n`,_jsx(_components.li,{children:`After the invoice is paid, update the user’s record in my app (for example, mark the invoice as paid or unlock access).`}),`\n`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Optional follow-up:`}),_jsx(`br`,{}),`Add an “Invoice a Client” button to my admin dashboard that starts this flow.`]})]})]}),_jsxs(Accordion,{title:`Build a simple marketplace (Advanced - Stripe Connect)`,id:`build-a-simple-marketplace-advanced-stripe-connect`,children:[_jsx(_components.p,{children:`Let your app users sell their own products or services and receive direct payouts.`}),_jsxs(Tip,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`What to type in the chat:`}),_jsx(`br`,{}),`Create a basic marketplace in my app using Stripe Connect.`]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Let my users register as sellers and connect their own Stripe accounts.`}),`\n`,_jsx(_components.li,{children:`When a customer buys something, route the payment to the correct seller.`}),`\n`,_jsx(_components.li,{children:`Optionally, take a small platform fee from each transaction.`}),`\n`,_jsx(_components.li,{children:`Track transactions and show each seller their earnings and payout history.`}),`\n`]})]}),_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.a,{href:`https://stripe.com/connect`,children:`Stripe Connect`}),` is more advanced and may require additional setup or approval from Stripe.`]})})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`faqs`,children:`FAQs`}),`\n`,_jsx(_components.p,{children:`Click a question below to learn more about setting up payments`}),`\n`,_jsxs(AccordionGroup,{children:[_jsx(Accordion,{title:`Do test payments use real money?`,id:`do-test-payments-use-real-money`,children:_jsx(_components.p,{children:`No. When you follow step 2, payments are created in Stripe test mode. You use the test credit card number, and no real money moves between accounts.`})}),_jsxs(Accordion,{title:`Where can I see my transactions and refunds?`,id:`where-can-i-see-my-transactions-and-refunds`,children:[_jsxs(_components.p,{children:[`You can see every payment in your app dashboard. Click `,_jsx(_components.strong,{children:`Payments`}),`, then `,_jsx(_components.strong,{children:`Transactions`}),`, and click a payment to see its details, including any shipping address the customer entered. You can also refund a payment from there. See `,_jsx(_components.a,{href:`/Setting-up-your-app/tracking-payments`,children:`Tracking payments in your app`}),`.`]}),_jsxs(_components.p,{children:[`For payouts, fees and disputes, use your Stripe dashboard. Click `,_jsx(_components.strong,{children:`Open Stripe dashboard`}),` on your app’s Payments page to open it.`]})]}),_jsxs(Accordion,{title:`Can I change products or pricing after I connect Stripe?`,id:`can-i-change-products-or-pricing-after-i-connect-stripe`,children:[_jsx(_components.p,{children:`Yes. You can update products and pricing in your Stripe Dashboard at any time.`}),_jsx(_components.p,{children:`Those changes apply to checkouts and subscriptions created through your Base44 app. If your app stores specific product or price IDs (for example, in your product data), make sure you update those references if you create new prices in Stripe rather than editing existing ones.`})]}),_jsx(Accordion,{title:`Do I need a business to use Stripe?`,id:`do-i-need-a-business-to-use-stripe`,children:_jsx(_components.p,{children:`You don’t need to have a registered business to test things out. You can use Stripe’s sandbox (test) mode without entering real business details. But to accept real payments, Stripe requires verified business and banking information.`})}),_jsxs(Accordion,{title:`What kinds of payments can I accept in my Base44 app?`,id:`what-kinds-of-payments-can-i-accept-in-my-base44-app`,children:[_jsx(_components.p,{children:`Once connected, your app can accept:`}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Credit and debit cards`}),`\n`,_jsx(_components.li,{children:`Apple Pay and Google Pay`}),`\n`,_jsx(_components.li,{children:`Local payment methods (like iDEAL, Bancontact, etc.)`}),`\n`,_jsx(_components.li,{children:`Multiple currencies with automatic conversion`}),`\n`]})]}),_jsx(Accordion,{title:`Can I charge users in my app on a recurring basis?`,id:`can-i-charge-users-in-my-app-on-a-recurring-basis`,children:_jsx(_components.p,{children:`Yes. You can offer subscriptions or memberships in your Base44 app using Stripe. Stripe automatically handles recurring payments and renewals.`})}),_jsx(Accordion,{title:`Can users manage their own billing in my app?`,id:`can-users-manage-their-own-billing-in-my-app`,children:_jsx(_components.p,{children:`Yes. Once Stripe is connected, your app users can update their card details, view invoices, and manage subscriptions through Stripe’s secure billing portal.`})}),_jsx(Accordion,{title:`How do I accept payments from customers in Israel?`,id:`how-do-i-accept-payments-from-customers-in-israel`,children:_jsx(_components.p,{children:`Base44 doesn’t currently have a built-in payment solution for Israel. You can still accept payments by connecting the payment provider of your choice as an integration: ask the AI chat to connect your provider, and it sets up the integration for you.`})}),_jsxs(Accordion,{title:`How can I troubleshoot Stripe issues in my Base44 app?`,id:`how-can-i-troubleshoot-stripe-issues-in-my-base44-app`,children:[_jsxs(_components.p,{children:[`If Stripe isn’t working as expected in your app, for example, nothing happens when a user clicks a “Pay” or “Checkout” button, you can view `,_jsx(_components.strong,{children:`Function Logs`}),` in your Base44 dashboard to find out what’s going wrong.`]}),_jsx(_components.p,{children:`This works for any payment-related feature, whether you’re selling products, accepting bookings, or offering subscriptions.`}),_jsx(_components.p,{children:_jsx(_components.strong,{children:`Here’s how to check the logs:`})}),_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Dashboard`}),` in your app editor.`]}),`\n`,_jsxs(_components.li,{children:[`Go to `,_jsx(_components.strong,{children:`Code`}),` → `,_jsx(_components.strong,{children:`Functions`}),`.`]}),`\n`,_jsx(_components.li,{children:`Find the function related to your payment flow (e.g., createCheckout for a store).`}),`\n`,_jsxs(_components.li,{children:[`Click on the function, then scroll to the `,_jsx(_components.strong,{children:`Logs`}),` section.`]}),`\n`]}),_jsx(Note,{children:_jsxs(_components.p,{children:[`The Logs show messages about what happened when the function ran. Look for `,_jsx(_components.strong,{children:`red error messages`}),`. These can help pinpoint what went wrong`]})}),_jsxs(Info,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Example:`}),_jsx(`br`,{}),`If your app is a store and the `,_jsx(_components.em,{children:`createCheckout`}),` function fails, the logs might show:`]}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.em,{children:`“Product not found”`}),` → one of the items in the cart is missing or has an incorrect ID`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.em,{children:`“Invalid price`}),`” → a product is missing a price or set to 0`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.em,{children:`“Missing success_url”`}),` → Stripe doesn’t know where to send users after they pay`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.em,{children:`“API Key invalid”`}),` → Stripe isn’t connected properly`]}),`\n`]})]}),_jsx(_components.p,{children:`Once you find the error message, you can copy it and paste it into the AI chat to ask your Base44 app for help fixing it.`})]}),_jsxs(Accordion,{title:`Why is my payment flow not working or showing a blank page after payment?`,id:`why-is-my-payment-flow-not-working-or-showing-a-blank-page-after-payment`,children:[_jsx(_components.p,{children:`If your payment flow does not complete or you see a blank page after payment, it is usually caused by the app environment or redirect settings. If you are using Stripe, test your flow by following step 3 above. If you built a custom payment flow or use another provider, check the following:`}),_jsx(_components.p,{children:_jsx(_components.strong,{children:`Common issues:`})}),_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Preview vs published:`}),` Custom payment flows usually do not work correctly in preview. Always test payments on your published app, using the live URL.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Redirect URL problems:`}),` If you see redirect loops or a blank page after payment, check that your success and cancel URLs point to your published app domain, and that you are not mixing preview URLs with live payment callbacks.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Login requirements:`}),` If you require login to access your app or payment pages, make sure the success page after payment is still reachable for signed in people. Misconfigured auth can lead to blank pages after checkout.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Pop up vs same window:`}),` On mobile, some providers work better in a separate payment tab or pop-up. If you see issues when replacing the current page, consider opening the payment page in a new window if your provider supports it.`]}),`\n`]}),_jsx(_components.p,{children:_jsx(_components.strong,{children:`To fix the issue:`})}),_jsxs(_components.ol,{children:[`\n`,_jsx(_components.li,{children:`Check your browser console for errors.`}),`\n`,_jsxs(_components.li,{children:[`In your Base44 dashboard, go to `,_jsx(_components.strong,{children:`Code`}),` → `,_jsx(_components.strong,{children:`Functions`}),` and review the logs for any payment related backend functions.`]}),`\n`,_jsx(_components.li,{children:`If you use webhooks, verify that your webhook URL is correct and that the endpoint is deployed and responding.`}),`\n`]}),_jsx(_components.p,{children:`If you still cannot find the cause, copy any error messages from your console or function logs and paste them into the Base44 AI chat. Ask it to “help troubleshoot this payment flow step by step” and include details about your provider and setup.`})]}),_jsxs(Accordion,{title:`Does using Stripe use Base44 integration credits?`,id:`does-using-stripe-use-base44-integration-credits`,children:[_jsx(_components.p,{children:`Calling Stripe itself does not use Base44 integration credits. When your app calls Stripe using your own API keys through backend functions, the request goes directly from your backend function to Stripe. Base44’s built-in services are not involved.`}),_jsxs(_components.p,{children:[`Integration credits are only used when your app uses Base44’s own `,_jsx(_components.a,{href:`/Integrations/built-in-integrations`,children:`built-in services`}),`.`]}),_jsx(_components.p,{children:`If your Stripe payment flow also triggers any of these built-in services, for example, sending a confirmation email via Base44’s SendEmail, those specific actions consume integration credits as normal. Stripe itself does not.`})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Setting up Stripe","description":"Set up Stripe in your app from the AI chat. Install Stripe, create products, test checkout, claim your Stripe sandbox, and activate live payments when ready.","sidebarTitle":"Setting up Stripe","href":"/documentation/setting-up-your-app/setting-up-payments"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Step 1 | Install Stripe","slug":"step-1-|-install-stripe","depth":2,"children":[]},{"title":"Step 2 | Create your products","slug":"step-2-|-create-your-products","depth":2,"children":[]},{"title":"Step 3 | Test your checkout flow","slug":"step-3-|-test-your-checkout-flow","depth":2,"children":[]},{"title":"Step 4 | Claim your Stripe sandbox","slug":"step-4-|-claim-your-stripe-sandbox","depth":2,"children":[]},{"title":"Step 5 | Activate live payments","slug":"step-5-|-activate-live-payments","depth":2,"children":[]},{"title":"Setting up payment flows","slug":"setting-up-payment-flows","depth":2,"children":[]},{"title":"FAQs","slug":"faqs","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/base44/ca59cb34fe66af72/custom-analytics.js","/_mintlify/custom/base44/878f3d61142901ae/changelog-display.js","/_mintlify/custom/base44/655d636252386031/cta-cards.js"],"dynamicCss":".mint-mx-auto {\n margin-left: auto;\n margin-right: auto\n}","narration":{"path":"documentation/setting-up-your-app/setting-up-payments","locale":"en","estimatedDurationSec":1251,"durationSec":1091},"subdomain":"base44","siteName":"Base44 Support Documentation","title":"Setting up Stripe - Base44 Support Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/documentation/setting-up-your-app/setting-up-payments","matchLevel":0},"pt-BR":{"href":"/pt-BR/documentation/setting-up-your-app/setting-up-payments","matchLevel":1},"es":{"href":"/es/documentation/setting-up-your-app/setting-up-payments","matchLevel":1},"he":{"href":"/he/documentation/setting-up-your-app/setting-up-payments","matchLevel":1,"hidden":true},"ja":{"href":"/ja/documentation/setting-up-your-app/setting-up-payments","matchLevel":1},"de":{"href":"/de/documentation/setting-up-your-app/setting-up-payments","matchLevel":1},"fr":{"href":"/fr/documentation/setting-up-your-app/setting-up-payments","matchLevel":1},"it":{"href":"/it/documentation/setting-up-your-app/setting-up-payments","matchLevel":1}}},"lastModified":"2026-11-03T12:26:11.306Z","originalFileLocation":"documentation/setting-up-your-app/setting-up-payments.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Set up Stripe in your app from the AI chat. Install Stripe, create products, test checkout, claim your Stripe sandbox, and activate live payments when ready.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Base44 Support Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/base44/nuCdY9ZGKAmI8mvz/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/base44/nuCdY9ZGKAmI8mvz/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/base44/nuCdY9ZGKAmI8mvz/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/base44/nuCdY9ZGKAmI8mvz/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/base44/nuCdY9ZGKAmI8mvz/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/base44/nuCdY9ZGKAmI8mvz/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/base44/nuCdY9ZGKAmI8mvz/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/base44/nuCdY9ZGKAmI8mvz/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/base44/nuCdY9ZGKAmI8mvz/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Setting up Stripe - Base44 Support Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Set up Stripe in your app from the AI chat. Install Stripe, create products, test checkout, claim your Stripe sandbox, and activate live payments when ready.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Base44 Support Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.base44.com/documentation/setting-up-your-app/setting-up-payments\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.base44.com/images/base44-docs-og.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Setting up Stripe - Base44 Support Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Set up Stripe in your app from the AI chat. Install Stripe, create products, test checkout, claim your Stripe sandbox, and activate live payments when ready.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.base44.com/images/base44-docs-og.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/base44/nuCdY9ZGKAmI8mvz/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Base44 Support Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF6A00\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.base44.com/documentation/setting-up-your-app/setting-up-payments\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/documentation/setting-up-your-app/setting-up-payments.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.base44.com/documentation/setting-up-your-app/setting-up-payments\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://docs.base44.com/pt-BR/documentation/setting-up-your-app/setting-up-payments\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.base44.com/es/documentation/setting-up-your-app/setting-up-payments\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://docs.base44.com/ja/documentation/setting-up-your-app/setting-up-payments\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"de\" href=\"https://docs.base44.com/de/documentation/setting-up-your-app/setting-up-payments\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.base44.com/fr/documentation/setting-up-your-app/setting-up-payments\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"it\" href=\"https://docs.base44.com/it/documentation/setting-up-your-app/setting-up-payments\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.base44.com/documentation/setting-up-your-app/setting-up-payments\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.base44.com/#organization\",\"name\":\"Base44 Support Documentation\",\"url\":\"https://docs.base44.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/base44/jhCpOaGylNweq32m/logo/new-brand-light.svg?fit=max\u0026auto=format\u0026n=jhCpOaGylNweq32m\u0026q=85\u0026s=7724705143e6cfece3b0a237be2a6890\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.base44.com#website\",\"name\":\"Base44 Support Documentation\",\"url\":\"https://docs.base44.com\",\"publisher\":{\"@id\":\"https://docs.base44.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.base44.com/documentation/setting-up-your-app/setting-up-payments#webpage\",\"url\":\"https://docs.base44.com/documentation/setting-up-your-app/setting-up-payments\",\"name\":\"Setting up Stripe\",\"description\":\"Set up Stripe in your app from the AI chat. Install Stripe, create products, test checkout, claim your Stripe sandbox, and activate live payments when ready.\",\"dateModified\":\"2026-11-03T12:26:11.306Z\",\"isPartOf\":{\"@id\":\"https://docs.base44.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.base44.com/documentation/setting-up-your-app/setting-up-payments#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.base44.com/documentation/setting-up-your-app/setting-up-payments#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Selling on your app\",\"item\":\"https://docs.base44.com/Setting-up-your-app/setting-up-wix-payments\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Setting up Stripe\",\"item\":\"https://docs.base44.com/documentation/setting-up-your-app/setting-up-payments\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.base44.com/documentation/setting-up-your-app/setting-up-payments#article\",\"headline\":\"Setting up Stripe\",\"name\":\"Setting up Stripe\",\"description\":\"Set up Stripe in your app from the AI chat. Install Stripe, create products, test checkout, claim your Stripe sandbox, and activate live payments when ready.\",\"url\":\"https://docs.base44.com/documentation/setting-up-your-app/setting-up-payments\",\"mainEntityOfPage\":{\"@id\":\"https://docs.base44.com/documentation/setting-up-your-app/setting-up-payments#webpage\"},\"image\":\"https://docs.base44.com/images/base44-docs-og.png\",\"dateModified\":\"2026-11-03T12:26:11.306Z\",\"publisher\":{\"@id\":\"https://docs.base44.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.base44.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Base44 Support Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Base44 Support Documentation","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Apps","pages":[{"group":"Getting started","icon":"rocket","pages":[{"title":"Build apps, websites, and AI agents","sidebarTitle":"Welcome to Base44","mode":"wide","href":""},{"title":"Building an app","sidebarTitle":"Building an app","href":"/Getting-Started/Quick-start-guide"},{"title":"Building a website","sidebarTitle":"Building a website","href":"/Getting-Started/building-a-website"},{"title":"Building a game","sidebarTitle":"Building a game","href":"/Getting-Started/building-a-game"},{"title":"Starting from your first prompt","sidebarTitle":"Starting from your first prompt","href":"/Getting-Started/starting-from-your-first-prompt"},{"title":"Migrating a project to Base44","sidebarTitle":"Migrating a project","href":"/Getting-Started/migrating-an-existing-app"},{"title":"Using Base Code","sidebarTitle":"Using Base Code","href":"/Getting-Started/base-code"},{"title":"Importing from Figma","sidebarTitle":"Importing from Figma","href":"/Getting-Started/import-from-figma"},{"title":"Hiring a Base44 partner","sidebarTitle":"Hiring a partner","href":"/Getting-Started/Hiring-a-partner"}]},{"title":"Import from Figma into Base44","sidebarTitle":"Figma import guidelines","hidden":true,"href":"/Getting-Started/import-from-figma-guidelines"},{"group":"Building your app","icon":"screwdriver-wrench","pages":[{"title":"Using app templates","sidebarTitle":"Using templates","href":"/Getting-Started/App-templates"},{"title":"Getting to know the app editor","sidebarTitle":"Exploring the app editor","href":"/Getting-Started/app-editor-overview"},{"title":"Using the AI Chat in Base44","sidebarTitle":"Using the AI chat","href":"/Building-your-app/AI-chat-modes"},{"title":"Working with branches","sidebarTitle":"Working with branches","href":"/Building-your-app/working-with-branches"},{"title":"Commenting on your app","sidebarTitle":"Adding comments","href":"/Building-your-app/Commenting-on-your-app"},{"title":"Building a presentation","sidebarTitle":"Building a presentation","href":"/Building-your-app/building-a-presentation"},{"title":"Prompt library","sidebarTitle":"Prompt library","href":"/Getting-Started/Prompt-library"},{"title":"Writing effective prompts in Base44","sidebarTitle":"Writing better prompts","href":"/Getting-Started/Prompt-guide"}]},{"group":"Designing your app","icon":"palette","pages":[{"title":"Designing with AI","sidebarTitle":"Designing with AI","href":"/Building-your-app/Designing-with-AI"},{"title":"Customizing the design of your app","sidebarTitle":"Customizing design","href":"/Building-your-app/Design"},{"title":"Design foundations and layout","sidebarTitle":"Setting foundations \u0026 layout","href":"/Building-your-app/Design-foundations-and-layout"},{"title":"Design system","sidebarTitle":"Creating design systems","href":"/Building-your-app/Design-system"},{"title":"Adding components to your app","sidebarTitle":"Adding components","href":"/Building-your-app/Components-library"},{"title":"Uploading and managing media","sidebarTitle":"Managing media","href":"/Building-your-app/Using-media"},{"title":"Managing your app pages","sidebarTitle":"Managing pages","href":"/Building-your-app/managing-your-pages"},{"title":"Using the canvas","sidebarTitle":"Using the canvas","href":"/Building-your-app/Canvas"},{"title":"Adding and using npm packages","sidebarTitle":"Adding npm packages","href":"/Building-your-app/NPM-packages"}]},{"group":"Managing app data","icon":"database","pages":[{"title":"Managing your app data","sidebarTitle":"Working with your data","href":"/Building-your-app/Managing-your-app-data"},{"title":"Testing your app with test data","sidebarTitle":"Testing with test data","href":"/documentation/managing-app-data/testing-your-data"},{"title":"Testing your app's flows","sidebarTitle":"Using the testing agent","href":"/documentation/managing-app-data/testing-agent"},{"title":"Backup \u0026 Restore","sidebarTitle":"Backing up and restoring data","href":"/Enterprise/backup-and-restore"}]},{"group":"Adding logic to your app","icon":"gears","pages":[{"title":"Sending emails from your app","sidebarTitle":"Sending emails","href":"/documentation/building-your-app/sending-emails"},{"title":"Designing your app's emails","sidebarTitle":"Designing emails","href":"/Building-your-app/Designing-emails"},{"title":"Setting up an AI agent for your app","sidebarTitle":"Building AI agents","href":"/Building-your-app/AI-agents-for-apps"},{"title":"Creating workflows for your app","sidebarTitle":"Creating workflows","href":"/Building-your-app/Creating-workflows"},{"title":"Browsing websites from your app","sidebarTitle":"Browsing websites","href":"/Building-your-app/browser-automation"},{"title":"Base44 developer tools","sidebarTitle":"Using developer tools","href":"/documentation/building-your-app/developer-tools"},{"title":"Using your app's API page","sidebarTitle":"Using your app's API","href":"/Building-your-app/your-apps-api-page"}]},{"group":"Selling on your app","icon":"credit-card","pages":[{"title":"Setting up Base44 Payments powered by Wix","description":"Set up Base44 Payments powered by Wix to start selling in your app. Connect payments, complete verification, and manage payouts, refunds, and subscriptions.","sidebarTitle":"Setting up Base44 Payments","href":"/Setting-up-your-app/setting-up-wix-payments"},{"title":"Setting up Stripe","sidebarTitle":"Setting up Stripe","href":"/documentation/setting-up-your-app/setting-up-payments"},{"title":"Tracking payments in your app","description":"Track your app's sales on the Payments tab. Compare revenue across time periods, review every transaction, and see which customers are on your recurring plans.","sidebarTitle":"Tracking payments","href":"/Setting-up-your-app/tracking-payments"}]},{"group":"Using on mobile","icon":"mobile","pages":[{"title":"Creating and using your app on mobile","sidebarTitle":"Using apps on mobile","href":"/Building-your-app/Mobile-experience"},{"title":"Submitting your app to app stores","sidebarTitle":"Submitting to app stores","href":"/documentation/building-your-app/uploading-to-app-stores"}]},{"group":"Domains","icon":"globe","pages":[{"title":"Connecting a domain to your app","sidebarTitle":"Domains overview","href":"/Setting-up-your-app/Setting-up-your-custom-domain"},{"title":"Buying a domain with Wix","sidebarTitle":"Buying a domain with Wix","href":"/Setting-up-your-app/Buying-a-domain-with-Wix"},{"title":"Managing a GoDaddy or IONOS domain","sidebarTitle":"Managing a GoDaddy domain","href":"/Setting-up-your-app/Buying-a-domain-from-Base44"},{"title":"Connecting an external domain","sidebarTitle":"Connecting an external domain","href":"/Setting-up-your-app/Connecting-an-external-domain"},{"title":"Sending emails from a custom domain","sidebarTitle":"Sending emails from a domain","href":"/Setting-up-your-app/Sending-emails-from-a-custom-domain"},{"title":"Buying a business email","sidebarTitle":"Buying a business email","href":"/Setting-up-your-app/Buying-a-business-email"}]},{"group":"Securing your app","icon":"shield","pages":[{"title":"Base44 security: An overview","sidebarTitle":"Security overview","href":"/Setting-up-your-app/security-overview"},{"title":"Managing login and registration","sidebarTitle":"Managing login \u0026 registration","href":"/Setting-up-your-app/Managing-login-and-registration"},{"title":"Choosing who can access your app","sidebarTitle":"Managing access \u0026 roles","href":"/Setting-up-your-app/Managing-access"},{"title":"Managing data permissions","href":"/Setting-up-your-app/Managing-security-settings"},{"title":"Running a security scan","sidebarTitle":"Running a security scan","href":"/Setting-up-your-app/running-a-security-scan"},{"title":"Scanning your app for vulnerabilities with Wiz","sidebarTitle":"Scanning with Wiz","href":"/Setting-up-your-app/scanning-with-wiz"},{"title":"Testing your app's security with Tenzai","sidebarTitle":"Testing with Tenzai","href":"/Setting-up-your-app/security-testing-with-tenzai"},{"title":"Setting up single sign-on (SSO) for your app","sidebarTitle":"Setting up SSO","href":"/Setting-up-your-app/Setting-up-SSO"}]},{"group":"Measuring your app","icon":"chart-line","pages":[{"title":"Exploring app logs","sidebarTitle":"Exploring logs","href":"/Building-your-app/exploring-app-logs"},{"title":"Viewing and customizing your app analytics","sidebarTitle":"Viewing analytics","href":"/documentation/performance-and-seo/app-analytics"},{"title":"Recording and replaying user sessions","sidebarTitle":"Reviewing session recordings","href":"/documentation/performance-and-seo/session-recordings"},{"title":"Managing cookies and visitor consent","sidebarTitle":"Cookies and consent","href":"/documentation/performance-and-seo/cookies-and-consent"},{"title":"Optimizing App Performance","sidebarTitle":"Monitoring performance","href":"/Performance-and-SEO/App-performance"}]},{"group":"Growing your app's reach","icon":"megaphone","pages":[{"title":"Using the Marketing Agent for your app","sidebarTitle":"Creating a marketing plan","href":"/promoting-your-app/creating-a-marketing-plan"},{"title":"Getting your app found in search","sidebarTitle":"Following SEO best practices","href":"/Performance-and-SEO/SEO-and-search-visibility"},{"title":"Optimizing your app's SEO \u0026 GEO","sidebarTitle":"Optimizing SEO \u0026 GEO","href":"/Performance-and-SEO/checking-your-seo-and-geo"},{"title":"Connecting Google Search Console","sidebarTitle":"Connecting Google Search Console","href":"/Performance-and-SEO/connecting-google-search-console"},{"title":"Promoting your app on social media","sidebarTitle":"Creating social content","href":"/promoting-your-app/social-content"},{"title":"Creating Google Ads campaigns","sidebarTitle":"Create Google Ads campaigns","href":"/promoting-your-app/google-ads-campaigns"},{"title":"Submitting your app to Launchpad","sidebarTitle":"Submitting to Launchpad","href":"/promoting-your-app/submitting-to-launchpad"}]},{"group":"Changelog","boost":0.3,"icon":"clock-rotate-left","pages":[{"title":"Product changelog","sidebarTitle":"Product","href":"/changelog/product"},{"title":"Developer changelog","sidebarTitle":"Developer","href":"/changelog/developers"}]}]},{"tab":"Superagents","pages":[{"title":"Superagents","href":"/Getting-Started/superagent"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/Integrations/Using-integrations"}]},{"tab":"Developers","dropdowns":[{"dropdown":"Home","icon":"house","pages":[{"title":"Base44 Developer Platform","mode":"wide","href":"/developers/home"}],"global":{"anchors":[{"anchor":"Backend","icon":"server","href":"/developers/backend/overview/introduction"},{"anchor":"App Code","icon":"code","href":"/developers/app-code/overview/introduction"},{"anchor":"SDKs","icon":"brackets-curly","href":"/developers/references/sdks/overview"},{"anchor":"CLI","icon":"terminal","href":"/developers/references/cli/get-started/overview"},{"anchor":"APIs","icon":"plug","href":"/developers/references/apis/overview"},{"anchor":"White label (Beta)","icon":"tag","href":"/developers/white-label/overview"}]}},{"dropdown":"Backend (Beta)","icon":"server","groups":[{"group":"Overview","icon":"compass","pages":[{"title":"Introduction","href":"/developers/backend/overview/introduction"},{"title":"Backend Service Basics","sidebarTitle":"Backend Service Basics","href":"/developers/backend/overview/backend-service-basics"},{"title":"Features","href":"/developers/backend/overview/features"},{"title":"Pricing","href":"/developers/backend/overview/pricing"},{"title":"Troubleshoot your project","sidebarTitle":"Troubleshooting","href":"/developers/backend/overview/troubleshooting"}]},{"group":"Quickstarts","icon":"rocket","pages":[{"title":"Build with AI","sidebarTitle":"Build with AI","href":"/developers/backend/quickstart/quickstart-with-ai"},{"group":"Templates","pages":[{"title":"Backend only","href":"/developers/backend/quickstart/templates/quickstart-backend-only"},{"title":"React Quickstart","sidebarTitle":"React","href":"/developers/backend/quickstart/templates/quickstart-react-template"}]},{"group":"Frameworks","pages":[{"title":"React Quickstart","sidebarTitle":"React","href":"/developers/backend/quickstart/frameworks/quickstart-with-react"},{"title":"Vue Quickstart","sidebarTitle":"Vue","href":"/developers/backend/quickstart/frameworks/quickstart-vue"},{"title":"Solid JS Quickstart","sidebarTitle":"Solid JS","href":"/developers/backend/quickstart/frameworks/quickstart-solid-js"},{"title":"Refine Quickstart","sidebarTitle":"Refine","href":"/developers/backend/quickstart/frameworks/quickstart-refine"},{"title":"Hono Quickstart","sidebarTitle":"Hono","href":"/developers/backend/quickstart/frameworks/quickstart-hono"},{"title":"React Native (Expo) Quickstart","sidebarTitle":"React Native (Expo)","href":"/developers/backend/quickstart/frameworks/quickstart-with-react-native"}]}]},{"group":"Project","icon":"folder-open","pages":[{"title":"Project Structure","href":"/developers/backend/overview/project-structure"},{"title":"Start from an Existing Base44 App","sidebarTitle":"Start from an Existing Base44 App","href":"/developers/backend/overview/start-from-existing-app"},{"title":"Set Up Local Dev for an Existing App","sidebarTitle":"Set Up Local Dev for an Existing App","href":"/developers/backend/overview/set-up-local-dev-existing-app"},{"title":"Link an Existing Backend Project","sidebarTitle":"Link an Existing Backend Project","href":"/developers/backend/overview/link-existing-project"},{"group":"Local Development","expanded":false,"pages":[{"title":"Local development","sidebarTitle":"Overview","href":"/developers/backend/overview/local-dev/local-development-overview"},{"title":"Local development setup","sidebarTitle":"Setup","href":"/developers/backend/overview/local-dev/get-started"}]},{"title":"Standalone scripts","sidebarTitle":"Standalone scripts","href":"/developers/backend/overview/run-scripts"}]},{"group":"AI Development Tools","icon":"wand-magic-sparkles","pages":[{"title":"AI development tools overview","sidebarTitle":"Overview","href":"/developers/backend/overview/agent-extensions"},{"title":"Skills","sidebarTitle":"Skills","href":"/developers/backend/overview/skills"},{"title":"Base44 MCP server","sidebarTitle":"Base44 MCP server","href":"/developers/backend/overview/mcp-server"},{"title":"Base44 Docs MCP","sidebarTitle":"Docs MCP server","href":"/developers/backend/overview/base44-docs-mcp"}]},{"group":"Resources","icon":"cubes","pages":[{"group":"Agents","expanded":false,"pages":[{"title":"About Agents","sidebarTitle":"Agents","href":"/developers/backend/resources/agents/overview"},{"title":"Agent Skills","sidebarTitle":"Agent Skills","href":"/developers/backend/resources/agents/agent-skills"}]},{"group":"Actors","expanded":false,"pages":[{"title":"Actors Overview","sidebarTitle":"Overview","href":"/developers/backend/resources/actors/overview"},{"title":"Create an Actor","sidebarTitle":"Create an Actor","href":"/developers/backend/resources/actors/create-actor"},{"title":"Actors: Sample Flows","sidebarTitle":"Sample Flows","href":"/developers/backend/resources/actors/sample-flows"},{"title":"Actors Files and Code","sidebarTitle":"Actors Files and Code","href":"/developers/backend/resources/actors/reference"}]},{"title":"Supported Models","sidebarTitle":"Models","href":"/developers/backend/resources/models"},{"title":"Auth","sidebarTitle":"Auth","href":"/developers/backend/resources/auth"},{"group":"Backend Functions","expanded":false,"pages":[{"title":"Backend Functions Overview","sidebarTitle":"Overview","href":"/developers/backend/resources/backend-functions/overview"},{"title":"Automations","href":"/developers/backend/resources/backend-functions/automations"}]},{"group":"Connectors","expanded":false,"pages":[{"title":"Connectors overview","sidebarTitle":"Overview","href":"/developers/backend/resources/connectors"},{"title":"Shared connectors","sidebarTitle":"Shared connectors","href":"/developers/backend/resources/connectors/shared-connectors"},{"title":"App user connectors","sidebarTitle":"App user connectors","href":"/developers/backend/resources/connectors/app-user-connectors"}]},{"group":"Entities","expanded":false,"pages":[{"title":"Entities Overview","sidebarTitle":"Overview","href":"/developers/backend/resources/entities/overview"},{"title":"Entity Schemas","href":"/developers/backend/resources/entities/entity-schemas"},{"title":"User Schema","href":"/developers/backend/resources/entities/user-schema"},{"title":"Security","href":"/developers/backend/resources/entities/security"}]}]}],"global":{"anchors":[{"anchor":"Developer Platform","icon":"arrow-left","href":"/developers/home"}]}},{"dropdown":"App Code","icon":"grid-2","groups":[{"group":"Overview","icon":"compass","pages":[{"title":"Introduction","sidebarTitle":"Base44 for Devs","href":"/developers/app-code/overview/introduction"},{"title":"Project Structure","href":"/developers/app-code/overview/project-structure"}]},{"group":"Base44 Editor","icon":"code","pages":[{"title":"Code Tab","href":"/developers/app-code/editor/code-tab"},{"title":"Activity Monitor","sidebarTitle":"Activity Monitor","href":"/developers/app-code/editor/activity-monitor"}]},{"group":"Local Development","icon":"laptop","pages":[{"title":"GitHub Integration","sidebarTitle":"GitHub Integration","href":"/developers/app-code/local-development/github"}]},{"group":"Cloud Sandbox","icon":"cloud","pages":[{"title":"Cloud sandbox","sidebarTitle":"Overview","href":"/developers/app-code/sandbox/overview"},{"title":"Bring your own agent","sidebarTitle":"Bring your own agent","href":"/developers/app-code/sandbox/bring-your-own-agent"}]},{"group":"Enterprise","icon":"building","pages":[{"title":"Enterprise APIs","href":"/developers/references/enterprise-apis"}]}],"global":{"anchors":[{"anchor":"Developer Platform","icon":"arrow-left","href":"/developers/home"}]}},{"dropdown":"SDKs","icon":"brackets-curly","groups":[{"group":"Base44 SDKs","icon":"book-open","expanded":false,"pages":[{"title":"Base44 SDKs","sidebarTitle":"Overview","href":"/developers/references/sdks/overview"}]},{"group":"App SDK","icon":"brackets-curly","expanded":false,"pages":[{"group":"Get Started","icon":"book-open","expanded":false,"pages":[{"title":"SDK overview","href":"/developers/references/sdk/getting-started/overview"},{"title":"Base44 client","href":"/developers/references/sdk/getting-started/client"},{"title":"Work with data","href":"/developers/references/sdk/getting-started/work-with-data"},{"title":"Dynamic Types","href":"/developers/references/sdk/getting-started/dynamic-types"},{"title":"Common SDK uses","href":"/developers/references/sdk/getting-started/work-with-sdk"},{"title":"Connect to third-party APIs","href":"/developers/references/sdk/getting-started/third-party-apis"},{"title":"Generate images with the AI Gateway","sidebarTitle":"Generate images","href":"/developers/references/sdk/getting-started/ai-gateway-images"},{"title":"Generate video with the AI Gateway","sidebarTitle":"Generate video","href":"/developers/references/sdk/getting-started/ai-gateway-video"}]},{"group":"SDK Reference","boost":0.5,"icon":"brackets-curly","expanded":true,"pages":[{"group":"Client","expanded":false,"pages":[{"title":"createClient","href":"/developers/references/sdk/docs/functions/createClient"},{"title":"createClientFromRequest","href":"/developers/references/sdk/docs/functions/createClientFromRequest"}]},{"group":"Modules","expanded":false,"pages":[{"title":"actors","href":"/developers/references/sdk/docs/type-aliases/actors"},{"title":"agents","href":"/developers/references/sdk/docs/interfaces/agents"},{"title":"ai-gateway","href":"/developers/references/sdk/docs/interfaces/ai-gateway"},{"title":"analytics","href":"/developers/references/sdk/docs/interfaces/analytics"},{"title":"app","href":"/developers/references/sdk/docs/interfaces/app"},{"title":"app-logs","href":"/developers/references/sdk/docs/interfaces/app-logs"},{"title":"auth","href":"/developers/references/sdk/docs/interfaces/auth"},{"title":"browser","href":"/developers/references/sdk/docs/interfaces/browser"},{"title":"connectors","href":"/developers/references/sdk/docs/interfaces/connectors"},{"title":"entities","href":"/developers/references/sdk/docs/type-aliases/entities"},{"title":"functions","href":"/developers/references/sdk/docs/interfaces/functions"},{"title":"integrations","href":"/developers/references/sdk/docs/type-aliases/integrations"},{"title":"payments","href":"/developers/references/sdk/docs/interfaces/payments"},{"title":"sso","href":"/developers/references/sdk/docs/interfaces/sso"}]}]}]},{"group":"Platform SDK (Beta)","boost":0.75,"icon":"layer-group","expanded":false,"pages":[{"group":"Get Started","icon":"book-open","expanded":false,"pages":[{"title":"Platform SDK overview","sidebarTitle":"Overview","href":"/developers/references/platform-sdk/overview"}]},{"group":"Platform SDK Reference","icon":"brackets-curly","expanded":true,"pages":[{"group":"Client","expanded":false,"pages":[{"title":"createPlatformClient","href":"/developers/references/platform-sdk/docs/functions/createPlatformClient"},{"title":"createPlatformServer","href":"/developers/references/platform-sdk/docs/functions/createPlatformServer"}]},{"group":"Modules","expanded":false,"pages":[{"title":"chat","href":"/developers/references/platform-sdk/docs/interfaces/chat"},{"title":"webhooks","href":"/developers/references/platform-sdk/docs/interfaces/webhooks"}]},{"group":"React","expanded":false,"pages":[{"title":"useChat","href":"/developers/references/platform-sdk/docs/functions/useChat"}]}]}]}],"global":{"anchors":[{"anchor":"Developer Platform","icon":"arrow-left","href":"/developers/home"}]}},{"dropdown":"CLI","icon":"terminal","groups":[{"group":"Get Started","icon":"book-open","expanded":true,"pages":[{"title":"CLI Overview","href":"/developers/references/cli/get-started/overview"},{"title":"CLI Commands Overview","href":"/developers/references/cli/commands/introduction"}]},{"group":"Commands","boost":0.75,"icon":"terminal","pages":[{"group":"Account","pages":[{"title":"login","href":"/developers/references/cli/commands/login"},{"title":"logout","href":"/developers/references/cli/commands/logout"},{"title":"whoami","href":"/developers/references/cli/commands/whoami"}]},{"group":"Projects","pages":[{"title":"create","href":"/developers/references/cli/commands/create"},{"title":"link","href":"/developers/references/cli/commands/link"},{"title":"eject","href":"/developers/references/cli/commands/eject"},{"title":"scaffold","href":"/developers/references/cli/commands/scaffold"},{"title":"dashboard open","href":"/developers/references/cli/commands/dashboard-open"}]},{"group":"Workspaces","pages":[{"title":"workspace get","href":"/developers/references/cli/commands/workspace-get"},{"title":"workspace list","href":"/developers/references/cli/commands/workspace-list"},{"title":"workspace move","href":"/developers/references/cli/commands/workspace-move"}]},{"group":"Functions","pages":[{"title":"functions pull","href":"/developers/references/cli/commands/functions-pull"},{"title":"functions deploy","href":"/developers/references/cli/commands/functions-deploy"},{"title":"functions delete","href":"/developers/references/cli/commands/functions-delete"},{"title":"functions list","href":"/developers/references/cli/commands/functions-list"}]},{"group":"Entities","pages":[{"title":"entities push","href":"/developers/references/cli/commands/entities-push"}]},{"group":"Agents","pages":[{"title":"agents pull","href":"/developers/references/cli/commands/agents-pull"},{"title":"agents push","href":"/developers/references/cli/commands/agents-push"},{"title":"agent-skills pull","href":"/developers/references/cli/commands/agent-skills-pull"},{"title":"agent-skills push","href":"/developers/references/cli/commands/agent-skills-push"}]},{"group":"Actors","pages":[{"title":"actors delete","href":"/developers/references/cli/commands/actors-delete"},{"title":"actors deploy","href":"/developers/references/cli/commands/actors-deploy"}]},{"group":"Workflows","pages":[{"title":"workflows list","href":"/developers/references/cli/commands/workflows-list"},{"title":"workflows runs","href":"/developers/references/cli/commands/workflows-runs"}]},{"group":"Connectors","pages":[{"title":"connectors initiate","href":"/developers/references/cli/commands/connectors-initiate"},{"title":"connectors list-available","href":"/developers/references/cli/commands/connectors-list-available"},{"title":"connectors pull","href":"/developers/references/cli/commands/connectors-pull"},{"title":"connectors push","href":"/developers/references/cli/commands/connectors-push"}]},{"group":"Auth","pages":[{"title":"auth password-login","href":"/developers/references/cli/commands/auth-password-login"},{"title":"auth pull","href":"/developers/references/cli/commands/auth-pull"},{"title":"auth push","href":"/developers/references/cli/commands/auth-push"},{"title":"auth social-login","href":"/developers/references/cli/commands/auth-social-login"},{"title":"auth sso","href":"/developers/references/cli/commands/auth-sso"}]},{"group":"Secrets","pages":[{"title":"secrets set","href":"/developers/references/cli/commands/secrets-set"},{"title":"secrets list","href":"/developers/references/cli/commands/secrets-list"},{"title":"secrets delete","href":"/developers/references/cli/commands/secrets-delete"}]},{"group":"Development","pages":[{"title":"dev","href":"/developers/references/cli/commands/dev"},{"title":"exec","href":"/developers/references/cli/commands/exec"},{"title":"types generate","href":"/developers/references/cli/commands/types-generate"},{"title":"site open","href":"/developers/references/cli/commands/site-open"},{"title":"logs","href":"/developers/references/cli/commands/logs"}]},{"group":"API","pages":[{"title":"api catalog","href":"/developers/references/cli/commands/api-catalog"},{"title":"api fetch","href":"/developers/references/cli/commands/api-fetch"},{"title":"api grep","href":"/developers/references/cli/commands/api-grep"},{"title":"api search","href":"/developers/references/cli/commands/api-search"}]},{"group":"Sandbox","pages":[{"title":"sandbox ls","href":"/developers/references/cli/commands/sandbox-ls"},{"title":"sandbox read","href":"/developers/references/cli/commands/sandbox-read"},{"title":"sandbox grep","href":"/developers/references/cli/commands/sandbox-grep"},{"title":"sandbox write","href":"/developers/references/cli/commands/sandbox-write"},{"title":"sandbox edit","href":"/developers/references/cli/commands/sandbox-edit"},{"title":"sandbox run","href":"/developers/references/cli/commands/sandbox-run"},{"title":"sandbox checkpoint","href":"/developers/references/cli/commands/sandbox-checkpoint"},{"title":"branches list","href":"/developers/references/cli/commands/branches-list"}]},{"group":"Deployment","pages":[{"title":"build","sidebarTitle":"build","href":"/developers/references/cli/commands/build"},{"title":"deploy","href":"/developers/references/cli/commands/deploy"},{"title":"site deploy","href":"/developers/references/cli/commands/site-deploy"},{"title":"visibility","href":"/developers/references/cli/commands/visibility"}]}]}],"global":{"anchors":[{"anchor":"Developer Platform","icon":"arrow-left","href":"/developers/home"}]}},{"dropdown":"APIs","icon":"plug","groups":[{"group":"Base44 APIs","icon":"book-open","pages":[{"title":"Base44 APIs","sidebarTitle":"Overview","href":"/developers/references/apis/overview"}]},{"group":"Apps API (Beta)","boost":0.75,"icon":"rocket","expanded":false,"pages":[{"group":"Get Started","icon":"book-open","pages":[{"title":"Apps API Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/get-started/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/developers/references/apps-api/get-started/authentication"},{"title":"Apps API Concepts","sidebarTitle":"Concepts","href":"/developers/references/apps-api/get-started/concepts"},{"title":"Rate Limits","href":"/developers/references/apps-api/get-started/rate-limits"}]},{"group":"Apps","icon":"grid-2","pages":[{"title":"Apps","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/apps"},{"group":"Management","pages":[{"title":"List apps","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps","href":"/api-reference/list-apps"},{"title":"Create app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps","href":"/api-reference/create-app"},{"title":"Get app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}","href":"/api-reference/get-app"},{"title":"Update app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}","href":"/api-reference/update-app"},{"title":"Patch app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}","href":"/api-reference/patch-app"},{"title":"Get remix requirements","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/remix/requirements","href":"/api-reference/get-remix-requirements"},{"title":"Remix an app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/remix","href":"/api-reference/remix-an-app"},{"title":"Export app source code","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/coding/export-to-zip","href":"/api-reference/export-app-source-code"},{"title":"Check app delete impact","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/delete-check","href":"/api-reference/check-app-delete-impact"},{"title":"Delete app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}","href":"/api-reference/delete-app"},{"title":"Restore deleted app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps-trash/{app_id}/restore","href":"/api-reference/restore-deleted-app"}]},{"group":"Branding","pages":[{"title":"Change app slug","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/metadata/slug","href":"/api-reference/change-app-slug"},{"title":"Generate app logo","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/metadata/generate-logo","href":"/api-reference/generate-app-logo"},{"title":"Set app logo","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/metadata/update-logo","href":"/api-reference/set-app-logo"},{"title":"Set social image","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/metadata/social-image","href":"/api-reference/set-social-image"},{"title":"Upload app file","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/files/apps/{app_id}/upload","href":"/api-reference/upload-app-file"},{"title":"List assets","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/assets","href":"/api-reference/list-assets"},{"title":"Create asset","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/assets","href":"/api-reference/create-asset"},{"title":"Upload asset","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/assets/upload","href":"/api-reference/upload-asset"},{"title":"Rename asset","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/assets/{asset_id}","href":"/api-reference/rename-asset"},{"title":"Delete asset","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/assets/{asset_id}","href":"/api-reference/delete-asset"}]},{"group":"Secrets","pages":[{"title":"List secrets","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/secrets","href":"/api-reference/list-secrets"},{"title":"Set secret","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/secrets","href":"/api-reference/set-secret"},{"title":"Delete secret","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/secrets","href":"/api-reference/delete-secret"}]},{"group":"Ownership transfer","pages":[{"title":"Check ownership transfer","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/ownership/transfer/preflight","href":"/api-reference/check-ownership-transfer"},{"title":"Start ownership transfer","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/ownership/transfer","href":"/api-reference/start-ownership-transfer"},{"title":"Transfer ownership to a workspace member","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/ownership/transfer/workspace-member","href":"/api-reference/transfer-ownership-to-a-workspace-member"},{"title":"Get pending ownership transfer","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/ownership/transfer/pending","href":"/api-reference/get-pending-ownership-transfer"},{"title":"Resend ownership transfer","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/ownership/transfer/resend","href":"/api-reference/resend-ownership-transfer"},{"title":"Cancel ownership transfer","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/ownership/transfer/cancel","href":"/api-reference/cancel-ownership-transfer"}]},{"group":"Template listings","pages":[{"title":"Get template listing pending update","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/app-catalog-items/catalog/{item_id}/pending-changes","href":"/api-reference/get-template-listing-pending-update"},{"title":"Submit template listing update","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/app-catalog-items/catalog/{item_id}/submit-update","href":"/api-reference/submit-template-listing-update"},{"title":"Archive template listing","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/app-catalog-items/catalog/{item_id}/archive","href":"/api-reference/archive-template-listing"}]},{"group":"SSO and MCP","pages":[{"title":"Get app SSO settings","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/sso/settings","href":"/api-reference/get-app-sso-settings"},{"title":"Update app SSO settings","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/sso/settings","href":"/api-reference/update-app-sso-settings"},{"title":"Get MCP status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/platform/{app_id}/mcp-status","href":"/api-reference/get-mcp-status"},{"title":"Get MCP config","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/platform/{app_id}/mcp/config","href":"/api-reference/get-mcp-config"},{"title":"Update MCP config","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/platform/{app_id}/mcp/config","href":"/api-reference/update-mcp-config"},{"title":"Get app API reference","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/openapi-spec","href":"/api-reference/get-app-api-reference"}]}]},{"group":"Code and sandbox","icon":"code","pages":[{"title":"Code and sandbox","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/code-and-sandbox"},{"title":"List app code files","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/code/file-list","href":"/api-reference/list-app-code-files"},{"title":"Get an app code file","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/code/content","href":"/api-reference/get-an-app-code-file"},{"title":"Get app code files","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/code/content/batch","href":"/api-reference/get-app-code-files"},{"title":"Search app code","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/code/search","href":"/api-reference/search-app-code"},{"title":"Save an app file","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/coding/write","href":"/api-reference/save-an-app-file"},{"title":"Save several app files","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/coding/write-batch","href":"/api-reference/save-several-app-files"},{"title":"List app files","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/sandbox-bridge/list_directory","href":"/api-reference/list-app-files"},{"title":"Read app files","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/sandbox-bridge/read_file","href":"/api-reference/read-app-files"},{"title":"Search app files","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/sandbox-bridge/grep","href":"/api-reference/search-app-files"},{"title":"Write an app file","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/sandbox-bridge/write_file","href":"/api-reference/write-an-app-file"},{"title":"Edit an app file","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/sandbox-bridge/edit_file","href":"/api-reference/edit-an-app-file"},{"title":"Run a sandbox command","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/sandbox-bridge/run_command","href":"/api-reference/run-a-sandbox-command"},{"title":"Create a sandbox checkpoint","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/sandbox-bridge/create_checkpoint","href":"/api-reference/create-a-sandbox-checkpoint"},{"title":"List backend functions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/backend-functions","href":"/api-reference/list-backend-functions"},{"title":"Get backend function logs","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/functions-mgmt/{function_name}/logs","href":"/api-reference/get-backend-function-logs"},{"title":"Redeploy a backend function","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/coding/redeploy-function/{function_name}","href":"/api-reference/redeploy-a-backend-function"},{"title":"Delete a backend function","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/backend-functions/{function_name}","href":"/api-reference/delete-a-backend-function"},{"title":"List branches","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/branches","href":"/api-reference/list-branches"},{"title":"Create branch","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/branches","href":"/api-reference/create-branch"},{"title":"Get branch","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/branches/{branch_id}","href":"/api-reference/get-branch"},{"title":"Get branch sync status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/branches/{branch_id}/sync-status","href":"/api-reference/get-branch-sync-status"},{"title":"Update branch from main","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/branches/{branch_id}/sync-from-main","href":"/api-reference/update-branch-from-main"},{"title":"Merge branch","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/branches/{branch_id}/merge","href":"/api-reference/merge-branch"},{"title":"Delete branch","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/branches/{branch_id}","href":"/api-reference/delete-branch"},{"title":"Set main branch protection (owner or admin only)","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/branches/main/protection","href":"/api-reference/set-main-branch-protection-owner-or-admin-only"}]},{"group":"Chat","icon":"comments","pages":[{"title":"Chat","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/chat"},{"title":"Retry chat requests","sidebarTitle":"Retries","href":"/developers/references/apps-api/sections/chat-retries"},{"title":"Read conversation messages","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/chat/full-conversation","href":"/api-reference/read-conversation-messages"},{"title":"Send chat message","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/chat/message","href":"/api-reference/send-chat-message"},{"title":"Stop generation","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/chat/stop","href":"/api-reference/stop-generation"},{"title":"Submit tool-call input","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/chat/submit-tool-call-input","href":"/api-reference/submit-tool-call-input"},{"title":"Submit tool-call input (batch)","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/chat/submit-tool-call-input/batch","href":"/api-reference/submit-tool-call-input-batch"},{"title":"Edit and resend","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/chat/edit-and-resend","href":"/api-reference/edit-and-resend"},{"title":"Undo message","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/chat/message/{message_id}/undo","href":"/api-reference/undo-message"},{"title":"Get message queue","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/chat/queue","href":"/api-reference/get-message-queue"},{"title":"Edit queued message","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/chat/queue/{item_id}","href":"/api-reference/edit-queued-message"},{"title":"Reorder message queue","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/chat/queue/reorder","href":"/api-reference/reorder-message-queue"},{"title":"Pause message queue","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/chat/queue/pause","href":"/api-reference/pause-message-queue"},{"title":"Resume message queue","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/chat/queue/resume","href":"/api-reference/resume-message-queue"},{"title":"Remove queued message","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/chat/queue/{item_id}","href":"/api-reference/remove-queued-message"},{"title":"Clear message queue","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/chat/queue","href":"/api-reference/clear-message-queue"}]},{"group":"Comments","icon":"comment-dots","pages":[{"title":"List comments","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/comments","href":"/api-reference/list-comments"},{"title":"List mentionable users","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/comments/mentionable","href":"/api-reference/list-mentionable-users"},{"title":"Create comment","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/comments","href":"/api-reference/create-comment"},{"title":"Reply to comment","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/comments/threads/{thread_id}/replies","href":"/api-reference/reply-to-comment"},{"title":"Edit comment","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/comments/threads/{thread_id}/messages/{message_id}","href":"/api-reference/edit-comment"},{"title":"Update comment anchor","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/comments/threads/{thread_id}/anchor","href":"/api-reference/update-comment-anchor"},{"title":"Toggle comment reaction","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/comments/threads/{thread_id}/messages/{message_id}/reactions","href":"/api-reference/toggle-comment-reaction"},{"title":"Resolve comment thread","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/comments/threads/{thread_id}/resolve","href":"/api-reference/resolve-comment-thread"},{"title":"Reopen comment thread","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/comments/threads/{thread_id}/unresolve","href":"/api-reference/reopen-comment-thread"},{"title":"Mark comment thread read","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/comments/threads/{thread_id}/read","href":"/api-reference/mark-comment-thread-read"},{"title":"Mark all comments read","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/comments/read-all","href":"/api-reference/mark-all-comments-read"},{"title":"Create comment screenshot link","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/comments/threads/{thread_id}/chat-screenshot-url","href":"/api-reference/create-comment-screenshot-link"},{"title":"Delete comment reply","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/comments/threads/{thread_id}/messages/{message_id}","href":"/api-reference/delete-comment-reply"},{"title":"Delete comment thread","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/comments/threads/{thread_id}","href":"/api-reference/delete-comment-thread"}]},{"group":"Email","icon":"envelope","pages":[{"title":"List email templates","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/emails","href":"/api-reference/list-email-templates"},{"title":"Get email template","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/emails/{template_id}","href":"/api-reference/get-email-template"},{"title":"Send email template test","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/emails/{template_id}/test","href":"/api-reference/send-email-template-test"},{"title":"Delete email template","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/emails/{template_id}","href":"/api-reference/delete-email-template"},{"title":"Preview application email","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/emails/system/{email_type}/preview","href":"/api-reference/preview-application-email"},{"title":"Customize application email","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/emails/system/{email_type}/materialize","href":"/api-reference/customize-application-email"},{"title":"Send application email test","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/emails/system/{email_type}/test","href":"/api-reference/send-application-email-test"},{"title":"Get email stats","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/emails/stats","href":"/api-reference/get-email-stats"}]},{"group":"Checkpoints","icon":"clock-rotate-left","pages":[{"title":"Checkpoints","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/checkpoints"},{"title":"List checkpoints","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/app-checkpoints","href":"/api-reference/list-checkpoints"},{"title":"Create checkpoint","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/app-checkpoints","href":"/api-reference/create-checkpoint"},{"title":"Get checkpoint files","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/app-checkpoints/{checkpoint_id}/file-tree","href":"/api-reference/get-checkpoint-files"},{"title":"Restore checkpoint","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/app-checkpoints/{checkpoint_id}/load","href":"/api-reference/restore-checkpoint"},{"title":"Retry checkpoint build","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/app-checkpoints/{checkpoint_id}/retry-build","href":"/api-reference/retry-checkpoint-build"}]},{"group":"Deployment","icon":"cloud-arrow-up","pages":[{"title":"Deployment","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/deployment"},{"title":"Get preview URL","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/sandbox/preview-url","href":"/api-reference/get-preview-url"},{"title":"Deploy an app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/deploy","href":"/api-reference/deploy-an-app"},{"title":"Deploy a prebuilt site","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/deploy-dist","href":"/api-reference/deploy-a-prebuilt-site"},{"title":"Request deploy approval","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/request-deploy","href":"/api-reference/request-deploy-approval"},{"title":"Get published URL","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/platform/{app_id}/published-url","href":"/api-reference/get-published-url"},{"title":"Unpublish app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/undeploy","href":"/api-reference/unpublish-app"}]},{"group":"Entities","icon":"table","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/entities"},{"group":"Schemas","pages":[{"title":"List entity schemas","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entity-schemas","href":"/api-reference/list-entity-schemas"},{"title":"Get entity schema","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entity-schemas/{entity_name}","href":"/api-reference/get-entity-schema"},{"title":"Create entity schema","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/entity-schemas","href":"/api-reference/create-entity-schema"},{"title":"Update entity schema","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/entity-schemas/{entity_name}","href":"/api-reference/update-entity-schema"},{"title":"Sync entity schemas","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/entity-schemas","href":"/api-reference/sync-entity-schemas"},{"title":"Delete entity schema","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/entity-schemas/{entity_name}","href":"/api-reference/delete-entity-schema"}]},{"group":"Records","pages":[{"title":"List entity records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/{entity_name}/v2/list","href":"/api-reference/list-entity-records"},{"title":"Get entity record","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/{entity_name}/{entity_id}","href":"/api-reference/get-entity-record"},{"title":"Create entity record","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/entities/{entity_name}","href":"/api-reference/create-entity-record"},{"title":"Update entity record","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/entities/{entity_name}/{entity_id}","href":"/api-reference/update-entity-record"},{"title":"Delete entity record","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/entities/{entity_name}/{entity_id}","href":"/api-reference/delete-entity-record"},{"title":"Count entity records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/{entity_name}/count","href":"/api-reference/count-entity-records"},{"title":"Aggregate entity records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/entities/{entity_name}/aggregate","href":"/api-reference/aggregate-entity-records"}]},{"group":"Bulk operations","pages":[{"title":"Create entity records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/entities/{entity_name}/bulk","href":"/api-reference/create-entity-records"},{"title":"Update entity records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/entities/{entity_name}/bulk","href":"/api-reference/update-entity-records"},{"title":"Update entity records by filter","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/entities/{entity_name}/update-many","href":"/api-reference/update-entity-records-by-filter"},{"title":"Upsert entity records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/entities/{entity_name}/upsert","href":"/api-reference/upsert-entity-records"},{"title":"Import entity records from CSV","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/entities/{entity_name}/import","href":"/api-reference/import-entity-records-from-csv"},{"title":"Delete entity records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/entities/{entity_name}","href":"/api-reference/delete-entity-records"}]},{"group":"Trash","pages":[{"title":"List deleted entity records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/{entity_name}/trash","href":"/api-reference/list-deleted-entity-records"},{"title":"Restore entity record","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/entities/{entity_name}/{entity_id}/restore","href":"/api-reference/restore-entity-record"},{"title":"Restore entity records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/entities/{entity_name}/trash/restore","href":"/api-reference/restore-entity-records"},{"title":"Permanently delete entity record","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/entities/{entity_name}/{entity_id}/permanent","href":"/api-reference/permanently-delete-entity-record"}]},{"group":"Data checkpoints","pages":[{"title":"Get data version history status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/versions/info","href":"/api-reference/get-data-version-history-status"},{"title":"List data checkpoints","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/versions/checkpoints","href":"/api-reference/list-data-checkpoints"},{"title":"Download data checkpoint","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/{entity_name}/versions/checkpoints/{checkpoint_id}/snapshot","href":"/api-reference/download-data-checkpoint"},{"title":"Restore data to checkpoint","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/entities/versions/checkpoints/{checkpoint_id}/restore","href":"/api-reference/restore-data-to-checkpoint"},{"title":"Get data restore status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/versions/restores/batch/{batch_id}","href":"/api-reference/get-data-restore-status"}]}]},{"group":"Users","icon":"users","pages":[{"title":"Users","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/users"},{"title":"List app users","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/User","href":"/api-reference/list-app-users"},{"title":"Count app users","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/User/count","href":"/api-reference/count-app-users"},{"title":"Get app user","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/User/{user_id}","href":"/api-reference/get-app-user"},{"title":"Update app user","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/entities/User/{user_id}","href":"/api-reference/update-app-user"},{"title":"Remove app user","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/entities/User/{user_id}","href":"/api-reference/remove-app-user"},{"title":"Invite app users","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/users/invite-users","href":"/api-reference/invite-app-users"},{"title":"Provision an app user","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/users/provisions","href":"/api-reference/provision-an-app-user"},{"title":"Deprovision an app user","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/users/provisions","href":"/api-reference/deprovision-an-app-user"},{"title":"List access requests","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/access-requests/all","href":"/api-reference/list-access-requests"},{"title":"Approve or deny access request","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/access-requests/{request_id}/{action}","href":"/api-reference/approve-or-deny-access-request"},{"title":"Update pending invitee","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/access-requests/{request_id}","href":"/api-reference/update-pending-invitee"},{"title":"List collaborators","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/users/collaborators","href":"/api-reference/list-collaborators"},{"title":"Remove collaborator","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/users/collaborators/{collaborator_id}","href":"/api-reference/remove-collaborator"},{"title":"List group shares","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/group-shares","href":"/api-reference/list-group-shares"},{"title":"Share app with groups","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/group-shares","href":"/api-reference/share-app-with-groups"},{"title":"Update group share","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/group-shares/{share_id}","href":"/api-reference/update-group-share"},{"title":"Remove group share","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/group-shares/{share_id}","href":"/api-reference/remove-group-share"}]},{"group":"Workflows","icon":"diagram-project","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/workflows"},{"group":"Management","pages":[{"title":"List workflows","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows","href":"/api-reference/list-workflows"},{"title":"Validate a workflow definition","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/workflows/validate-definition","href":"/api-reference/validate-a-workflow-definition"},{"title":"Create a workflow (not imported apps)","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/workflows","href":"/api-reference/create-a-workflow-not-imported-apps"},{"title":"Get workflow","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows/{workflow_id}","href":"/api-reference/get-workflow"},{"title":"Update workflow (not imported apps)","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/workflows/{workflow_id}","href":"/api-reference/update-workflow-not-imported-apps"},{"title":"Toggle workflow status (not imported apps)","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/workflows/{workflow_id}/toggle-status","href":"/api-reference/toggle-workflow-status-not-imported-apps"},{"title":"Archive workflow (not imported apps)","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/workflows/{workflow_id}","href":"/api-reference/archive-workflow-not-imported-apps"},{"title":"Restore workflow (not imported apps)","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/workflows/{workflow_id}/unarchive","href":"/api-reference/restore-workflow-not-imported-apps"}]},{"group":"Versions","pages":[{"title":"List workflow versions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows/{workflow_id}/versions","href":"/api-reference/list-workflow-versions"},{"title":"Get workflow version","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows/{workflow_id}/versions/{version_id}","href":"/api-reference/get-workflow-version"}]},{"group":"Runs","pages":[{"title":"Get workflow run-now options","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows/{workflow_id}/run-now-info","href":"/api-reference/get-workflow-run-now-options"},{"title":"Run a workflow now","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/workflows/{workflow_id}/run-now","href":"/api-reference/run-a-workflow-now"},{"title":"List workflow runs for an app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows/runs","href":"/api-reference/list-workflow-runs-for-an-app"},{"title":"List runs for a workflow","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows/{workflow_id}/runs","href":"/api-reference/list-runs-for-a-workflow"},{"title":"Get workflow run","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows/{workflow_id}/runs/{run_id}","href":"/api-reference/get-workflow-run"},{"title":"Cancel a workflow run","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/workflows/{workflow_id}/runs/{run_id}/cancel","href":"/api-reference/cancel-a-workflow-run"},{"title":"Analyze a failed workflow run","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/workflows/{workflow_id}/runs/{run_id}/analyze","href":"/api-reference/analyze-a-failed-workflow-run"}]},{"group":"Insights","pages":[{"title":"Get workflow stats","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows/stats","href":"/api-reference/get-workflow-stats"},{"title":"Suggest workflows","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows/suggestions","href":"/api-reference/suggest-workflows"}]}]},{"group":"Agents","icon":"user-robot","pages":[{"title":"Agents","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/agents"},{"title":"Get the agent profile","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/agent-profile","href":"/api-reference/get-the-agent-profile"},{"title":"Get agent setup suggestions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/agent-configs/setup-suggestions","href":"/api-reference/get-agent-setup-suggestions"},{"title":"List agent conversation users","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/agent-configs/conversation-users","href":"/api-reference/list-agent-conversation-users"},{"title":"Get agent conversation","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/agent-configs/conversations/{conversation_id}","href":"/api-reference/get-agent-conversation"},{"title":"List agent memories","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/agent-configs/{name}/memory","href":"/api-reference/list-agent-memories"},{"title":"Get agent usage","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/agent-configs/usage","href":"/api-reference/get-agent-usage"}]},{"group":"Domains and redirects","icon":"globe","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/domains"},{"group":"Custom domains","pages":[{"title":"Check domain availability","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/custom-domains/availability","href":"/api-reference/check-domain-availability"},{"title":"Get domain purchase provider","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/custom-domains/purchase-provider","href":"/api-reference/get-domain-purchase-provider"},{"title":"Create domain checkout link","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/custom-domains/purchase-url","href":"/api-reference/create-domain-checkout-link"},{"title":"List domain registrations","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/custom-domains/registrations","href":"/api-reference/list-domain-registrations"},{"title":"Update a domain registration","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/custom-domains/{domain_id}/registration","href":"/api-reference/update-a-domain-registration"},{"title":"List custom domains","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/custom-domains","href":"/api-reference/list-custom-domains"},{"title":"Add custom domain","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/custom-domains","href":"/api-reference/add-custom-domain"},{"title":"Get custom domain","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/custom-domains/{domain_id}","href":"/api-reference/get-custom-domain"},{"title":"Get custom domain DNS records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/custom-domains/{domain_id}/dns-records","href":"/api-reference/get-custom-domain-dns-records"},{"title":"Verify custom domain","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/custom-domains/{domain_id}/verify","href":"/api-reference/verify-custom-domain"},{"title":"Get custom domain status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/custom-domains/{domain_id}/status","href":"/api-reference/get-custom-domain-status"},{"title":"Link custom domain","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/custom-domains/{domain_id}/link","href":"/api-reference/link-custom-domain"},{"title":"Set custom domain redirect","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/custom-domains/{domain_id}/redirect","href":"/api-reference/set-custom-domain-redirect"},{"title":"Unlink custom domain","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/custom-domains/{domain_id}/unlink","href":"/api-reference/unlink-custom-domain"},{"title":"Delete custom domain","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/custom-domains/{domain_id}","href":"/api-reference/delete-custom-domain"}]},{"group":"Email domains","pages":[{"title":"List email domains","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/custom-email-domains","href":"/api-reference/list-email-domains"},{"title":"Enable email sending for a domain","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/custom-email-domains","href":"/api-reference/enable-email-sending-for-a-domain"},{"title":"Retry email domain setup","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/custom-email-domains/configure","href":"/api-reference/retry-email-domain-setup"},{"title":"Update email sender details","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/custom-email-domains","href":"/api-reference/update-email-sender-details"},{"title":"Replace the email domain","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/custom-email-domains/replace","href":"/api-reference/replace-the-email-domain"},{"title":"Disable email sending for a domain","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/custom-email-domains","href":"/api-reference/disable-email-sending-for-a-domain"}]},{"group":"URL redirects","pages":[{"title":"List URL redirects","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/url-redirects","href":"/api-reference/list-url-redirects"},{"title":"Create URL redirect","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/url-redirects","href":"/api-reference/create-url-redirect"},{"title":"Update URL redirect","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/url-redirects/{redirect_id}","href":"/api-reference/update-url-redirect"},{"title":"Delete URL redirect","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/url-redirects/{redirect_id}","href":"/api-reference/delete-url-redirect"}]}]},{"group":"GitHub","icon":"github","pages":[{"title":"GitHub","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/github"},{"title":"List workspace GitHub installations","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/github/workspace-installations","href":"/api-reference/list-workspace-github-installations"},{"title":"List GitHub organizations","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/github/organizations","href":"/api-reference/list-github-organizations"},{"title":"Get GitHub organization policy","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/github/org-policy","href":"/api-reference/get-github-organization-policy"},{"title":"Connect an app to GitHub","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/github/connect","href":"/api-reference/connect-an-app-to-github"},{"title":"Link a CLI app’s GitHub repository","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/github/link-existing","href":"/api-reference/link-a-cli-app’s-github-repository"},{"title":"Get GitHub connection","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/github/connection","href":"/api-reference/get-github-connection"},{"title":"Turn automatic GitHub sync on or off","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/github/sync/toggle","href":"/api-reference/turn-automatic-github-sync-on-or-off"},{"title":"Pull changes from GitHub","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/github/sync","href":"/api-reference/pull-changes-from-github"},{"title":"Push changes to GitHub","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/github/sync/manual","href":"/api-reference/push-changes-to-github"},{"title":"Resolve GitHub sync conflicts","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/github/sync/resolve-conflicts","href":"/api-reference/resolve-github-sync-conflicts"},{"title":"Import a GitHub branch","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/github/branches/import","href":"/api-reference/import-a-github-branch"},{"title":"Reconnect a GitHub repository","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/github/reconnect","href":"/api-reference/reconnect-a-github-repository"},{"title":"Disconnect a GitHub repository","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/github/disconnect","href":"/api-reference/disconnect-a-github-repository"}]},{"group":"Base code","icon":"laptop-code","pages":[{"title":"Base code","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/imported-app-sessions"},{"title":"Check for main sandbox updates on an imported app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/main-update/check","href":"/api-reference/check-for-main-sandbox-updates-on-an-imported-app"},{"title":"Get main sandbox update status on an imported app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/main-update","href":"/api-reference/get-main-sandbox-update-status-on-an-imported-app"},{"title":"Retry main sandbox update","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/main-update/failures/{failure_id}/retry","href":"/api-reference/retry-main-sandbox-update"},{"title":"Investigate main sandbox update failure","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/main-update/failures/{failure_id}/investigations","href":"/api-reference/investigate-main-sandbox-update-failure"},{"title":"List coding sessions on an imported app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/sessions","href":"/api-reference/list-coding-sessions-on-an-imported-app"},{"title":"Launch coding session on an imported app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/sessions","href":"/api-reference/launch-coding-session-on-an-imported-app"},{"title":"Import a Claude Code or Codex session on an imported app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/session-imports","href":"/api-reference/import-a-claude-code-or-codex-session-on-an-imported-app"},{"title":"Get coding session on an imported app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/sessions/{session_id}","href":"/api-reference/get-coding-session-on-an-imported-app"},{"title":"Get coding session by launch key on an imported app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/sessions/launch-requests/{launch_key}","href":"/api-reference/get-coding-session-by-launch-key-on-an-imported-app"},{"title":"Get latest coding sessions by reference on an imported app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/sessions/latest","href":"/api-reference/get-latest-coding-sessions-by-reference-on-an-imported-app"},{"title":"Get a coding session's open question on an imported app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/sessions/{session_id}/input-request","href":"/api-reference/get-a-coding-sessions-open-question-on-an-imported-app"},{"title":"Send a message to a coding session on an imported app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/sessions/{session_id}/messages","href":"/api-reference/send-a-message-to-a-coding-session-on-an-imported-app"},{"title":"Get a message sent to a coding session on an imported app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/sessions/{session_id}/messages/{input_id}","href":"/api-reference/get-a-message-sent-to-a-coding-session-on-an-imported-app"},{"title":"Cancel coding session on an imported app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/sessions/{session_id}/cancel","href":"/api-reference/cancel-coding-session-on-an-imported-app"},{"title":"Import repository branch","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/branches/import-from-repo","href":"/api-reference/import-repository-branch"},{"title":"Get branch pull request","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/git/pull-request","href":"/api-reference/get-branch-pull-request"},{"title":"Open pull request","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/git/pull-request","href":"/api-reference/open-pull-request"},{"title":"Update pull request","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/imported/git/pull-request","href":"/api-reference/update-pull-request"},{"title":"Get pull requests for branches","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/git/pull-requests/by-branch","href":"/api-reference/get-pull-requests-for-branches"},{"title":"List pull requests","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/git/pull-requests","href":"/api-reference/list-pull-requests"},{"title":"Get branch git status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/git/status","href":"/api-reference/get-branch-git-status"},{"title":"Commit branch changes","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/git/commit","href":"/api-reference/commit-branch-changes"},{"title":"Discard branch changes","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/git/discard","href":"/api-reference/discard-branch-changes"}]},{"group":"Integrations","icon":"plug","pages":[{"title":"Integrations","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/integrations"},{"title":"List connectors","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/external-auth/available-integrations","href":"/api-reference/list-connectors"},{"title":"Get connector policies","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/external-auth/connector-governance","href":"/api-reference/get-connector-policies"},{"title":"List connector connections","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/external-auth/list","href":"/api-reference/list-connector-connections"},{"title":"Get connector connection status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/external-auth/status","href":"/api-reference/get-connector-connection-status"},{"title":"Get connector connection fields","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/external-auth/connection-config/{integration_type}","href":"/api-reference/get-connector-connection-fields"},{"title":"Get OAuth redirect URIs","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/oauth-redirect-uris","href":"/api-reference/get-oauth-redirect-uris"},{"title":"Start connector connection","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/external-auth/initiate","href":"/api-reference/start-connector-connection"},{"title":"Set connector scopes","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/external-auth/integrations/{integration_type}","href":"/api-reference/set-connector-scopes"},{"title":"Disconnect connector","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/external-auth/integrations/{integration_type}","href":"/api-reference/disconnect-connector"},{"title":"Remove connector","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/external-auth/integrations/{integration_type}/remove","href":"/api-reference/remove-connector"}]},{"group":"Security","icon":"shield-halved","pages":[{"title":"Security","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/security"},{"title":"Run security scan","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/security/scan","href":"/api-reference/run-security-scan"},{"title":"Get security scan","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/security/scan","href":"/api-reference/get-security-scan"},{"title":"Fix RLS recommendations","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/security/scan/rls/fix","href":"/api-reference/fix-rls-recommendations"},{"title":"Dismiss RLS recommendation","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/security/scan/rls-recommendation/{entity_name}","href":"/api-reference/dismiss-rls-recommendation"},{"title":"Dismiss header recommendation","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/security/scan/header-recommendations/{flag}","href":"/api-reference/dismiss-header-recommendation"},{"title":"Enable core integration protection","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/security/scan/core-integrations/protect","href":"/api-reference/enable-core-integration-protection"},{"title":"Ignore security finding","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/security/scan/ignore","href":"/api-reference/ignore-security-finding"},{"title":"Restore security finding","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/security/scan/ignore/{fingerprint}","href":"/api-reference/restore-security-finding"},{"title":"Get security headers","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/security/headers","href":"/api-reference/get-security-headers"},{"title":"Update security headers","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/security/headers","href":"/api-reference/update-security-headers"}]},{"group":"Testing","icon":"vial","pages":[{"title":"Testing","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/testing"},{"title":"List tests","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/testing-agent/flows","href":"/api-reference/list-tests"},{"title":"Create test","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/flows","href":"/api-reference/create-test"},{"title":"Get test","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/testing-agent/flows/{flow_id}","href":"/api-reference/get-test"},{"title":"Update test","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/testing-agent/flows/{flow_id}","href":"/api-reference/update-test"},{"title":"Delete test","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/testing-agent/flows/{flow_id}","href":"/api-reference/delete-test"},{"title":"Refine test description","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/refine","href":"/api-reference/refine-test-description"},{"title":"Generate tests from app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/flows/generate-from-app-context","href":"/api-reference/generate-tests-from-app"},{"title":"Suggest new tests","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/flows/suggest-new-tests","href":"/api-reference/suggest-new-tests"},{"title":"Save test generation checkpoint","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/flows/save-generation-checkpoint","href":"/api-reference/save-test-generation-checkpoint"},{"title":"Seed test data","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/data/seed","href":"/api-reference/seed-test-data"},{"title":"Run test","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/executions","href":"/api-reference/run-test"},{"title":"List test runs","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/testing-agent/executions","href":"/api-reference/list-test-runs"},{"title":"Get latest run per test","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/testing-agent/executions/latest-by-flow","href":"/api-reference/get-latest-run-per-test"},{"title":"Get test run","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/testing-agent/executions/{execution_id}","href":"/api-reference/get-test-run"},{"title":"Pause test run","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/executions/{execution_id}/pause","href":"/api-reference/pause-test-run"},{"title":"Cancel test run","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/executions/{execution_id}/cancel","href":"/api-reference/cancel-test-run"},{"title":"Get test run report","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/testing-agent/analysis/{execution_id}","href":"/api-reference/get-test-run-report"},{"title":"Reanalyze test run","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/analysis/{execution_id}/reanalyze","href":"/api-reference/reanalyze-test-run"},{"title":"Resolve test run issue","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/analysis/{execution_id}/issues/resolve","href":"/api-reference/resolve-test-run-issue"},{"title":"Delete test run issue","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/analysis/{execution_id}/issues/delete","href":"/api-reference/delete-test-run-issue"}]},{"group":"SEO","icon":"magnifying-glass","pages":[{"title":"SEO","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/seo"},{"title":"Get SEO settings","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/settings","href":"/api-reference/get-seo-settings"},{"title":"Update SEO settings","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/seo/settings","href":"/api-reference/update-seo-settings"},{"title":"Get page visibility","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/page-visibility","href":"/api-reference/get-page-visibility"},{"title":"Update page SEO settings","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/seo/page-settings/{page_name}","href":"/api-reference/update-page-seo-settings"},{"title":"Run SEO scan","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/seo/scan","href":"/api-reference/run-seo-scan"},{"title":"Get last SEO scan","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/last-scan","href":"/api-reference/get-last-seo-scan"},{"title":"Get SEO score","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/summary","href":"/api-reference/get-seo-score"},{"title":"Apply SEO fix","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/seo/fix","href":"/api-reference/apply-seo-fix"},{"title":"Preview llms.txt","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/preview/llms-txt","href":"/api-reference/preview-llmstxt"},{"title":"Preview JSON-LD","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/preview/json-ld","href":"/api-reference/preview-json-ld"}]},{"group":"SEO research","icon":"microscope","pages":[{"title":"Get keyword ideas","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/research/keyword-ideas","href":"/api-reference/get-keyword-ideas"},{"title":"Get Google's top 10 for a keyword","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/research/serp","href":"/api-reference/get-googles-top-10-for-a-keyword"},{"title":"Get search performance","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/research/search-performance","href":"/api-reference/get-search-performance"},{"title":"Get keywords a competitor wins","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/research/competitor-gap","href":"/api-reference/get-keywords-a-competitor-wins"},{"title":"Get sites linking to a competitor","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/research/backlink-gap","href":"/api-reference/get-sites-linking-to-a-competitor"},{"title":"Ask AI assistants about this app's market","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/research/ai-answers","href":"/api-reference/ask-ai-assistants-about-this-apps-market"}]},{"group":"Analytics","icon":"chart-column","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/analytics"},{"title":"Suggest analytics events to track","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/analytics/suggestions","href":"/api-reference/suggest-analytics-events-to-track"},{"title":"List analytics event names","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/analytics/names","href":"/api-reference/list-analytics-event-names"},{"title":"List analytics event properties","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/analytics/{event_name}/properties","href":"/api-reference/list-analytics-event-properties"},{"title":"Query analytics events","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/analytics/query","href":"/api-reference/query-analytics-events"},{"title":"Aggregate analytics events over time","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/analytics/timeseries","href":"/api-reference/aggregate-analytics-events-over-time"},{"title":"Aggregate analytics events by field","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/analytics/grouped","href":"/api-reference/aggregate-analytics-events-by-field"},{"title":"Get analytics user stats","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/analytics/stats/users","href":"/api-reference/get-analytics-user-stats"},{"title":"Get session recording settings","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/session-recordings/apps/{app_id}/recording-settings","href":"/api-reference/get-session-recording-settings"},{"title":"Turn session recordings on or off","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/session-recordings/apps/{app_id}/recording-settings","href":"/api-reference/turn-session-recordings-on-or-off"},{"title":"Update session recording capture settings","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/session-recordings/apps/{app_id}/recording-settings","href":"/api-reference/update-session-recording-capture-settings"}]},{"group":"Payments","icon":"credit-card","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/payments"},{"group":"Stripe","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/payments-stripe"},{"title":"Install Stripe integration","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/payments/stripe/install","href":"/api-reference/install-stripe-integration"},{"title":"Get Stripe integration status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/stripe/status","href":"/api-reference/get-stripe-integration-status"},{"title":"Get Stripe sandbox","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/stripe/sandbox","href":"/api-reference/get-stripe-sandbox"},{"title":"Get Stripe onboarding link","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/stripe/sandbox/claim-url","href":"/api-reference/get-stripe-onboarding-link"},{"title":"Provision live Stripe keys","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/payments/stripe/provision-live-keys","href":"/api-reference/provision-live-stripe-keys"},{"title":"Configure live Stripe keys","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/payments/stripe/configure-live-keys","href":"/api-reference/configure-live-stripe-keys"},{"title":"List Stripe products","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/stripe/products","href":"/api-reference/list-stripe-products"},{"title":"Create Stripe product","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/payments/stripe/products","href":"/api-reference/create-stripe-product"},{"title":"Get Stripe product","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/stripe/products/{product_id}","href":"/api-reference/get-stripe-product"},{"title":"Update Stripe product","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/payments/stripe/products/{product_id}","href":"/api-reference/update-stripe-product"},{"title":"List Stripe prices","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/stripe/prices","href":"/api-reference/list-stripe-prices"},{"title":"Create Stripe price","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/payments/stripe/prices","href":"/api-reference/create-stripe-price"},{"title":"Update Stripe price","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/payments/stripe/prices/{price_id}","href":"/api-reference/update-stripe-price"},{"title":"Remove Stripe integration","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/payments/stripe","href":"/api-reference/remove-stripe-integration"}]},{"group":"Wix Payments","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/payments-wix"},{"title":"Resolve Wix Payments onboarding name","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/payments/wix/resolve-name","href":"/api-reference/resolve-wix-payments-onboarding-name"},{"title":"Get Wix Payments status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/wix/status","href":"/api-reference/get-wix-payments-status"},{"title":"Get Wix Payments dashboard link","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/wix/dashboard-url","href":"/api-reference/get-wix-payments-dashboard-link"},{"title":"Switch Wix Payments test mode","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/payments/wix/test-mode","href":"/api-reference/switch-wix-payments-test-mode"},{"title":"List Wix Payments payouts","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/wix/payouts","href":"/api-reference/list-wix-payments-payouts"},{"title":"Get Wix Payments payout","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/wix/payouts/{payout_id}","href":"/api-reference/get-wix-payments-payout"},{"title":"Disconnect Wix Payments","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/payments/wix","href":"/api-reference/disconnect-wix-payments"},{"title":"Get Payments by Wix dashboard link","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/payments-by-wix/dashboard-url","href":"/api-reference/get-payments-by-wix-dashboard-link"},{"title":"Disconnect Payments by Wix","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/payments/payments-by-wix","href":"/api-reference/disconnect-payments-by-wix"}]},{"group":"Analytics","pages":[{"title":"Get payment analytics","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/analytics","href":"/api-reference/get-payment-analytics"},{"title":"Get recent payment transactions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/analytics/recent-transactions","href":"/api-reference/get-recent-payment-transactions"},{"title":"Get top payment customers","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/analytics/top-customers","href":"/api-reference/get-top-payment-customers"}]},{"group":"Transactions","pages":[{"title":"List payment transactions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/analytics/transactions","href":"/api-reference/list-payment-transactions"},{"title":"Export payment transactions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/analytics/transactions/export","href":"/api-reference/export-payment-transactions"},{"title":"Get payment transaction","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/analytics/transactions/{transaction_id}","href":"/api-reference/get-payment-transaction"},{"title":"Refund payment transaction","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/payments/analytics/transactions/{transaction_id}/refund","href":"/api-reference/refund-payment-transaction"}]},{"group":"Webhooks","pages":[{"title":"Receive Stripe sandbox event","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/payment-webhooks/stripe","href":"/api-reference/receive-stripe-sandbox-event"},{"title":"Receive Stripe live event","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/payment-webhooks/stripe/live","href":"/api-reference/receive-stripe-live-event"},{"title":"Receive Wix Payments event","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/payment-webhooks/wix-payments","href":"/api-reference/receive-wix-payments-event"}]}]},{"group":"Marketing Agent","icon":"wand-magic-sparkles","pages":[{"title":"Marketing Agent","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/marketing-agent"},{"title":"Start Marketing Agent setup (web apps)","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/cmo/setup/start","href":"/api-reference/start-marketing-agent-setup-web-apps"},{"title":"Answer Marketing Agent setup step (web apps)","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/cmo/setup/answer","href":"/api-reference/answer-marketing-agent-setup-step-web-apps"},{"title":"Get Marketing Agent state (web apps)","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/cmo/state","href":"/api-reference/get-marketing-agent-state-web-apps"},{"title":"Get Marketing Agent KPI values (web apps)","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/cmo/kpi-values","href":"/api-reference/get-marketing-agent-kpi-values-web-apps"},{"title":"Message the Marketing Agent (web apps)","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/cmo/messages","href":"/api-reference/message-the-marketing-agent-web-apps"},{"title":"Reset Marketing Agent setup (web apps)","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/cmo/setup/reset","href":"/api-reference/reset-marketing-agent-setup-web-apps"}]},{"group":"Virality and social content","icon":"share-nodes","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/virality"},{"group":"Virality","pages":[{"title":"Start social content flow","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/virality/start","href":"/api-reference/start-social-content-flow"},{"title":"Submit answers","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/virality/submit-answers","href":"/api-reference/submit-answers"},{"title":"Refine content strategy","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/virality/refine-strategy","href":"/api-reference/refine-content-strategy"},{"title":"Generate content plan","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/virality/generate","href":"/api-reference/generate-content-plan"},{"title":"Get social content state","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/virality/state","href":"/api-reference/get-social-content-state"},{"title":"Update post content","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/virality/posts/{post_id}","href":"/api-reference/update-post-content"},{"title":"Refine a post","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/virality/posts/{post_id}/refine","href":"/api-reference/refine-a-post"},{"title":"Generate a post image","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/virality/posts/{post_id}/generate-image","href":"/api-reference/generate-a-post-image"},{"title":"Generate teaser posts","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/virality/teaser","href":"/api-reference/generate-teaser-posts"},{"title":"Reset social content flow","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/virality/reset","href":"/api-reference/reset-social-content-flow"}]}]},{"group":"Google Ads","icon":"bullhorn","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/google-ads"},{"group":"Accounts","pages":[{"title":"Create Google Ads account for tracking","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/accounts/ensure-for-tracking","href":"/api-reference/create-google-ads-account-for-tracking"},{"title":"Get Google Ads account","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/accounts","href":"/api-reference/get-google-ads-account"},{"title":"Accept Google Ads terms","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/accounts/{account_id}/accept-terms","href":"/api-reference/accept-google-ads-terms"},{"title":"Retry Google Ads billing setup","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/accounts/{account_id}/retry-billing-setup","href":"/api-reference/retry-google-ads-billing-setup"},{"title":"Update Google Ads monthly spend cap","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/google-ads/accounts/{account_id}/budget-limit","href":"/api-reference/update-google-ads-monthly-spend-cap"},{"title":"Update Google Ads billing cadence","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/google-ads/accounts/{account_id}/cadence","href":"/api-reference/update-google-ads-billing-cadence"},{"title":"Turn on Google Ads budget auto-renewal","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/accounts/{account_id}/auto-renewal/on","href":"/api-reference/turn-on-google-ads-budget-auto-renewal"},{"title":"Turn off Google Ads budget auto-renewal","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/accounts/{account_id}/auto-renewal/off","href":"/api-reference/turn-off-google-ads-budget-auto-renewal"},{"title":"Link a Google Business Profile","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/accounts/{account_id}/business-profile/link","href":"/api-reference/link-a-google-business-profile"},{"title":"Unlink the Google Business Profile","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/accounts/{account_id}/business-profile/unlink","href":"/api-reference/unlink-the-google-business-profile"},{"title":"Disconnect the Google Ads account","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/accounts/{account_id}/disconnect","href":"/api-reference/disconnect-the-google-ads-account"}]},{"group":"Campaigns","pages":[{"title":"List Google Ads campaign briefs","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaign-briefs","href":"/api-reference/list-google-ads-campaign-briefs"},{"title":"Generate Google Ads campaign brief","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaign-briefs/generate","href":"/api-reference/generate-google-ads-campaign-brief"},{"title":"Create Google Ads campaign brief","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaign-briefs","href":"/api-reference/create-google-ads-campaign-brief"},{"title":"Get Google Ads campaign brief","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaign-briefs/{brief_id}","href":"/api-reference/get-google-ads-campaign-brief"},{"title":"Update Google Ads campaign brief","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/google-ads/campaign-briefs/{brief_id}","href":"/api-reference/update-google-ads-campaign-brief"},{"title":"Delete Google Ads campaign brief","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/google-ads/campaign-briefs/{brief_id}","href":"/api-reference/delete-google-ads-campaign-brief"},{"title":"Suggest Google Ads campaigns","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns/ai-suggestions","href":"/api-reference/suggest-google-ads-campaigns"},{"title":"Suggest Google Ads budget options","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns/suggestions","href":"/api-reference/suggest-google-ads-budget-options"},{"title":"Get Google Ads budget boundaries","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaigns/budget-boundaries","href":"/api-reference/get-google-ads-budget-boundaries"},{"title":"Estimate a Google Ads campaign budget","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns/estimate","href":"/api-reference/estimate-a-google-ads-campaign-budget"},{"title":"Estimate Google Ads cost per click","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns/cpc-estimate","href":"/api-reference/estimate-google-ads-cost-per-click"},{"title":"List Google Ads campaigns","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaigns","href":"/api-reference/list-google-ads-campaigns"},{"title":"Create Google Ads campaign","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns","href":"/api-reference/create-google-ads-campaign"},{"title":"Get Google Ads campaign","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaigns/{campaign_id}","href":"/api-reference/get-google-ads-campaign"},{"title":"Update Google Ads campaign","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/google-ads/campaigns/{campaign_id}","href":"/api-reference/update-google-ads-campaign"},{"title":"Delete Google Ads campaign","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/google-ads/campaigns/{campaign_id}","href":"/api-reference/delete-google-ads-campaign"},{"title":"Get Google Ads campaign targeting","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaigns/{campaign_id}/targeting","href":"/api-reference/get-google-ads-campaign-targeting"},{"title":"Suggest keyword themes for a Google Ads campaign","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaigns/{campaign_id}/keyword-theme-suggestions","href":"/api-reference/suggest-keyword-themes-for-a-google-ads-campaign"},{"title":"List Google Ads campaign optimization suggestions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaigns/{campaign_id}/optimization-suggestions","href":"/api-reference/list-google-ads-campaign-optimization-suggestions"},{"title":"Apply a Google Ads budget recommendation","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns/{campaign_id}/recommendations/apply-budget","href":"/api-reference/apply-a-google-ads-budget-recommendation"},{"title":"Get Google Ads campaign conversion breakdown","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaigns/{campaign_id}/impact","href":"/api-reference/get-google-ads-campaign-conversion-breakdown"},{"title":"List Google Ads campaign changes","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaigns/{campaign_id}/change-log","href":"/api-reference/list-google-ads-campaign-changes"},{"title":"Pause Google Ads campaign","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns/{campaign_id}/pause","href":"/api-reference/pause-google-ads-campaign"},{"title":"Resume Google Ads campaign","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns/{campaign_id}/resume","href":"/api-reference/resume-google-ads-campaign"},{"title":"Get Google Ads campaign metrics","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaigns/metrics","href":"/api-reference/get-google-ads-campaign-metrics"},{"title":"Bulk update Google Ads campaign budgets","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/google-ads/campaigns/bulk-budget","href":"/api-reference/bulk-update-google-ads-campaign-budgets"},{"title":"Pause all Google Ads campaigns","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns/pause-all","href":"/api-reference/pause-all-google-ads-campaigns"},{"title":"Sync Google Ads campaigns","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns/sync","href":"/api-reference/sync-google-ads-campaigns"}]},{"group":"Assets","pages":[{"title":"List Google Ads generated assets","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/assets","href":"/api-reference/list-google-ads-generated-assets"},{"title":"Generate Google Ads assets","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/assets/generate-all","href":"/api-reference/generate-google-ads-assets"},{"title":"Generate Google Ads text assets","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/assets/generate-text","href":"/api-reference/generate-google-ads-text-assets"},{"title":"Generate Google Ads image assets","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/assets/generate-images","href":"/api-reference/generate-google-ads-image-assets"},{"title":"Upload a Google Ads video","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/assets/upload-video","href":"/api-reference/upload-a-google-ads-video"},{"title":"Poll a Google Ads video upload","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/assets/upload-video/poll","href":"/api-reference/poll-a-google-ads-video-upload"},{"title":"Accept a generated Google Ads asset","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/assets/{session_asset_id}/accept","href":"/api-reference/accept-a-generated-google-ads-asset"},{"title":"Regenerate Google Ads asset group creative","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/asset-groups/{asset_group_id}/regenerate-assets","href":"/api-reference/regenerate-google-ads-asset-group-creative"}]},{"group":"Launch","pages":[{"title":"Get Google Ads launch readiness","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/launch-readiness","href":"/api-reference/get-google-ads-launch-readiness"},{"title":"Get Google Ads campaign launch draft","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaign-launch-drafts/{draft_id}","href":"/api-reference/get-google-ads-campaign-launch-draft"},{"title":"Launch Google Ads campaign","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/launch","href":"/api-reference/launch-google-ads-campaign"}]},{"group":"Reporting","pages":[{"title":"Get Google Ads performance dashboard","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/analytics/dashboard","href":"/api-reference/get-google-ads-performance-dashboard"},{"title":"Get Google Ads metric trend","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/analytics/trend","href":"/api-reference/get-google-ads-metric-trend"},{"title":"List Google Ads insights","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/analytics/insights","href":"/api-reference/list-google-ads-insights"},{"title":"Dismiss Google Ads insight","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/analytics/insights/dismiss","href":"/api-reference/dismiss-google-ads-insight"},{"title":"List Google Ads search terms","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/analytics/search-terms","href":"/api-reference/list-google-ads-search-terms"},{"title":"List Google Ads asset performance","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/analytics/asset-performance","href":"/api-reference/list-google-ads-asset-performance"},{"title":"List Google Ads top asset combinations","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/analytics/asset-group-top-combinations","href":"/api-reference/list-google-ads-top-asset-combinations"}]},{"group":"Conversions","pages":[{"title":"Scan Google Ads conversion tracking","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/tracking-scan","href":"/api-reference/scan-google-ads-conversion-tracking"},{"title":"Build Google Ads tracking fix prompt","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/tracking-scan/build-bootstrap-prompt","href":"/api-reference/build-google-ads-tracking-fix-prompt"},{"title":"Get Google Ads tracking script","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/tracking-script","href":"/api-reference/get-google-ads-tracking-script"},{"title":"List Google Ads conversion actions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/conversion-actions","href":"/api-reference/list-google-ads-conversion-actions"},{"title":"List Google Ads conversion mappings","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/conversion-mappings","href":"/api-reference/list-google-ads-conversion-mappings"},{"title":"Create Google Ads conversion mapping","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/conversion-mappings","href":"/api-reference/create-google-ads-conversion-mapping"},{"title":"Update Google Ads conversion mapping","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/google-ads/conversion-mappings/{mapping_id}","href":"/api-reference/update-google-ads-conversion-mapping"},{"title":"Delete Google Ads conversion mapping","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/google-ads/conversion-mappings/{mapping_id}","href":"/api-reference/delete-google-ads-conversion-mapping"},{"title":"Upload Google Ads conversions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/conversions/upload","href":"/api-reference/upload-google-ads-conversions"},{"title":"Upload enhanced Google Ads conversions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/conversions/upload-enhanced","href":"/api-reference/upload-enhanced-google-ads-conversions"},{"title":"Get Google Ads conversion stats","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/conversions/stats","href":"/api-reference/get-google-ads-conversion-stats"}]},{"group":"Billing","pages":[{"title":"Get Google Ads billing status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/billing/status","href":"/api-reference/get-google-ads-billing-status"},{"title":"Create Google Ads payment setup","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/billing/payment-setup","href":"/api-reference/create-google-ads-payment-setup"},{"title":"Create embedded Google Ads payment setup","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/billing/payment-setup-embedded","href":"/api-reference/create-embedded-google-ads-payment-setup"},{"title":"List Google Ads invoices","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/billing/invoices","href":"/api-reference/list-google-ads-invoices"},{"title":"List Google Ads promotional credits","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/billing/credits","href":"/api-reference/list-google-ads-promotional-credits"},{"title":"List Google Ads incentives","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/incentives","href":"/api-reference/list-google-ads-incentives"},{"title":"Apply a Google Ads incentive","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/accounts/{account_id}/incentives/apply","href":"/api-reference/apply-a-google-ads-incentive"},{"title":"Get Google Ads account debt","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/accounts/{account_id}/billing/debt","href":"/api-reference/get-google-ads-account-debt"},{"title":"Get Google Ads workspace debt","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/billing/workspace-debt","href":"/api-reference/get-google-ads-workspace-debt"},{"title":"Pay Google Ads workspace debt","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/billing/workspace-pay-now","href":"/api-reference/pay-google-ads-workspace-debt"}]},{"group":"Suggestions and lookups","pages":[{"title":"Search Google Ads locations","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/geo-targets/search","href":"/api-reference/search-google-ads-locations"},{"title":"List Google Ads advertising languages","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/languages","href":"/api-reference/list-google-ads-advertising-languages"},{"title":"Suggest Google Ads setup targeting","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/setup-suggestions","href":"/api-reference/suggest-google-ads-setup-targeting"},{"title":"Suggest Google Ads setup keyword themes","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/setup-suggestions/keyword-themes","href":"/api-reference/suggest-google-ads-setup-keyword-themes"},{"title":"Regenerate a Google Ads setup keyword theme","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/setup-suggestions/regenerate-keyword","href":"/api-reference/regenerate-a-google-ads-setup-keyword-theme"},{"title":"Autocomplete Google Ads keyword themes","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/suggestions/keyword-themes","href":"/api-reference/autocomplete-google-ads-keyword-themes"},{"title":"Suggest Google Ads search themes","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/suggestions/search-themes","href":"/api-reference/suggest-google-ads-search-themes"},{"title":"Suggest Google Ads text assets","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/suggestions/text-assets","href":"/api-reference/suggest-google-ads-text-assets"},{"title":"Generate Google Ads ad copy","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/ai/generate-copy","href":"/api-reference/generate-google-ads-ad-copy"},{"title":"Enhance a Google Ads image prompt","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/suggestions/enhance-prompt","href":"/api-reference/enhance-a-google-ads-image-prompt"},{"title":"Get a Google Ads hero preview","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/ai/hero-preview","href":"/api-reference/get-a-google-ads-hero-preview"},{"title":"Ask the Google Ads assistant","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/troubleshoot/ask","href":"/api-reference/ask-the-google-ads-assistant"}]}]},{"group":"Embed Tokens","icon":"key","pages":[{"title":"Create an embed sign-in token","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/embed-url","href":"/api-reference/create-an-embed-sign-in-token"}]},{"group":"Socket sessions","icon":"tower-broadcast","pages":[{"title":"Socket sessions","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/socket-sessions"},{"title":"Socket messages","sidebarTitle":"Socket messages","href":"/developers/references/apps-api/sections/socket-messages"},{"title":"Create socket session","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/v1/socket-sessions","href":"/api-reference/create-socket-session"},{"title":"Add app to session","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/v1/socket-sessions/{session_id}/apps/{app_id}","href":"/api-reference/add-app-to-session"},{"title":"Remove app from session","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/v1/socket-sessions/{session_id}/apps/{app_id}","href":"/api-reference/remove-app-from-session"},{"title":"End socket session","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/v1/socket-sessions/{session_id}","href":"/api-reference/end-socket-session"}]}]},{"group":"Workspace API (Beta)","boost":0.75,"icon":"building","expanded":false,"pages":[{"group":"Get Started","icon":"book-open","pages":[{"title":"Workspace API Overview","sidebarTitle":"Overview","href":"/developers/references/workspace-api/get-started/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/developers/references/workspace-api/get-started/authentication"}]},{"group":"API Reference","icon":"brackets-curly","pages":[{"group":"Members","pages":[{"title":"List workspace members","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/members/list","href":"/api-reference/list-workspace-members"},{"title":"Update workspace member role","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/members/{email}/role","href":"/api-reference/update-workspace-member-role"},{"title":"Update workspace member roles in bulk","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/members/bulk/role","href":"/api-reference/update-workspace-member-roles-in-bulk"},{"title":"Remove workspace member","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/workspace/members/{email}","href":"/api-reference/remove-workspace-member"},{"title":"Remove workspace members in bulk","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/members/bulk/remove","href":"/api-reference/remove-workspace-members-in-bulk"}]},{"group":"Groups","pages":[{"title":"List workspace groups","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/workspace/groups","href":"/api-reference/list-workspace-groups"},{"title":"Create workspace group","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/groups","href":"/api-reference/create-workspace-group"},{"title":"Update workspace group","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/groups/{group_id}","href":"/api-reference/update-workspace-group"},{"title":"Delete workspace group","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/workspace/groups/{group_id}","href":"/api-reference/delete-workspace-group"},{"title":"List group members","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/workspace/groups/{group_id}/members","href":"/api-reference/list-group-members"},{"title":"Add group members","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/groups/{group_id}/members","href":"/api-reference/add-group-members"},{"title":"Remove group members","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/groups/{group_id}/members/remove","href":"/api-reference/remove-group-members"}]},{"group":"Invitations","pages":[{"title":"Invite workspace member","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/invitations/invite","href":"/api-reference/invite-workspace-member"},{"title":"Invite workspace members in bulk","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/invitations/bulk-invite","href":"/api-reference/invite-workspace-members-in-bulk"},{"title":"Resend workspace invitation","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/invitations/resend","href":"/api-reference/resend-workspace-invitation"},{"title":"Resend workspace invitations in bulk","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/invitations/bulk-resend","href":"/api-reference/resend-workspace-invitations-in-bulk"}]},{"group":"Credit limits","pages":[{"title":"Set default member credit limit","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/default-credit-limit","href":"/api-reference/set-default-member-credit-limit"},{"title":"Set member credit limit","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/members/{email}/credit-limit","href":"/api-reference/set-member-credit-limit"},{"title":"Set member credit limits in bulk","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/members/bulk/credit-limit","href":"/api-reference/set-member-credit-limits-in-bulk"}]},{"group":"App folders","pages":[{"title":"List app folders","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/app-folders/tree","href":"/api-reference/list-app-folders"},{"title":"Create app folder","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/app-folders","href":"/api-reference/create-app-folder"},{"title":"Update app folder","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/app-folders/{item_id}","href":"/api-reference/update-app-folder"},{"title":"Delete app folder","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/app-folders/{item_id}","href":"/api-reference/delete-app-folder"},{"title":"Add apps to folder","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/app-folders/{folder_id}/items","href":"/api-reference/add-apps-to-folder"},{"title":"Remove app from folder","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/app-folders/{folder_id}/items/{app_id}","href":"/api-reference/remove-app-from-folder"}]},{"group":"Fonts","pages":[{"title":"List workspace fonts","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/fonts","href":"/api-reference/list-workspace-fonts"},{"title":"Upload workspace font","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/fonts","href":"/api-reference/upload-workspace-font"},{"title":"Get workspace font","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/fonts/{font_id}","href":"/api-reference/get-workspace-font"},{"title":"Delete workspace font","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/fonts/{font_id}","href":"/api-reference/delete-workspace-font"}]},{"group":"Connectors","pages":[{"title":"List workspace connectors","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/workspace/{workspace_id}/connectors","href":"/api-reference/list-workspace-connectors"},{"title":"Create workspace connector","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/{workspace_id}/connectors","href":"/api-reference/create-workspace-connector"},{"title":"Update workspace connector","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/{workspace_id}/connectors/{connector_id}","href":"/api-reference/update-workspace-connector"},{"title":"Delete workspace connector","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/workspace/{workspace_id}/connectors/{connector_id}","href":"/api-reference/delete-workspace-connector"}]},{"group":"Connector governance","pages":[{"title":"Get workspace connector policies","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/workspace/{workspace_id}/connector-governance","href":"/api-reference/get-workspace-connector-policies"},{"title":"Update builder connection policy","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/{workspace_id}/connector-governance/{integration_type}/builder-connection","href":"/api-reference/update-builder-connection-policy"},{"title":"Update per-user connection policy","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/{workspace_id}/connector-governance/{integration_type}/per-user-connection","href":"/api-reference/update-per-user-connection-policy"},{"title":"Update workspace connector policies in bulk","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/{workspace_id}/connector-governance/bulk","href":"/api-reference/update-workspace-connector-policies-in-bulk"}]},{"group":"Brands","pages":[{"title":"List workspace brands","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/workspace/{workspace_id}/brands","href":"/api-reference/list-workspace-brands"},{"title":"Create workspace brand","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/{workspace_id}/brands","href":"/api-reference/create-workspace-brand"},{"title":"Generate workspace brand","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/{workspace_id}/brands/generate","href":"/api-reference/generate-workspace-brand"},{"title":"Get workspace brand","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/workspace/{workspace_id}/brands/{brand_id}","href":"/api-reference/get-workspace-brand"},{"title":"Update workspace brand","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/{workspace_id}/brands/{brand_id}","href":"/api-reference/update-workspace-brand"},{"title":"Delete workspace brand","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/workspace/{workspace_id}/brands/{brand_id}","href":"/api-reference/delete-workspace-brand"},{"title":"Set default workspace brand","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/{workspace_id}/brands/{brand_id}/default","href":"/api-reference/set-default-workspace-brand"},{"title":"Clear default workspace brand","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/workspace/{workspace_id}/brands/{brand_id}/default","href":"/api-reference/clear-default-workspace-brand"}]},{"group":"Skills","pages":[{"title":"List workspace skills","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/workspace/skills","href":"/api-reference/list-workspace-skills"},{"title":"Get workspace skill","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/workspace/skills/{skill_id}","href":"/api-reference/get-workspace-skill"},{"title":"Create workspace skill","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/skills","href":"/api-reference/create-workspace-skill"},{"title":"Update workspace skill","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/skills/{skill_id}","href":"/api-reference/update-workspace-skill"},{"title":"Delete workspace skill","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/workspace/skills/{skill_id}","href":"/api-reference/delete-workspace-skill"}]},{"group":"Billing","pages":[{"title":"List plans","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/billing/tiers","href":"/api-reference/list-plans"},{"title":"Get billing info","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/billing/billing-info","href":"/api-reference/get-billing-info"},{"title":"Get mobile subscription status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/billing/mobile/subscription-status","href":"/api-reference/get-mobile-subscription-status"},{"title":"Create billing portal session","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/create-portal-session","href":"/api-reference/create-billing-portal-session"},{"title":"Create payment method update session","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/create-update-payment-method-portal-session","href":"/api-reference/create-payment-method-update-session"},{"title":"Open invoice","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/open-invoice/{invoice_id}","href":"/api-reference/open-invoice"},{"title":"Retry failed payment","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/retry-payment","href":"/api-reference/retry-failed-payment"},{"title":"Preview plan change","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/preview-upgrade/{price_id}","href":"/api-reference/preview-plan-change"},{"title":"Create plan checkout","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/create-checkout-session/{price_id}","href":"/api-reference/create-plan-checkout"},{"title":"Change plan","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/update-subscription/{price_id}","href":"/api-reference/change-plan"},{"title":"Preview Wix plan change","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/dynamic-offering/preview-subscription","href":"/api-reference/preview-wix-plan-change"},{"title":"Change Wix plan","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/dynamic-offering/update-subscription","href":"/api-reference/change-wix-plan"},{"title":"Turn on auto-renew","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/wix-turn-auto-renew-on","href":"/api-reference/turn-on-auto-renew"},{"title":"Get cancellation impact","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/billing/cancel-subscription/impact","href":"/api-reference/get-cancellation-impact"},{"title":"Preview ILS refund","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/billing/ils-refund-preview","href":"/api-reference/preview-ils-refund"},{"title":"Cancel subscription","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/cancel-subscription","href":"/api-reference/cancel-subscription"},{"title":"Reactivate subscription","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/reactivate-subscription","href":"/api-reference/reactivate-subscription"},{"title":"Cancel scheduled plan change","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/billing/cancel-schedule","href":"/api-reference/cancel-scheduled-plan-change"},{"title":"Refresh Google Play subscription","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/mobile/google-play/refresh","href":"/api-reference/refresh-google-play-subscription"}]},{"group":"Business email","pages":[{"title":"Get business email status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/billing/business-email/status","href":"/api-reference/get-business-email-status"},{"title":"Get business email discount","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/billing/business-email/discount","href":"/api-reference/get-business-email-discount"},{"title":"Get business email purchase link","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/business-email/purchase-url","href":"/api-reference/get-business-email-purchase-link"},{"title":"Get business email setup link","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/business-email/setup-url","href":"/api-reference/get-business-email-setup-link"},{"title":"Get business email management link","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/business-email/manage-url","href":"/api-reference/get-business-email-management-link"},{"title":"Get business email admin console link","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/billing/business-email/admin-console-url","href":"/api-reference/get-business-email-admin-console-link"}]}]}]},{"group":"Superagents API (Beta)","boost":0.75,"icon":"user-robot","pages":[{"group":"Get Started","icon":"book-open","pages":[{"title":"Superagents API Overview","sidebarTitle":"Overview","href":"/developers/references/superagents-api/get-started/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/developers/references/superagents-api/get-started/authentication"}]},{"group":"API Reference","icon":"brackets-curly","pages":[{"title":"Create Superagent","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/agents","href":"/api-reference/create-superagent"},{"title":"List Superagent conversations","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/agents/{agent_id}/conversations","href":"/api-reference/list-superagent-conversations"},{"title":"Create Superagent conversation","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/agents/{agent_id}/conversations","href":"/api-reference/create-superagent-conversation"},{"title":"Get Superagent conversation","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/agents/{agent_id}/conversations/{conversation_id}","href":"/api-reference/get-superagent-conversation"},{"title":"Send Superagent message","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/agents/{agent_id}/conversations/{conversation_id}/messages","href":"/api-reference/send-superagent-message"},{"title":"Delete Superagent message","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/agents/{agent_id}/conversations/{conversation_id}/messages/{message_id}","href":"/api-reference/delete-superagent-message"},{"title":"List Superagent memories","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/agents/{agent_id}/memory","href":"/api-reference/list-superagent-memories"},{"title":"Delete Superagent memory","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/agents/{agent_id}/memory/{memory_id}","href":"/api-reference/delete-superagent-memory"},{"title":"List Superagent webhooks","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/agents/{agent_id}/webhooks","href":"/api-reference/list-superagent-webhooks"},{"title":"Create Superagent webhook","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/agents/{agent_id}/webhooks","href":"/api-reference/create-superagent-webhook"},{"title":"Update Superagent webhook","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/agents/{agent_id}/webhooks/{webhook_id}","href":"/api-reference/update-superagent-webhook"},{"title":"Test Superagent webhook","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/agents/{agent_id}/webhooks/{webhook_id}/test","href":"/api-reference/test-superagent-webhook"},{"title":"Delete Superagent webhook","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/agents/{agent_id}/webhooks/{webhook_id}","href":"/api-reference/delete-superagent-webhook"}]}]},{"group":"Monitoring API","icon":"chart-line","expanded":false,"pages":[{"group":"Get Started","icon":"book-open","pages":[{"title":"Enterprise Monitoring API Overview","href":"/developers/references/monitoring-api/get-started/overview"},{"title":"Authentication","href":"/developers/references/monitoring-api/get-started/authentication"},{"title":"Rate Limits","href":"/developers/references/monitoring-api/get-started/rate-limits"}]},{"group":"API Reference","icon":"brackets-curly","pages":[{"group":"system","pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /health","href":"/api-reference/monitoring/system/health-check"}]},{"group":"analytics","pages":[{"title":"Get analytics","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /analytics/{workspace_id}","href":"/api-reference/monitoring/analytics/get-analytics"}]},{"group":"users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /{workspace_id}/users","href":"/api-reference/monitoring/users/list-users"},{"title":"Get user","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /{workspace_id}/users/{user_id}","href":"/api-reference/monitoring/users/get-user"},{"title":"List user apps","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /{workspace_id}/users/{user_id}/apps","href":"/api-reference/monitoring/users/list-user-apps"},{"title":"List user Superagents","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /{workspace_id}/users/{user_id}/superagents","href":"/api-reference/monitoring/users/list-user-superagents"}]},{"group":"apps","pages":[{"title":"List app metrics","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /{workspace_id}/apps","href":"/api-reference/monitoring/apps/list-app-metrics"},{"title":"Get app analytics","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /{workspace_id}/apps/{app_id}/analytics","href":"/api-reference/monitoring/apps/get-app-analytics"}]},{"group":"superagents","pages":[{"title":"List Superagents","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /{workspace_id}/superagents","href":"/api-reference/monitoring/superagents/list-superagents"},{"title":"Get Superagent analytics","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /{workspace_id}/superagents/{agent_id}/analytics","href":"/api-reference/monitoring/superagents/get-superagent-analytics"}]}]}]},{"group":"Audit Logs API","icon":"clipboard-list","expanded":false,"pages":[{"group":"Get Started","icon":"book-open","pages":[{"title":"Audit Logs API Overview","href":"/developers/references/audit-logs-api/get-started/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/developers/references/audit-logs-api/get-started/authentication"},{"title":"Rate Limits","href":"/developers/references/audit-logs-api/get-started/rate-limits"},{"title":"Event Types","sidebarTitle":"Event Types","href":"/developers/references/audit-logs-api/get-started/event-types"},{"title":"Security scan findings","sidebarTitle":"Security scan findings","href":"/developers/references/audit-logs-api/get-started/security-scan-findings"}]},{"group":"API Reference","icon":"brackets-curly","pages":[{"group":"audit-logs","pages":[{"title":"Get security scan findings","deprecated":null,"version":null,"openapi":"/developers/references/audit-logs-api/audit-logs-openapi.json get /{workspace_id}/security-scan-runs/{run_id}","href":"/api-reference/audit-logs/get-security-scan-findings"},{"title":"List audit logs","deprecated":null,"version":null,"openapi":"/developers/references/audit-logs-api/audit-logs-openapi.json post /{workspace_id}/list","href":"/api-reference/audit-logs/list-audit-logs"}]}]}]},{"group":"Compliance API","icon":"shield-check","expanded":false,"pages":[{"group":"Get Started","icon":"book-open","pages":[{"title":"Compliance API for security partners","sidebarTitle":"Overview","href":"/developers/references/compliance-api/get-started/overview"},{"title":"Register as a partner","sidebarTitle":"Register as a partner","href":"/developers/references/compliance-api/get-started/register-as-a-partner"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/developers/references/compliance-api/get-started/authentication"},{"title":"Rate limits","href":"/developers/references/compliance-api/get-started/rate-limits"},{"title":"Error codes","sidebarTitle":"Error codes","href":"/developers/references/compliance-api/get-started/error-codes"}]},{"group":"API Reference","icon":"brackets-curly","pages":[{"title":"Get workspace configuration","deprecated":null,"version":null,"openapi":"/developers/references/compliance-api/compliance-openapi.json get /{workspace_id}","href":"/api-reference/compliance/get-workspace-configuration"},{"title":"List agents","deprecated":null,"version":null,"openapi":"/developers/references/compliance-api/compliance-openapi.json get /{workspace_id}/agents","href":"/api-reference/compliance/list-agents"},{"title":"List apps","deprecated":null,"version":null,"openapi":"/developers/references/compliance-api/compliance-openapi.json get /{workspace_id}/apps","href":"/api-reference/compliance/list-apps"},{"title":"List backend functions","deprecated":null,"version":null,"openapi":"/developers/references/compliance-api/compliance-openapi.json get /{workspace_id}/functions","href":"/api-reference/compliance/list-backend-functions"},{"title":"List domains","deprecated":null,"version":null,"openapi":"/developers/references/compliance-api/compliance-openapi.json get /{workspace_id}/domains","href":"/api-reference/compliance/list-domains"},{"title":"List entities","deprecated":null,"version":null,"openapi":"/developers/references/compliance-api/compliance-openapi.json get /{workspace_id}/entities","href":"/api-reference/compliance/list-entities"},{"title":"List integrations","deprecated":null,"version":null,"openapi":"/developers/references/compliance-api/compliance-openapi.json get /{workspace_id}/integrations","href":"/api-reference/compliance/list-integrations"},{"title":"List secrets","deprecated":null,"version":null,"openapi":"/developers/references/compliance-api/compliance-openapi.json get /{workspace_id}/secrets","href":"/api-reference/compliance/list-secrets"},{"title":"List security findings","deprecated":null,"version":null,"openapi":"/developers/references/compliance-api/compliance-openapi.json get /{workspace_id}/security-findings","href":"/api-reference/compliance/list-security-findings"},{"title":"List workspace API keys","deprecated":null,"version":null,"openapi":"/developers/references/compliance-api/compliance-openapi.json get /{workspace_id}/api-keys","href":"/api-reference/compliance/list-workspace-api-keys"},{"title":"List workspace members","deprecated":null,"version":null,"openapi":"/developers/references/compliance-api/compliance-openapi.json get /{workspace_id}/members","href":"/api-reference/compliance/list-workspace-members"}]}]},{"group":"Outbound webhooks","icon":"paper-plane","expanded":false,"pages":[{"group":"Get Started","icon":"book-open","pages":[{"title":"Outbound webhooks overview","sidebarTitle":"Overview","href":"/developers/references/outbound-webhooks/get-started/overview"},{"title":"Setting up endpoints","sidebarTitle":"Setting up endpoints","href":"/developers/references/outbound-webhooks/get-started/setting-up-endpoints"},{"title":"Verifying requests","sidebarTitle":"Verifying requests","href":"/developers/references/outbound-webhooks/get-started/verifying-requests"},{"title":"Event types","sidebarTitle":"Event types","href":"/developers/references/outbound-webhooks/get-started/event-types"},{"title":"Delivery and retries","sidebarTitle":"Delivery and retries","href":"/developers/references/outbound-webhooks/get-started/delivery-and-retries"}]},{"group":"Events","boost":0.5,"icon":"bolt","pages":[{"title":"app.created.v1","openapi":"developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.created.v1","href":"/developers/references/outbound-webhooks/events/app-created-v1"},{"title":"app.published.v1","openapi":"developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.published.v1","href":"/developers/references/outbound-webhooks/events/app-published-v1"},{"title":"app.unpublished.v1","openapi":"developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.unpublished.v1","href":"/developers/references/outbound-webhooks/events/app-unpublished-v1"},{"title":"app.deleted.v1","openapi":"developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.deleted.v1","href":"/developers/references/outbound-webhooks/events/app-deleted-v1"},{"title":"app.restored.v1","openapi":"developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.restored.v1","href":"/developers/references/outbound-webhooks/events/app-restored-v1"},{"title":"chat.turn_started.v1","openapi":"developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook chat.turn_started.v1","href":"/developers/references/outbound-webhooks/events/chat-turn-started-v1"},{"title":"chat.turn_ended.v1","openapi":"developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook chat.turn_ended.v1","href":"/developers/references/outbound-webhooks/events/chat-turn-ended-v1"},{"title":"webhook.test.v1","openapi":"developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook webhook.test.v1","href":"/developers/references/outbound-webhooks/events/webhook-test-v1"}]},{"group":"API Reference","icon":"brackets-curly","pages":[{"group":"outbound-webhooks","pages":[{"title":"List endpoints","deprecated":null,"version":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json get /endpoints","href":"/api-reference/outbound-webhooks/list-endpoints"},{"title":"Register an endpoint","deprecated":null,"version":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json post /endpoints","href":"/api-reference/outbound-webhooks/register-an-endpoint"},{"title":"Get an endpoint","deprecated":null,"version":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json get /endpoints/{endpoint_id}","href":"/api-reference/outbound-webhooks/get-an-endpoint"},{"title":"Delete an endpoint","deprecated":null,"version":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json delete /endpoints/{endpoint_id}","href":"/api-reference/outbound-webhooks/delete-an-endpoint"},{"title":"Update an endpoint","deprecated":null,"version":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json patch /endpoints/{endpoint_id}","href":"/api-reference/outbound-webhooks/update-an-endpoint"},{"title":"Test an endpoint","deprecated":null,"version":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json post /endpoints/{endpoint_id}/test","href":"/api-reference/outbound-webhooks/test-an-endpoint"},{"title":"Pause an endpoint","deprecated":null,"version":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json post /endpoints/{endpoint_id}/pause","href":"/api-reference/outbound-webhooks/pause-an-endpoint"},{"title":"Resume an endpoint","deprecated":null,"version":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json post /endpoints/{endpoint_id}/resume","href":"/api-reference/outbound-webhooks/resume-an-endpoint"},{"title":"Get the public key set","deprecated":null,"version":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json get /workspaces/{workspace_id}/keys","href":"/api-reference/outbound-webhooks/get-the-public-key-set"}]},{"group":"events","pages":[{"title":"An app was created","version":null,"deprecated":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.created.v1","href":"/api-reference/events/an-app-was-created"},{"title":"An app version was published","version":null,"deprecated":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.published.v1","href":"/api-reference/events/an-app-version-was-published"},{"title":"An app was taken offline","version":null,"deprecated":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.unpublished.v1","href":"/api-reference/events/an-app-was-taken-offline"},{"title":"An app was moved to trash restorable not erased","version":null,"deprecated":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.deleted.v1","href":"/api-reference/events/an-app-was-moved-to-trash-restorable-not-erased"},{"title":"An app was restored from trash","version":null,"deprecated":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.restored.v1","href":"/api-reference/events/an-app-was-restored-from-trash"},{"title":"The ai started working on a message","version":null,"deprecated":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook chat.turn_started.v1","href":"/api-reference/events/the-ai-started-working-on-a-message"},{"title":"The ai finished responding to a message","version":null,"deprecated":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook chat.turn_ended.v1","href":"/api-reference/events/the-ai-finished-responding-to-a-message"},{"title":"Endpoint activation test","version":null,"deprecated":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook webhook.test.v1","href":"/api-reference/events/endpoint-activation-test"}]}]}]}],"global":{"anchors":[{"anchor":"Developer Platform","icon":"arrow-left","href":"/developers/home"}]}},{"dropdown":"White label (Beta)","icon":"tag","groups":[{"group":"Start here","icon":"flag","pages":[{"title":"White Label Overview","sidebarTitle":"Overview","href":"/developers/white-label/overview"},{"title":"Setup checklist","sidebarTitle":"Setup checklist","href":"/developers/white-label/setup-checklist"},{"title":"Tenancy and credentials","sidebarTitle":"Tenancy and credentials","href":"/developers/white-label/tenancy-and-credentials"}]},{"group":"Configure","icon":"gear","pages":[{"title":"Configuring your system prompt","sidebarTitle":"System prompt","href":"/developers/white-label/system-prompt"},{"title":"Design system","sidebarTitle":"Design system","href":"/developers/white-label/design-system"},{"title":"Skills and MCP","sidebarTitle":"Skills and MCP","href":"/developers/white-label/skills-and-mcp"},{"title":"Custom instructions","sidebarTitle":"Custom instructions","href":"/developers/white-label/custom-instructions"}]},{"group":"Build an app","icon":"hammer","pages":[{"title":"The build turn","sidebarTitle":"The build turn","href":"/developers/white-label/the-build-turn"},{"title":"Live updates","sidebarTitle":"Live updates","href":"/developers/white-label/live-updates"},{"title":"Embed the app","sidebarTitle":"Embed the app","href":"/developers/white-label/embed-the-app"},{"title":"Common APIs","sidebarTitle":"Common APIs","href":"/developers/white-label/common-apis"}]}],"global":{"anchors":[{"anchor":"Developer Platform","icon":"arrow-left","href":"/developers/home"}]}},{"dropdown":"Skills","icon":"wand-magic-sparkles","hidden":true,"groups":[{"group":"base44-cli","boost":0.3,"hidden":true,"pages":[{"title":"Base44 CLI","href":"/developers/skills/base44-cli/index"},{"title":"Creating Actors","href":"/developers/skills/base44-cli/references/actors-create"},{"title":"base44 actors deploy","href":"/developers/skills/base44-cli/references/actors-deploy"},{"title":"base44 agent-skills pull","href":"/developers/skills/base44-cli/references/agent-skills-pull"},{"title":"base44 agent-skills push","href":"/developers/skills/base44-cli/references/agent-skills-push"},{"title":"base44 agents pull","href":"/developers/skills/base44-cli/references/agents-pull"},{"title":"base44 agents push","href":"/developers/skills/base44-cli/references/agents-push"},{"title":"base44 api catalog","href":"/developers/skills/base44-cli/references/api-catalog"},{"title":"base44 api fetch","href":"/developers/skills/base44-cli/references/api-fetch"},{"title":"base44 api grep","href":"/developers/skills/base44-cli/references/api-grep"},{"title":"base44 api search","href":"/developers/skills/base44-cli/references/api-search"},{"title":"base44 login","href":"/developers/skills/base44-cli/references/auth-login"},{"title":"base44 logout","href":"/developers/skills/base44-cli/references/auth-logout"},{"title":"base44 auth password-login","href":"/developers/skills/base44-cli/references/auth-password-login"},{"title":"base44 auth pull","href":"/developers/skills/base44-cli/references/auth-pull"},{"title":"base44 auth push","href":"/developers/skills/base44-cli/references/auth-push"},{"title":"base44 auth social-login","href":"/developers/skills/base44-cli/references/auth-social-login"},{"title":"base44 auth sso","href":"/developers/skills/base44-cli/references/auth-sso"},{"title":"base44 whoami","href":"/developers/skills/base44-cli/references/auth-whoami"},{"title":"Creating Connectors","href":"/developers/skills/base44-cli/references/connectors-create"},{"title":"base44 connectors initiate","href":"/developers/skills/base44-cli/references/connectors-initiate"},{"title":"base44 connectors list-available","href":"/developers/skills/base44-cli/references/connectors-list-available"},{"title":"base44 connectors pull","href":"/developers/skills/base44-cli/references/connectors-pull"},{"title":"base44 connectors push","href":"/developers/skills/base44-cli/references/connectors-push"},{"title":"base44 create","href":"/developers/skills/base44-cli/references/create"},{"title":"base44 dashboard open","href":"/developers/skills/base44-cli/references/dashboard"},{"title":"base44 deploy","href":"/developers/skills/base44-cli/references/deploy"},{"title":"base44 dev","href":"/developers/skills/base44-cli/references/dev"},{"title":"base44 eject","href":"/developers/skills/base44-cli/references/eject"},{"title":"Creating Entities","href":"/developers/skills/base44-cli/references/entities-create"},{"title":"base44 entities push","href":"/developers/skills/base44-cli/references/entities-push"},{"title":"base44 exec","href":"/developers/skills/base44-cli/references/exec"},{"title":"Creating Functions","href":"/developers/skills/base44-cli/references/functions-create"},{"title":"base44 functions delete","href":"/developers/skills/base44-cli/references/functions-delete"},{"title":"base44 functions deploy","href":"/developers/skills/base44-cli/references/functions-deploy"},{"title":"base44 functions list","href":"/developers/skills/base44-cli/references/functions-list"},{"title":"base44 functions pull","href":"/developers/skills/base44-cli/references/functions-pull"},{"title":"base44 link","href":"/developers/skills/base44-cli/references/link"},{"title":"RLS Examples","href":"/developers/skills/base44-cli/references/rls-examples"},{"title":"base44 scaffold","href":"/developers/skills/base44-cli/references/scaffold"},{"title":"base44 secrets delete","href":"/developers/skills/base44-cli/references/secrets-delete"},{"title":"base44 secrets list","href":"/developers/skills/base44-cli/references/secrets-list"},{"title":"base44 secrets set","href":"/developers/skills/base44-cli/references/secrets-set"},{"title":"base44 site deploy","href":"/developers/skills/base44-cli/references/site-deploy"},{"title":"base44 site open","href":"/developers/skills/base44-cli/references/site-open"},{"title":"`base44 types generate`","href":"/developers/skills/base44-cli/references/types-generate"},{"title":"base44 visibility","href":"/developers/skills/base44-cli/references/visibility"},{"title":"base44 workflows list","href":"/developers/skills/base44-cli/references/workflows-list"},{"title":"base44 workflows runs","href":"/developers/skills/base44-cli/references/workflows-runs"},{"title":"base44 workspace get","href":"/developers/skills/base44-cli/references/workspace-get"},{"title":"base44 workspace list","href":"/developers/skills/base44-cli/references/workspace-list"},{"title":"base44 workspace move","href":"/developers/skills/base44-cli/references/workspace-move"}]},{"group":"base44-platform-actors","boost":0.3,"hidden":true,"pages":[{"title":"Base44 actors","href":"/developers/skills/base44-platform-actors/index"},{"title":"Base44 actors: Realtime actors (mobile apps)","href":"/developers/skills/base44-platform-actors/references/mobile"},{"title":"Base44 actors: Realtime actors (web apps)","href":"/developers/skills/base44-platform-actors/references/web"}]},{"group":"base44-platform-agents","boost":0.3,"hidden":true,"pages":[{"title":"Base44 agents","href":"/developers/skills/base44-platform-agents/index"},{"title":"Base44 agents: Agents (Vite SPA: tools are backend functions)","href":"/developers/skills/base44-platform-agents/references/web-spa"},{"title":"Base44 agents: Agents (TanStack Start: tools are server routes)","href":"/developers/skills/base44-platform-agents/references/web-tanstack"}]},{"group":"base44-platform-backend-functions","boost":0.3,"hidden":true,"pages":[{"title":"Base44 backend functions","href":"/developers/skills/base44-platform-backend-functions/index"},{"title":"Base44 backend functions: Backend functions (mobile apps)","href":"/developers/skills/base44-platform-backend-functions/references/mobile"},{"title":"Base44 backend functions: Backend functions (Vite SPA)","href":"/developers/skills/base44-platform-backend-functions/references/web-spa"},{"title":"Base44 backend functions: Server functions and server routes (TanStack Start)","href":"/developers/skills/base44-platform-backend-functions/references/web-tanstack"}]},{"group":"base44-platform-connectors","boost":0.3,"hidden":true,"pages":[{"title":"Base44 connectors","href":"/developers/skills/base44-platform-connectors/index"},{"title":"Base44 connectors: App connectors (mobile apps)","href":"/developers/skills/base44-platform-connectors/references/mobile"},{"title":"Base44 connectors: App connectors (Vite SPA)","href":"/developers/skills/base44-platform-connectors/references/web-spa"},{"title":"Base44 connectors: App connectors (TanStack Start)","href":"/developers/skills/base44-platform-connectors/references/web-tanstack"}]},{"group":"base44-platform-entities","boost":0.3,"hidden":true,"pages":[{"title":"Base44 entities","href":"/developers/skills/base44-platform-entities/index"},{"title":"Base44 entities: Entities and the entity SDK (mobile apps)","href":"/developers/skills/base44-platform-entities/references/mobile"},{"title":"Base44 entities: Row-level security (RLS)","href":"/developers/skills/base44-platform-entities/references/rls"},{"title":"Base44 entities: Entities and the entity SDK (web apps)","href":"/developers/skills/base44-platform-entities/references/web"}]},{"group":"base44-platform-frontend","boost":0.3,"hidden":true,"pages":[{"title":"Base44 frontend","href":"/developers/skills/base44-platform-frontend/index"},{"title":"Base44 frontend: Native mobile app (Expo, React Native, NativeWind)","href":"/developers/skills/base44-platform-frontend/references/mobile"},{"title":"Base44 frontend: Web app, Vite SPA","href":"/developers/skills/base44-platform-frontend/references/web-spa"},{"title":"Base44 frontend: Web app, TanStack Start","href":"/developers/skills/base44-platform-frontend/references/web-tanstack"}]},{"group":"base44-platform-integrations-sdk","boost":0.3,"hidden":true,"pages":[{"title":"Base44 integrations sdk","href":"/developers/skills/base44-platform-integrations-sdk/index"},{"title":"Base44 integrations sdk: Integrations SDK (mobile apps)","href":"/developers/skills/base44-platform-integrations-sdk/references/mobile"},{"title":"Base44 integrations sdk: Integrations and analytics SDK (Vite SPA)","href":"/developers/skills/base44-platform-integrations-sdk/references/web-spa"},{"title":"Base44 integrations sdk: Integrations and analytics SDK (TanStack Start)","href":"/developers/skills/base44-platform-integrations-sdk/references/web-tanstack"}]},{"group":"base44-platform-platform","boost":0.3,"hidden":true,"pages":[{"title":"Base44 platform","href":"/developers/skills/base44-platform-platform/index"},{"title":"Base44 platform: Native mobile app (Expo)","href":"/developers/skills/base44-platform-platform/references/mobile"},{"title":"Base44 platform: Web app, Vite SPA","href":"/developers/skills/base44-platform-platform/references/web-spa"},{"title":"Base44 platform: Web app, TanStack Start","href":"/developers/skills/base44-platform-platform/references/web-tanstack"}]},{"group":"base44-platform-workflows","boost":0.3,"hidden":true,"pages":[{"title":"Base44 workflows","href":"/developers/skills/base44-platform-workflows/index"},{"title":"Base44 workflows: Legacy automations (apps that predate workflows)","href":"/developers/skills/base44-platform-workflows/references/automations-legacy"},{"title":"Backend functions","href":"/developers/skills/base44-platform-workflows/references/backend-functions"},{"title":"Base44 workflows: Legacy automations (mobile apps that predate workflows)","href":"/developers/skills/base44-platform-workflows/references/mobile-automations"},{"title":"Web tanstack","href":"/developers/skills/base44-platform-workflows/references/web-tanstack"}]},{"group":"base44-remote-dev","boost":0.3,"hidden":true,"pages":[{"title":"Remotely develop a Base44 app over MCP","href":"/developers/skills/base44-remote-dev/index"}]},{"group":"base44-sandbox","boost":0.3,"hidden":true,"pages":[{"title":"Base44 in the Cloud Sandbox","href":"/developers/skills/base44-sandbox/index"}]},{"group":"base44-sdk","boost":0.3,"hidden":true,"pages":[{"title":"Base44 Coder","href":"/developers/skills/base44-sdk/index"},{"title":"Base44 SDK Quick Reference","href":"/developers/skills/base44-sdk/references/QUICK_REFERENCE"},{"title":"Actors Module","href":"/developers/skills/base44-sdk/references/actors"},{"title":"AI Gateway Module","href":"/developers/skills/base44-sdk/references/ai-gateway"},{"title":"Analytics Module","href":"/developers/skills/base44-sdk/references/analytics"},{"title":"App Logs Module","href":"/developers/skills/base44-sdk/references/app-logs"},{"title":"Auth Module","href":"/developers/skills/base44-sdk/references/auth"},{"title":"Agents Module","href":"/developers/skills/base44-sdk/references/base44-agents"},{"title":"Client Setup","href":"/developers/skills/base44-sdk/references/client"},{"title":"Connectors Module","href":"/developers/skills/base44-sdk/references/connectors"},{"title":"Entities Module","href":"/developers/skills/base44-sdk/references/entities"},{"title":"Functions Module","href":"/developers/skills/base44-sdk/references/functions"},{"title":"Integrations Module","href":"/developers/skills/base44-sdk/references/integrations"},{"title":"SSO Module","href":"/developers/skills/base44-sdk/references/sso"},{"title":"Users Module","href":"/developers/skills/base44-sdk/references/users"}]},{"group":"base44-troubleshooter","boost":0.3,"hidden":true,"pages":[{"title":"Troubleshoot Production Issues","href":"/developers/skills/base44-troubleshooter/index"},{"title":"base44 logs","href":"/developers/skills/base44-troubleshooter/references/project-logs"}]}],"global":{"anchors":[{"anchor":"Developer Platform","icon":"arrow-left","href":"/developers/home"}]}},{"dropdown":"Compliance API","icon":"shield-check","hidden":true,"groups":[{"group":"Compliance API","pages":[{"title":"Compliance API for security partners","sidebarTitle":"Overview","href":"/developers/references/compliance-api/get-started/overview"},{"title":"Register as a partner","sidebarTitle":"Register as a partner","href":"/developers/references/compliance-api/get-started/register-as-a-partner"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/developers/references/compliance-api/get-started/authentication"},{"title":"Rate limits","href":"/developers/references/compliance-api/get-started/rate-limits"},{"title":"Error codes","sidebarTitle":"Error codes","href":"/developers/references/compliance-api/get-started/error-codes"}]}],"global":{"anchors":[{"anchor":"Developer Platform","icon":"arrow-left","href":"/developers/home"}]}}]},{"tab":"Account \u0026 Billing","pages":[{"title":"Account \u0026 Billing","href":"/Account-and-billing/Billing-and-plans"}]},{"tab":"Enterprise","pages":[{"title":"Enterprise","href":"/Enterprise/Base44-for-enterprises"}]}]},{"language":"pt-BR","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/pt-BR/changelog/product","label":"Registro de alterações"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"pages":[{"title":"pt-BR","href":"/pt-BR/documentation/setting-up-your-app/setting-up-payments"}]},{"language":"es","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/es/changelog/product","label":"Registro de cambios"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"pages":[{"title":"es","href":"/es/documentation/setting-up-your-app/setting-up-payments"}]},{"language":"he","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/he/changelog/product","label":"יומן שינויים"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"hidden":true,"pages":[{"title":"he","href":"/he/documentation/setting-up-your-app/setting-up-payments","hidden":true}]},{"language":"ja","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/ja/changelog/product","label":"変更履歴"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"pages":[{"title":"ja","href":"/ja/documentation/setting-up-your-app/setting-up-payments"}]},{"language":"de","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/de/changelog/product","label":"Änderungsprotokoll"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"pages":[{"title":"de","href":"/de/documentation/setting-up-your-app/setting-up-payments"}]},{"language":"fr","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/fr/changelog/product","label":"Notes de version"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"pages":[{"title":"fr","href":"/fr/documentation/setting-up-your-app/setting-up-payments"}]},{"language":"it","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/it/changelog/product","label":"Registro modifiche"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"pages":[{"title":"it","href":"/it/documentation/setting-up-your-app/setting-up-payments"}]}]},"basePath":"","title":"Setting up Stripe - Base44 Support Documentation","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["2bfc744e19","07c022d89b","a74be98ba7"],"chunks":["NarrationPlayer-Cf14tRaX.js","types-CiTgMxws.js","shallow-D8iEBr5z.js","Frame-DvzxQbD0.js","DynamicMarkdown-mQG_iQiE.js","zoom-image-lightbox-BFbLClTf.js","lightbox-handle-r17bVUz3.js"]}
