Google Docs

Create and edit documents in Google Docs.

ProductivityOAuth6 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (6)
append_text
create_document
create_document_based_on_template
custom_api_call
google-docs-find-document
read_document
Details

Connect

Auth type: OAuth (oauth2). Click Connect and approve access on the provider's page. Appbricx runs the OAuth flow (signed single-use state, PKCE where the provider supports it), stores the tokens encrypted and refreshes them before they expire.

Scopes requested: https://www.googleapis.com/auth/documents

OAuth needs an OAuth app: the platform's when the operator configured one, or your own (admin panel, Integrations, Configure). You can also bring your own credentials.

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("google_docs", "append_text", {
    "text": "<text to append>",
    "documentId": "<document id>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Google Docs answered", { output: res.output });
}

defineWorkflow module

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

export default defineWorkflow({
  id: "google-docs-append-text",
  name: "Google Docs: Append text to google docs",
  description: "Calls Google Docs when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("google_docs", {
      "action": "append_text",
      "text": "<text to append>",
      "documentId": "<document id>"
    }) 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/google_docs/append_text" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"text":"<text to append>","documentId":"<document id>"}}'

Actions

append_textin catalog

Append text to google docs. Appends text to google docs

Input	Type	Description
`text`required	long text	The text to append to the document
`documentId`required	text	The ID of the document to append text to

create_documentin catalog

Create Document. Create a document on Google Docs

Input	Type	Description
`title`required	text	Document Title
`body`required	long text	Document Content

create_document_based_on_template

Edit template file. Edit a template file and replace the values with the ones provided

Input	Type	Description
`template`required	text	The ID of the file to replace the values
`values`required	object	Dont include the placeholder format "[[]]" or "{{}}", only the key name and its value
`images`required	object	Key: Image ID (get it manually from the Read File Action), Value: Image URL
`placeholder_format`required	one of "curly_braces" \| "square_brackets" \| "single_curly" \| "single_square"	Choose the format of placeholders in your template

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

google-docs-find-document

Find Document. Search for document by name.

Input	Type	Description
`name`required	text	Document Name
`folderId`optional	id (picked from your account)	Folder
`createIfNotFound`optional	boolean	Create a new document if not found?
`newDocumentProps`optional	object (depends on other props)	New Document Properties

read_document

Read Document. Read a document from Google Docs

Input	Type	Description
`documentId`required	text	The ID of the document to read

Details

Id: google_docs
Category: Productivity
Tags: google, documents, writing, docs
Package: @activepieces/piece-google-docs@0.4.1
Tier: Built in