Skip to main content
The Firestore node adds Firestore operations to your workflows. Add it on the canvas or ask the AI builder for it by name, then pick an operation and fill in its fields. Firestore also includes 1 trigger operation (marked in the tables below) that can start a workflow when something happens in Firestore.
You can wire the Firestore node into an AI agent as a tool provider: the agent calls the operations you allow. See Agent tools.

Credentials

Connect Firestore under Credentials in the node settings. See Connecting credentials for the general flow.

OAuth

Sign in with your Firestore account when prompted; no keys to copy. Get your credentials here. NoClick requests the following permissions:
  • https://www.googleapis.com/auth/datastore

Service account

Enter the values manually when creating the credential. Get your credentials here.

Firebase id token

Enter the values manually when creating the credential. Get your credentials here.

Operations

Advanced

OperationIDDescriptionTrigger
Custom API Callcustom_api_callRaw Firestore REST call escape hatch for newly added or niche endpoints.
Listen StreamlistenOpen a Firestore listen stream request.
Write StreamwriteOpen a Firestore write stream request.

Backups

OperationIDDescriptionTrigger
Create Backup Schedulecreate_backup_scheduleCreate a backup schedule for a Firestore database.
Delete Backupdelete_backupDelete a Firestore backup.
Delete Backup Scheduledelete_backup_scheduleDelete a backup schedule.
Get Backupget_backupGet one Firestore backup.
Get Backup Scheduleget_backup_scheduleGet one backup schedule.
List Backup Scheduleslist_backup_schedulesList backup schedules for a Firestore database.
List Backupslist_backupsList Firestore backups in a location.
Update Backup Scheduleupdate_backup_scheduleUpdate a backup schedule.

Batch

OperationIDDescriptionTrigger
Batch Get Documentsbatch_get_documentsRetrieve multiple documents by full name in a single call.
Batch Writebatch_writeApply a set of writes in one (non-atomic, best-effort) call.

Databases

OperationIDDescriptionTrigger
Bulk Delete Documentsbulk_delete_documentsBulk delete collection groups in the background.
Clone Databaseclone_databaseClone an existing Firestore database from PITR.
Create Databasecreate_databaseCreate a Firestore database.
Delete Databasedelete_databaseDelete a Firestore database.
Export Documentsexport_documentsExport documents to Cloud Storage.
Get Databaseget_databaseGet metadata/config for a database.
Import Documentsimport_documentsImport documents from Cloud Storage.
List Databaseslist_databasesList databases in the project.
Restore Databaserestore_databaseRestore a Firestore database from a backup.
Update Databaseupdate_databasePatch database metadata/configuration.

Documents

OperationIDDescriptionTrigger
Create Documentcreate_documentCreate a new document in a collection.
Delete Documentdelete_documentDelete a document.
Get Documentget_documentFetch a single document by its collection and document id.
List Documentslist_documentsList documents in a collection.
Update / Upsert Documentupdate_documentUpdate (patch / upsert) fields on a document.

Indexes

OperationIDDescriptionTrigger
Delete Indexdelete_indexDelete a composite index.
Get Fieldget_fieldGet one field configuration.
Get Indexget_indexGet a composite index definition.
List Fieldslist_fieldsList field index / TTL configurations.
List Indexeslist_indexesList composite indexes for a collection group.
Update Fieldupdate_fieldPatch a field configuration.

Locations

OperationIDDescriptionTrigger
Get Locationget_locationGet one Firestore-supported location.
List Locationslist_locationsList Firestore-supported locations.

Operations

OperationIDDescriptionTrigger
Cancel Operationcancel_operationRequest cancellation for a long-running operation.
Delete Operationdelete_operationDelete interest in a long-running operation result.
Get Operationget_operationPoll the status of a long-running operation (export/import/index build).
List Operationslist_operationsList long-running operations.

Queries

OperationIDDescriptionTrigger
Execute Pipelineexecute_pipelineExecute a Firestore pipeline query.
List Collection IDslist_collection_idsList collection IDs under the database root or a document.
Partition Querypartition_queryPartition a structured query for parallel execution.
Run Aggregation Queryrun_aggregation_queryRun a COUNT / SUM / AVG aggregation over a query.
Run Queryrun_queryRun a structured query over a collection.

Transactions

OperationIDDescriptionTrigger
Begin Transactionbegin_transactionStart a read/write transaction; returns a transaction token.
CommitcommitAtomically commit a set of writes (optionally within a transaction).
RollbackrollbackAbort an in-progress transaction.

Triggers

OperationIDDescriptionTrigger
On Document Created/Updatedon_document_changedTrigger: poll a collection for documents created/updated since the last check.Yes

User creds

OperationIDDescriptionTrigger
Create User Credscreate_user_credsCreate a database user creds resource.
Delete User Credsdelete_user_credsDelete a user creds resource.
Disable User Credsdisable_user_credsDisable a user creds resource.
Enable User Credsenable_user_credsEnable a user creds resource.
Get User Credsget_user_credsGet a database user creds resource.
List User Credslist_user_credsList user creds for a database.
Reset User Creds Passwordreset_user_creds_passwordReset the password of a user creds resource.