Convex
Convex is a reactive backend-as-a-service platform that combines a document database, server functions, and real-time data sync for application developers. The Convex Management (Platform) API lets you programmatically provision and administer the platform itself—teams, projects, deployments, deploy keys, access tokens, members, custom domains, and audit logs. Nexla connects to this REST API so you can read platform state into your data flows or drive administrative changes from a Nexset.
Power end-to-end data operations for your Convex API with Nexla. Our bi-directional Convex connector is purpose-built for Convex, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Convex or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Convex workflows fast, secure, and fully governed.
Features
Type: API
- Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
- Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
- API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
- Request optimization with intelligent batching, retry, and caching to minimize API calls and costs
Prerequisites
Before creating a Convex credential, you need a Convex account with access to the Convex dashboard and an access token for the Management API. The Management API is served from the base URL https://api.convex.dev/v1/ and authenticates every request with a Bearer token in the Authorization header. Convex supports two token types that Nexla can use:
- A Team Access Token, scoped to a single team, for managing that team's own projects and deployments.
- A Personal Access Token, tied to your user account.
To obtain a Team Access Token, follow these steps:
-
Sign in to the Convex dashboard with your Convex account.
-
Open Team Settings from the team switcher, then select the Access Tokens page.
-
Create a new access token and copy its value. Store it securely, as it may not be shown again after you navigate away.
-
From the same Team Settings area, note your Team ID or slug. Most Management API endpoints are scoped to a team and require this value when you configure a source or destination in Nexla.
A team access token can only perform the actions your account is permitted to take on the team, so any custom roles applied to your membership also constrain the token. Because a token is owned by the dashboard user who created it, Convex recommends generating it from a dedicated service-account team member rather than a personal login, so that deployments created through the API are not tied to an individual who might later leave the team. The Management API is currently in Beta; for the authoritative endpoint reference, see the Convex Management API documentation and the Platform APIs guide.
Authenticate
Credentials required
| Field | Required | Secret | Description |
|---|---|---|---|
| Access Token | Yes | Yes | Personal Access Token or Team Access Token generated from the Convex dashboard. |
Create a credential in Nexla
-
After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.
-
Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.
-
Enter your Convex Personal Access Token or Team Access Token in the Access Token field. Nexla sends this value as
Bearer <token>in theAuthorizationheader of every request to the Convex Management API. Treat the token as sensitive information and keep it confidential. -
Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.
Use as a data source
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Convex connector tile, then select the credential that will be used to connect to Convex, and click Next; or, create a new Convex credential for use in this flow.
Endpoint templates
Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Convex Management API endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu, and supply any required parameters (such as a Team ID or slug, Project ID, or Deployment Name). Available endpoint templates are listed in the expandable boxes below.
Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.
Manual configuration
Convex data sources can also be manually configured to ingest data from any valid Convex Management API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.
Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Convex data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.
Use as a destination
Click the + icon on the Nexset that will be sent to the Convex destination, and select the Send to Destination option from the menu. Select the Convex connector from the list of available destination connectors, then select the credential that will be used to connect to Convex, and click Next; or, create a new Convex credential for use in this flow.
Endpoint templates
Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Convex Management API endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu, and supply any required parameters (such as a Team ID or slug, Project ID, or Deployment Name). Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.
Manual configuration
Convex destinations can also be manually configured to send data to any valid Convex Management API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.
Several Convex destination endpoints perform irreversible administrative actions—for example, deleting projects, deployments, or access tokens. Verify that your Nexset records target the intended resources before activating a destination.
Save & activate
Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Convex endpoint, open the destination resource menu, and select Activate.
The Nexset data will not be sent to the Convex endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.