Google Contacts

Create, list, and search contacts in Google Contacts.

ProductivityOAuth4 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (4)
add_contact
search_contact
update_contact
custom_api_call
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/contacts

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_contacts", "add_contact", {
    "firstName": "<first name>",
    "lastName": "<last name>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Google Contacts answered", { output: res.output });
}

defineWorkflow module

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

export default defineWorkflow({
  id: "google-contacts-add-contact",
  name: "Google Contacts: Add Contact",
  description: "Calls Google Contacts when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("google_contacts", {
      "action": "add_contact",
      "firstName": "<first name>",
      "lastName": "<last name>"
    }) 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_contacts/add_contact" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"firstName":"<first name>","lastName":"<last name>"}}'

Actions

add_contactin catalog

Add Contact. Add a contact to a Google Contacts account

Input	Type	Description
`firstName`required	text	The first name of the contact
`middleName`optional	text	The middle name of the contact
`lastName`required	text	The last name of the contact
`jobTitle`optional	text	The job title of the contact
`company`optional	text	The company of the contact
`email`optional	text	The email address of the contact
`phoneNumber`optional	text	The phone number of the contact

search_contactin catalog

Search Contacts. Search contacts in Google Contacts account.

Input	Type	Description
`query`required	text	The plain-text query for the request.The query is used to match prefix phrases of the fields on a person. For example, a person with name "foo name" matches queries such as "f", "fo", "foo", "foo n",…
`readMask`required	list of	A field mask to restrict which fields on each person are returned.
`pageSize`optional	number	The number of results to return. Maximum 30.

update_contactin catalog

Update Contact. Update a contact in Google Contacts account.

Input	Type	Description
`resourceName`required	text	The resource name for the person, assigned by the server. An ASCII string in the form of people/{person_id}.
`etag`required	text	The `etag` ensures contact updates only apply if the contact hasn't changed since last retrieved.
`updatePersonFields`required	list of	A field mask to restrict which fields on the person are updated.
`firstName`optional	text	The first name of the contact
`middleName`optional	text	The middle name of the contact
`lastName`optional	text	The last name of the contact
`jobTitle`optional	text	The job title of the contact
`company`optional	text	The company of the contact
`email`optional	text	The email address of the contact
`phoneNumber`optional	text	The phone number of the contact

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

Details

Id: google_contacts
Category: Productivity
Tags: google, contacts, address-book, people
Package: @activepieces/piece-google-contacts@0.4.4
Tier: Built in