Convex

Convex is an open-source reactive backend platform that combines a document database, serverless functions, and real-time sync in one developer-friendly package. Instead of writing SQL, you define queries, mutations, and actions in TypeScript that run right next to your data, and every client subscribed to a query updates automatically when the underlying data changes.

Why Convex?

• Functions as the API: Queries (reads), mutations (transactional writes), and actions (side effects like calling external APIs) are the building blocks of your backend — typed, versioned, and deployed together.
• Reactive by default: Query results update live as data changes, with no cache invalidation or polling logic to maintain.
• Transactional writes: Mutations run as ACID transactions with serializable isolation, so your data stays consistent without manual locking.
• Built-in schema awareness: Convex tracks the shape of every table, so tooling can introspect your data model without a separate migration system.

Using Convex in Sim

Sim's Convex integration connects your workflows to any Convex deployment with two fields: the deployment URL and a deploy key from the dashboard Settings page. From there you can:

• Run functions: Call query, mutation, and action functions with named JSON arguments — or use Run Function when you don't want to specify the function type.
• Inspect your data model: List Tables returns every table in the deployment with the JSON schema of its documents.
• Export and sync data: List Documents pages through a consistent snapshot of a table, and Document Deltas returns only the documents that changed since a snapshot — including deletions — making incremental syncs to warehouses, search indexes, or other tools straightforward.

The Run Query, Run Mutation, Run Action, and Run Function operations work on every Convex plan. List Tables, List Documents, and Document Deltas use Convex's streaming export API, which is available on Convex paid plans.

Typical patterns include agents that read and write application data through your existing Convex functions, scheduled exports to analytics destinations, and change-driven automations that react to new or updated documents.

Usage Instructions

Integrate Convex into the workflow. Run query, mutation, and action functions on your deployment, list tables with their schemas, and export documents with snapshot pagination and change deltas.

Actions

convex_query

Run a Convex query function and return its result

Input

Output

convex_mutation

Run a Convex mutation function to write data and return its result

Input

Output

convex_action

Run a Convex action function and return its result

Input

Output

convex_run_function

Run any Convex function (query, mutation, or action) by path without specifying its type

Input

Output

convex_list_tables

List all tables in a Convex deployment along with their JSON schemas. Requires streaming export, available on Convex paid plans.

Input

Output

convex_list_documents

List documents from a Convex table via a paginated snapshot. Pass the returned snapshot and page cursor back in to fetch the next page. Requires streaming export, available on Convex paid plans.

Input

Output

convex_document_deltas

List documents that changed after a snapshot or previous delta cursor. Deleted documents are returned with a _deleted flag. Requires streaming export, available on Convex paid plans.

Input

Output