docs.retool.com Open in urlscan Pro
2606:4700::6812:d238  Public Scan

Submitted URL: http://docs.retool.com/docs
Effective URL: https://docs.retool.com/docs
Submission: On September 07 via api from IE — Scanned from DE

Form analysis 0 forms found in the DOM

Text Content

Jump to Content
GuidesComponentsIntegrationsCommunity
GuidesAPI Reference

--------------------------------------------------------------------------------

GuidesComponentsIntegrationsCommunitySign inBook a demoGet started
Guides
Sign inBook a demoGet started

Guides
Retool Docs
Search
CTRL-K
Get startedRetool DocsQuickstartRetool UniversitySQL in RetoolJavaScript in
RetoolQuery AnatomyApp ManagementTutorialsApprove new user sign-upsInteract with
AirtableInteract with Google SheetsControl functionality with feature
flagsCreate a step-by-step interfaceCreate forms using the Form componentCreate
forms using the JSON Schema Form componentInsert CSVs into a databaseManage dog
walkersShare data between appsTag images for machine learningUpload photos to
Amazon S3TemplatesRecent updatesConnect your data
sourcesResourcesIntegrationsAsana IntegrationAthena IntegrationBigQuery
IntegrationCassandra IntegrationCircleCI IntegrationClose IntegrationCouchDB
IntegrationDatadog IntegrationDenodo IntegrationDynamoDB
IntegrationElasticsearch IntegrationFauna IntegrationFirebase / Firestore
IntegrationFront IntegrationGitHub IntegrationGoogle Analytics API
IntegrationGoogle Cloud Storage IntegrationGoogle Maps APIs IntegrationGoogle
Sheets IntegrationGraphQL IntegrationgRPC IntegrationJira IntegrationLambda
IntegrationLinear IntegrationMicrosoft SQL Server IntegrationMongoDB
IntegrationMySQL IntegrationOneSignal IntegrationOpenAPI IntegrationOracle
Database IntegrationPostgreSQL IntegrationRedis IntegrationRedshift
IntegrationS3 IntegrationSalesforce IntegrationSAP Hana IntegrationSendGrid
IntegrationShopify IntegrationSlack IntegrationSMTP IntegrationSnowflake
IntegrationStripe IntegrationTwilio IntegrationVertica IntegrationZendesk
IntegrationConnect to a databaseConnect to an APIAPI AuthenticationCustom API
authenticationSSH tunnelingTroubleshoot connectionsCreating a Google OAuth 2.0
clientConnecting to analytics vendorsBuild your appsApp editorCustom keyboard
shortcutsApp documentationAssemble componentsPresent data in tablesBuild charts
and graphsDisplay imagesContainersFormsNavigationCreate custom list viewsDefine
option listsUpgrading deprecated componentsRetool Markdown and HTML
referenceDevelop custom componentsReading and writing dataMaking API
requestsReading from SQLWriting to SQLQuery anything with SQLAdding a new record
to your database or APIReusing queriesCaching in RetoolReferenceCreate tables
using the Data EditorSQL CheatsheetEvent HandlersWriting
JavaScriptTransformersScripting RetoolTemporary stateDynamic JSONUpload multiple
files through a GCS / S3 resourceReferenceDebugging JavaScriptPreloaded
JavaScript and LibrariesModulesDesign and usabilityQuery LibraryURL query
parametersComponent LibraryAlertAnnotated TextAvatarAvatar GroupAuth
LoginButtonButton GroupBounding BoxCalendarCascaderChartCheckboxCheckbox
GroupCheckbox TreeCircular ImageCollapsible
ContainerCommentContainerCurrencyCustom ComponentDateDate TimeDate
RangeDataDividerDropdown ButtonEditable NumberEditable TextEmailFeature
FlagsFile ButtonFile DropzoneFile InputFormIconIFrameImageJSON EditorJSON
ExplorerJSON Schema FormKey ValueLinkListboxList ViewLookerMapbox
MapMicrophoneModalMonthMultiselectMultiselect ListboxNumber InputOutline
ButtonPaginationPasswordPDFPercentProgress BarProgress CircleQuery BuilderRadio
GroupRange SliderRatingRich Text EditorS3 UploaderScannerSegmented
ControlSelectSignature PadSliderSpacerSplit ButtonStatisticStepsStepped
ContainerStripe Card FormSwitchSwitch GroupTabbed ContainerTableauTagsTableText
AreaTabsTimeTimelineTimerTextText InputToggle ButtonToggle
LinkVideoWizardYearManage your organizationInviting users and
authenticationUpdate billing informationDisabling usersAudit logsSSOSSO with
OpenID providersSCIM user provisioningSync Google Groups to RetoolWorkspacesUser
permissionsSecurityDeploy on-premiseSelf-hosted RetoolMonitor resource
utilizationUpdating self-hosted RetoolSelf-hosted Retool release notesNetwork
and storage requirementsRetool's storage databaseConnecting via HTTP
proxyHorizontally scale self-hosted RetoolCertificates and internal certificate
authoritiesEnvironment VariablesManage secrets with environment variablesManage
secrets with the file systemDevelop and scaleDeploy Retool at scaleManage Retool
deployments with a hub and spoke modelEnvironmentsUsing multiple
environmentsMulti-instance deploymentsSource ControlSet up Source Control with
GitHubSet up Source Control with GitLabGet started with Source
ControlRecommended workflow for Source ControlManaging branchesResolving
conflictsMigrating from Git SyncingSource Control (Other)Git SyncingRelease
managementApp performance best practicesDebug ToolsManage Source Control
deploymentsBeta featuresRetool DatabaseRetool MobileRetool Mobile
QuickstartRetool Mobile screensRetool Mobile componentsRetool Mobile app design
and layoutRetool Mobile app deploymentRetool Mobile component libraryBuild an
inventory management app on Retool MobileBuild a field sales app on Retool
MobileBuild a site inspection app on Retool MobileTestingLegalPrivacy policy
All
Guides
Reference
Pages

START TYPING TO SEARCH…


GET STARTED

 * Retool Docs
 * Quickstart
 * Retool University
   * SQL in Retool
   * JavaScript in Retool
   * Query Anatomy
   * App Management
 * Tutorials
   * Approve new user sign-ups
   * Interact with Airtable
   * Interact with Google Sheets
   * Control functionality with feature flags
   * Create a step-by-step interface
   * Create forms using the Form component
   * Create forms using the JSON Schema Form component
   * Insert CSVs into a database
   * Manage dog walkers
   * Share data between apps
   * Tag images for machine learning
   * Upload photos to Amazon S3
 * Templates
 * Recent updates


CONNECT YOUR DATA SOURCES

 * Resources
 * Integrations
   * Asana Integration
   * Athena Integration
   * BigQuery Integration
   * Cassandra Integration
   * CircleCI Integration
   * Close Integration
   * CouchDB Integration
   * Datadog Integration
   * Denodo Integration
   * DynamoDB Integration
   * Elasticsearch Integration
   * Fauna Integration
   * Firebase / Firestore Integration
   * Front Integration
   * GitHub Integration
   * Google Analytics API Integration
   * Google Cloud Storage Integration
   * Google Maps APIs Integration
   * Google Sheets Integration
   * GraphQL Integration
   * gRPC Integration
   * Jira Integration
   * Lambda Integration
   * Linear Integration
   * Microsoft SQL Server Integration
   * MongoDB Integration
   * MySQL Integration
   * OneSignal Integration
   * OpenAPI Integration
   * Oracle Database Integration
   * PostgreSQL Integration
   * Redis Integration
   * Redshift Integration
   * S3 Integration
   * Salesforce Integration
   * SAP Hana Integration
   * SendGrid Integration
   * Shopify Integration
   * Slack Integration
   * SMTP Integration
   * Snowflake Integration
   * Stripe Integration
   * Twilio Integration
   * Vertica Integration
   * Zendesk Integration
 * Connect to a database
 * Connect to an API
   * API Authentication
   * Custom API authentication
   * SSH tunneling
 * Troubleshoot connections
   * Creating a Google OAuth 2.0 client
 * Connecting to analytics vendors


BUILD YOUR APPS

 * App editor
   * Custom keyboard shortcuts
   * App documentation
 * Assemble components
   * Present data in tables
   * Build charts and graphs
   * Display images
   * Containers
   * Forms
   * Navigation
   * Create custom list views
   * Define option lists
   * Upgrading deprecated components
   * Retool Markdown and HTML reference
   * Develop custom components
 * Reading and writing data
   * Making API requests
   * Reading from SQL
   * Writing to SQL
   * Query anything with SQL
   * Adding a new record to your database or API
   * Reusing queries
   * Caching in Retool
   * Reference
   * Create tables using the Data Editor
   * SQL Cheatsheet
 * Event Handlers
 * Writing JavaScript
   * Transformers
   * Scripting Retool
   * Temporary state
   * Dynamic JSON
   * Upload multiple files through a GCS / S3 resource
   * Reference
   * Debugging JavaScript
   * Preloaded JavaScript and Libraries
   * Modules
 * Design and usability
 * Query Library
 * URL query parameters
 * Component Library
   * Alert
   * Annotated Text
   * Avatar
   * Avatar Group
   * Auth Login
   * Button
   * Button Group
   * Bounding Box
   * Calendar
   * Cascader
   * Chart
   * Checkbox
   * Checkbox Group
   * Checkbox Tree
   * Circular Image
   * Collapsible Container
   * Comment
   * Container
   * Currency
   * Custom Component
   * Date
   * Date Time
   * Date Range
   * Data
   * Divider
   * Dropdown Button
   * Editable Number
   * Editable Text
   * Email
   * Feature Flags
   * File Button
   * File Dropzone
   * File Input
   * Form
   * Icon
   * IFrame
   * Image
   * JSON Editor
   * JSON Explorer
   * JSON Schema Form
   * Key Value
   * Link
   * Listbox
   * List View
   * Looker
   * Mapbox Map
   * Microphone
   * Modal
   * Month
   * Multiselect
   * Multiselect Listbox
   * Number Input
   * Outline Button
   * Pagination
   * Password
   * PDF
   * Percent
   * Progress Bar
   * Progress Circle
   * Query Builder
   * Radio Group
   * Range Slider
   * Rating
   * Rich Text Editor
   * S3 Uploader
   * Scanner
   * Segmented Control
   * Select
   * Signature Pad
   * Slider
   * Spacer
   * Split Button
   * Statistic
   * Steps
   * Stepped Container
   * Stripe Card Form
   * Switch
   * Switch Group
   * Tabbed Container
   * Tableau
   * Tags
   * Table
   * Text Area
   * Tabs
   * Time
   * Timeline
   * Timer
   * Text
   * Text Input
   * Toggle Button
   * Toggle Link
   * Video
   * Wizard
   * Year


MANAGE YOUR ORGANIZATION

 * Inviting users and authentication
 * Update billing information
 * Disabling users
 * Audit logs
 * SSO
   * SSO with OpenID providers
   * SCIM user provisioning
   * Sync Google Groups to Retool
 * Workspaces
 * User permissions
 * Security


DEPLOY ON-PREMISE

 * Self-hosted Retool
 * Monitor resource utilization
 * Updating self-hosted Retool
 * Self-hosted Retool release notes
 * Network and storage requirements
   * Retool's storage database
   * Connecting via HTTP proxy
   * Horizontally scale self-hosted Retool
 * Certificates and internal certificate authorities
 * Environment Variables
   * Manage secrets with environment variables
   * Manage secrets with the file system


DEVELOP AND SCALE

 * Deploy Retool at scale
   * Manage Retool deployments with a hub and spoke model
 * Environments
   * Using multiple environments
   * Multi-instance deployments
 * Source Control
   * Set up Source Control with GitHub
   * Set up Source Control with GitLab
   * Get started with Source Control
   * Recommended workflow for Source Control
   * Managing branches
   * Resolving conflicts
   * Migrating from Git Syncing
 * Source Control (Other)
   * Git Syncing
 * Release management
 * App performance best practices
 * Debug Tools
 * Manage Source Control deployments


BETA FEATURES

 * Retool Database
 * Retool Mobile
   * Retool Mobile Quickstart
   * Retool Mobile screens
   * Retool Mobile components
   * Retool Mobile app design and layout
   * Retool Mobile app deployment
   * Retool Mobile component library
   * Build an inventory management app on Retool Mobile
   * Build a field sales app on Retool Mobile
   * Build a site inspection app on Retool Mobile
 * Testing


LEGAL

 * Privacy policy


RETOOL DOCS

Learn how to build internal tools with rich user interfaces, powered by your
data.


> 🎉
> 
> BETA
> 
> Build native apps and ship them to iOS and Android using Retool. Learn more →

Retool enables you to quickly build and deploy internal apps for your team.
Connect to your databases and APIs, assemble UIs with drag-and-drop building
blocks like tables and forms, and write queries to interact with data using SQL
and JavaScript.



--------------------------------------------------------------------------------


GET STARTED

Watch a 4-minute demo or follow our Quickstart guide to build your first app in
just a few minutes.

Quickstart →

 * Tutorials
   Learn to build Retool apps for different use cases.
 * App editor
   Build, deploy, and run apps with Retool's web-based development environment.

--------------------------------------------------------------------------------


CONNECT YOUR DATA SOURCES

Integrate data sources like PostgreSQL, APIs, Salesforce, and more.

Resources →

 * Integrations
   Quickly connect to data sources using our built-in integrations.
 * Connect to databases
   Connect to most databases and data stores.
 * Connect to APIs
   Connect to REST, GraphQL, and SOAP APIs.

--------------------------------------------------------------------------------


BUILD YOUR APPS

Assemble highly polished interfaces with our extensive library of UI components,
write queries to interact with data, and use JavaScript almost anywhere.

Assemble components →

 * Design and usability
   Personalize apps with custom styles and formatting.
 * Write queries
   Write SQL, API, and JavaScript queries to update data.
 * Run JavaScript
   Use JavaScript almost anywhere to set values, control behavior, and
   manipulate data.
 * Event handlers
   Trigger queries, control components, and more in response to user actions.

--------------------------------------------------------------------------------


MANAGE YOUR ORGANIZATION

Onboard users, control access, and configure sign-in options.

Invite users →

 * User permissions
   Control access to your apps and resources.
 * SSO
   Enable users to sign in with services you already use.

--------------------------------------------------------------------------------


DEPLOY ON-PREMISE

Self-host Retool on your own infrastructure, behind your own VPN, in your own
VPC.

Self-hosted Retool →

 * Update your deployment
   Keep your Retool deployment up-to-date and upgrade to newer versions.
 * Deploy at scale
   Effectively scale your Retool deployment as your organization grows.

--------------------------------------------------------------------------------


ADDITIONAL RESOURCES

Explore beyond our documentation to learn more about Retool.

 * Component library
   Explore our library of UI components and try out live examples.
 * What's new
   Find out about the latest updates, features, and improvements at Retool.
 * Community
   Learn how to do anything in Retool or get help from our support team.
 * Templates
   Rapidly develop tools with our ready-made templates.
 * Pricing
   Compare our free and paid plans and features to find the right one for your
   organization.
 * Retool for Startups
   Eligible early-stage startups can use Retool for free for a year.

Updated 14 days ago

--------------------------------------------------------------------------------

What’s Next
 * Quickstart

Did this page help you?
Yes
No
 * Table of Contents
 * * Connect your data sources
   * Build your apps
   * Manage your organization
   * Deploy on-premise
   * Additional resources