Listen Document
firestore.listen_document
ActionDatabases & warehousesconnection required
Calls firestore v1 POST /v1/projects/{projectsId}/databases/{databasesId}/documents:listen.
Listens to changes.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Google Firestore
- Secret shape
- {"client_id", "client_secret", "refresh_token"}
- Config it needs
- project_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
database Database name or id. | string | Yes | — | — | — |
body The ListenRequest resource, as the API defines it. | object | Yes | — | — | — |
Output
One shape.
result
Extra keys beyond the ones listed can appear.
| Field | Type | Example |
|---|---|---|
documentChange | object | — |
documentDelete | object | — |
documentRemove | object | — |
filter | object | — |
targetChange | object | — |
{
"documentChange": {},
"documentDelete": {},
"documentRemove": {},
"filter": {},
"targetChange": {}
}See Listen Document run in a workflow.
In a technical demo we add the Google Firestore connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.