NocoDB
Create, list, and update records in NocoDB databases.
On this page
Connect
Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.
- In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
- For every project in a workspace: Workspace settings, Integrations.
- Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.
Call it from a workflow
Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.
// .workflow.js (native ctx)
export async function run(ctx) {
const res = await ctx.integrations.invoke("nocodb", "nocodb-create-record", {
"baseId": "<baseId>",
"tableId": "<tableId>",
"tableColumns": {}
});
if (!res.success) throw new Error(res.error);
ctx.log.info("NocoDB answered", { output: res.output });
}// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";
export default defineWorkflow({
id: "nocodb-nocodb-create-record",
name: "NocoDB: Create a Record",
description: "Calls NocoDB when a row is created.",
trigger: { type: "entity_event", entity: "tickets", event: "created" },
async run(ctx, event) {
const res = await ctx.integrations.call("nocodb", {
"action": "nocodb-create-record",
"baseId": "<baseId>",
"tableId": "<tableId>",
"tableColumns": {}
}) as { success: boolean; error?: string };
if (!res.success) throw new Error(res.error);
},
});curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/nocodb/nocodb-create-record" \
-H "Authorization: Bearer $APP_KEY" \
-H "content-type: application/json" \
-d '{"props":{"baseId":"<baseId>","tableId":"<tableId>","tableColumns":{}}}'Actions
nocodb-create-recordin catalog
Create a Record. Creates a new record in the given table.
Also accepted as create_record.
| Input | Type | Description |
|---|---|---|
workspaceIdoptional | id (picked from your account) | For self-hosted instances,select "No Workspace". |
baseIdrequired | id (picked from your account) | Base ID |
tableIdrequired | id (picked from your account) | Table ID |
tableColumnsrequired | object (depends on other props) | Table Columns |
nocodb-update-recordin catalog
Update a Record. Updates an existing record with the given Record ID.
Also accepted as update_record.
| Input | Type | Description |
|---|---|---|
workspaceIdoptional | id (picked from your account) | For self-hosted instances,select "No Workspace". |
baseIdrequired | id (picked from your account) | Base ID |
tableIdrequired | id (picked from your account) | Table ID |
recordIdrequired | number | Record ID |
tableColumnsrequired | object (depends on other props) | Table Columns |
nocodb-delete-record
Delete a Record. Deletes a record with the given Record ID.
| Input | Type | Description |
|---|---|---|
workspaceIdoptional | id (picked from your account) | For self-hosted instances,select "No Workspace". |
baseIdrequired | id (picked from your account) | Base ID |
tableIdrequired | id (picked from your account) | Table ID |
recordIdrequired | number | Record ID |
nocodb-get-record
Get a Record. Gets a record by the Record ID.
| Input | Type | Description |
|---|---|---|
workspaceIdoptional | id (picked from your account) | For self-hosted instances,select "No Workspace". |
baseIdrequired | id (picked from your account) | Base ID |
tableIdrequired | id (picked from your account) | Table ID |
recordIdrequired | number | Record ID |
nocodb-search-records
Search Records. Returns a list of records matching the where condition.
| Input | Type | Description |
|---|---|---|
workspaceIdoptional | id (picked from your account) | For self-hosted instances,select "No Workspace". |
baseIdrequired | id (picked from your account) | Base ID |
tableIdrequired | id (picked from your account) | Table ID |
columnIdoptional | ids (picked from your account) | Allows you to specify the fields that you wish to include in your API response. By default, all the fields are included in the response. |
whereConditionoptional | long text | Enables you to define specific conditions for filtering records.See docs [here](https://docs.nocodb.com/0.109.7/developer-resources/rest-apis/#comparison-operators). |
limitrequired | number | Enables you to set a limit on the number of records you want to retrieve. |
sortoptional | long text | Comma separated field names without space.Example: **field1,-field2** will sort the records first by 'field1' in ascending order and then by 'field2' in descending order. |
Details
- Id
nocodb- Category
- Productivity
- Tags
- database, open-source, nocode, airtable-alternative
- Package
@activepieces/piece-nocodb@0.4.4- Tier
- Community