MongoDB

Find, insert, update, and delete documents in MongoDB collections.

Data and storageAPI key7 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (7)
find_documents
update_documents
aggregate_documents
delete_documents
find_and_replace_documents
find_and_update_documents
insert_documents
Details

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.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("mongodb", "find_documents", {
    "collection": "<collection>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("MongoDB answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "mongodb-find-documents",
  name: "MongoDB: Find Documents",
  description: "Calls MongoDB when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("mongodb", {
      "action": "find_documents",
      "collection": "<collection>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/mongodb/find_documents" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"collection":"<collection>"}}'

Actions

find_documentsin catalog

Find Documents. Find documents in a collection

Input	Type	Description
`database`optional	text	The MongoDB database to connect to (from your authentication)
`collection`required	id (picked from your account)	Collection
`query`optional	JSON	MongoDB query to filter documents (e.g., {"status": "active"})
`projection`optional	JSON	Fields to include or exclude (e.g., {"name": 1, "_id": 0})
`sort`optional	JSON	Sort criteria (e.g., {"createdAt": -1})
`limit`optional	number	Maximum number of documents to return
`skip`optional	number	Number of documents to skip

update_documentsin catalog

Update Documents. Update multiple documents in a collection

Input	Type	Description
`database`optional	text	The MongoDB database to connect to (from your authentication)
`collection`required	id (picked from your account)	Collection
`filter`required	JSON	MongoDB query to select documents to update (e.g., {"status": "pending"})
`update`required	JSON	MongoDB update operations (e.g., {"$set": {"status": "completed"}})
`upsert`optional	boolean	Insert a document if no documents match the filter

aggregate_documents

Aggregate Documents. Perform aggregation operations on documents in a collection

Input	Type	Description
`database`optional	text	The MongoDB database to connect to (from your authentication)
`collection`required	id (picked from your account)	Collection
`pipeline`required	JSON	Array of aggregation stages (e.g., [{"$match": {"status": "active"}}, {"$group": {"_id": "$category", "count": {"$sum": 1}}}])

delete_documents

Delete Documents. Delete documents from a collection

Input	Type	Description
`database`optional	text	The MongoDB database to connect to (from your authentication)
`collection`required	id (picked from your account)	Collection
`filter`required	JSON	MongoDB query to select documents to delete (e.g., {"status": "archived"})

find_and_replace_documents

Find and Replace Documents. Replace documents that match a filter with a new document

Input	Type	Description
`database`optional	text	The MongoDB database to connect to (from your authentication)
`collection`required	id (picked from your account)	Collection
`filter`required	JSON	MongoDB query to select documents to replace (e.g., {"_id": "123"})
`replacement`required	JSON	New document that will replace the matched documents
`upsert`optional	boolean	Insert the document if no documents match the filter
`returnDocument`optional	one of "before" \| "after"	Which version of the document to return

find_and_update_documents

Find and Update Documents. Find documents and update them, returning the updated documents

Input	Type	Description
`database`optional	text	The MongoDB database to connect to (from your authentication)
`collection`required	id (picked from your account)	Collection
`filter`required	JSON	MongoDB query to select documents to update (e.g., {"status": "pending"})
`update`required	JSON	MongoDB update operations (e.g., {"$set": {"status": "completed"}})
`upsert`optional	boolean	Insert a document if no documents match the filter
`returnUpdated`optional	boolean	Return the documents after updates are applied

insert_documents

Insert Documents. Insert one or more documents into a collection

Input	Type	Description
`database`optional	text	The MongoDB database to connect to (from your authentication)
`collection`required	id (picked from your account)	Collection
`documents`required	JSON	Document(s) to insert. Can be a single document object or an array of documents.

Details

Id: mongodb
Category: Data and storage
Tags: database, nosql, document, json
Package: @activepieces/piece-mongodb@0.1.3
Tier: Built in