Provision and distribute White-label Retool Mobile apps
To create a White-label app, you provide Retool with the necessary provisioning resources. Retool then generates a custom version of the mobile app for you and uploads it to the iOS App Store or Google Play.
White-label apps are only available to organizations on the Enterprise plan. The requirements depend on whether Retool or your organization manages app distribution. If you’re an existing Enterprise customer, reach out to your deployed engineer to get started. If you are looking to upgrade to the Enterprise plan, complete this form.
Learn more in the White-label app explanation guide.
1. Provision a White-label app from Retool
You can request a White-label app by completing the provisioning form. You must provide the following provisioning resources when submitting the request.
| Resource | Description | Required for Retool-managed apps | Required for self-managed apps |
|---|---|---|---|
| Icon | The app icon. Must be a PNG image with a minimum resolution of 1024x1024. Width-to-height ratio must be 1:1. | ||
| Full-size logo | The image displayed in various places, such as the iOS launch screen. Must be a PNG image with a minimum resolution of 320x80. Width-to-height ratio must be 4:1. | ||
| Compact logo | The image displayed in various places where the full-size logo cannot be used, such as the Android splash screen. This can be the same as the app icon. Must be a PNG image with a minimum resolution of 1024x1024. Width-to-height ratio must be 1:1. | ||
| Splash screen color | The splash screen background color. Must be a hex color value. | ||
| Login logo | The image displayed on login the screen. Must be a PNG image with a minimum resolution of 320x80. Width-to-height ratio must be 4:1. | ||
| App display name | The name of the app (e.g., My Custom App). | ||
| App’s Store name | The name to display in the store listing for the iOS App Store or Google Play. This name must be unique across all apps on the store. If your app name is not unique, combine it with your company name (e.g., My Custom App by ACME). | ||
| Instance URL | The URL of your company’s Retool instance (e.g., example.retool.com). | ||
| Primary app’s UUID (Single-app only) | The UUID to use for the White-label app (optional). | ||
| Apple Organization ID | The Apple Organization ID to publish apps to the iOS App Store on your behalf. | ||
| Managed Play Organization Id | The Google Organization ID to publish apps to Google Play on your behalf. | ||
| Apple Developer Account Credentials | Account credentials with Developer access for your Apple Developer Account. | ||
| Play Store Developer Account Credentials | Account credentials with Developer access for your Google Developer Account. | ||
| Apple Service Key | The Service Key for App Store Connect. | ||
| Google Service Key | The Service Key for Google Play Console. |
Retool will notify you when your White-label app is ready. It is not automatically published.
2. Distribute a White-label app
- Retool-managed distribution
- Self-managed distribution
Retool publishes White-label apps on your behalf to the iOS App Store or Google Play. These apps are visible only to users in your organization. Retool also manages updates and store reviews, and you have control over the release schedule.
To distribute Retool-managed White-label apps to devices, complete the following steps for either iOS or Android.
iOS
- Link your MDM solution to Apple Business Manager.
- Add your devices from Apple Configurator to Apple Business Manager. Refer to Apple's documentation for instructions.
- Assign devices to your MDM server. You can either assign devices manually or configure automatic assignment.
- Enroll your devices in your MDM solution. Management policies are applied to enrolled devices and will add them to Apple Business Manager.
- Refer to your MDM solution's documentation to install White-label apps onto managed devices.
Android
Enroll your devices into your EMM solution. Once enrolled, users can install the White-label app onto their managed devices.
You are responsible for publishing self-managed White-label apps to the iOS App Store or Google Play. Once Retool notifies you that the app binaries have been uploaded, you can submit the app for review. After publishing, your users can install the app.