Skip to main content
MySQL logo



Connect Superblocks to MySQL to build apps with read and write access to a MySQL database:

  • Read data from a database and utilize it in API steps or UI components

Read data from MySQL and use it within an Application

  • Save information retrieved by other API steps or UI components by writing data to a database

Write data into MySQL using SQL in a backend API

Setting up MySQL

1. Add integration

Select MySQL from the integrations page.

2. Configure settings

Fill out the form with the following settings:

NameTRUEName that will be displayed to users when selecting this integration in Superblocks
HostTRUEHostname or IP address to connect to
PortTRUEPort to use when connecting to MySQL
Database NameTRUEName of database to connect to
Database UsernameTRUEUsername to use to connect
Database PasswordTRUEPassword for database username
Enable SSLFALSEConnect using SSL
Use a self-signed SSL certificateFALSEProvide Server CA, Client Key, and Client Cert
Use SSH TunnelFALSE Connect via an SSH tunnel. See configuration details here.

3. Test and save

Click Test Connection to check that Superblocks can connect to the data source.


If using Superblocks Cloud, add these Superblocks IPs to your allowlist (not necessary for On-Premise-Agent).

After connecting successfully, click Create to save the integration.

4. Set profiles

Optionally, configure different profiles for separate development environments.


MySQL connected Now you can use MySQL in any Application, Workflow, or Scheduled Job.

Creating MySQL steps

Connect to your MySQL integration from Superblocks by creating steps in Application APIs, Workflows, and Scheduled Jobs. You can configure a Superblocks MySQL integration with read only, read/write, or write only users. You can then configure a Superblocks MySQL step to read from a database, as well as modify/delete data. To get started, enter your SQL query into the text area of the MySQL step. Then click "Run" to see the Result and Executed SQL statement below.

See the results of a MySQL query

See the executed SQL of a MySQL query


Use cases


Create an admin dashboard that reads from MySQL and other sources. Mix in APIs to allow support agents to refund orders, update shipping statuses, or transform large datasets in a single UI.

Admin dashboard reads from MySQL allowing for order refunds


Enrich customer order data within MySQL with shipping data from Snowflake or other datastores.

Use a workflow to enrich MySQL data with data from other datastores like Snowflake

Scheduled Jobs

Send out a daily report via email of new customer bookings.


Note that javascript may be injected via {{ }}. Here we use javascript's moment package to easily manipulate the timestamp to the start and end of the previous day.

Use a scheduled job to query MySQL and send out a daily report


Check out our guide on common errors across database integrations, in addition to common MySQL connection issues. If you are encountering an error that you don't see in the guide, or the provided steps are insufficient to resolve the error, please contact us at