Skip to content
Documentation
Contact
← Back to documentation
Technical Reference

SurrealDB

Multi Model Database

CategoryDeveloper Tools
Authenticationcustom
Version0.1.6
Published scopes0 published scopes
Last updatedSeptember 24, 2026

Overview

Connect SurrealDB with Flows360

Multi Model Database

Use the SurrealDB connector to include its declared actions and events in Flows360 workflows without duplicating the integration logic inside each consuming system. This pinned connector version currently exposes 1 action and 1 trigger.

Available actions

  • Run Query

Available triggers

  • New Row

The capability list above is generated from the exact reviewed connector package so the public description stays aligned with the version Flows360 operates.

Technical guide

Technical reference

Package identity

  • Connector: SurrealDB
  • Package: @activepieces/piece-surrealdb@0.1.6
  • Exact artifact digest: sha256:27be1e3c3505a7275e2db7aaccc734bc92674e86432fc1509e28958fdba8ffbb
  • Runtime: Activepieces-compatible deterministic worker
  • Source: the exact reviewed Activepieces source

Authentication

CUSTOM AUTH. Connection values are tenant-specific and remain in the consuming Studio instance; CDK stores definitions and field metadata, not customer credential values.

Action contracts

  • Run Query (run-query), Run a query in SurrealDB. Classification: read.

Trigger contracts

  • New Row, polling.

Verification

Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Capability summary

Authenticationcustom
Supported objects2
Supported actions1
Triggers1

Authentication

Authentication method: custom

Authentication profiles

connection · custom
  • Connection URL Required
  • Database Required
  • Namespace Required
  • Username Required
  • Password Required · protected credential

Supported objects

ObjectReadWriteNotes
Run Query Yes No Run a query in SurrealDB.
New Row Yes No polling trigger declared by the pinned package.

Supported actions

Run Query · Read

Run a query in SurrealDB.

run_query · Risk: low · Retry: safe

Inputs

  • markdown · string · Optional, n **NOTE:** Prevent SQL injection by using parameterized queries.n
  • query · string · Required, Provide a SurrealDB query string to execute.
  • queryMarkdown · string · Optional, n **NOTE:** Query example: `SELECT * FROM table_name WHERE name = $name`. Then add the name parameter in the arguments.n
  • args · object · Optional, Add all arguments as names here, don't add the $ sign.
  • query_timeout · number · Optional, The maximum time to wait for a query to complete before timing out.
  • application_name · string · Optional, An identifier for the client application executing the query.

Triggers

New Row · Poll

Triggers when a new row is added to the defined table.

Inputs

  • description · string
  • table · string
  • order_by · string
  • order_direction · string

Setup

Setup

  1. Add the SurrealDB connector to the workflow in the target Flows360 Studio instance.
  2. Create or select the tenant-specific connection required by the connector. Connection secrets remain in the Studio connection boundary and are not copied into CDK documentation.
  3. Provide the connection fields declared by the pinned package:
  • Connection URL (url), required.
  • Database (database), required.
  • Namespace (namespace), required.
  • Username (username), required.
  • Password (password), required; stored as a sensitive connection value.
  1. Select the required action or trigger and complete its declared input fields. Required and optional inputs are defined by the exact package schema.
  2. Test the workflow in the appropriate environment before enabling production scheduling or event delivery.

Limitations

Limitations and operational notes

  • This content describes @activepieces/piece-surrealdb@0.1.6; provider behaviour can change independently and should be revalidated when the provider or connector version changes.
  • Only the 1 action and 1 trigger declared by this pinned package are represented here.
  • Tenant credentials and connection values are not stored in the public connector record.
  • Provider-side permissions, account entitlements, quotas and rate limits remain subject to the connected provider account and are not inferred when the package does not declare them.
  • Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Troubleshooting

Why canu2019t the connector authenticate?

Check the tenant connection in Studio and confirm every required SurrealDB connection field is present. Re-authorise OAuth-based connections if the provider token or consent has expired. Do not place credential values in CDK content or logs.

Why is an action or trigger unavailable?

Confirm that the workflow is using @activepieces/piece-surrealdb@0.1.6 and compare the requested capability with the declared action and trigger list for this version. A capability that is not declared by the pinned package should not be presented as supported.

What should I check after a provider-side change?

Revalidate authentication, required fields, action/trigger behaviour and provider documentation before publishing refreshed connector content or moving a new package version into production.

github.com