List Members with Google Chat API

Pipedream makes it easy to connect APIs for Google Chat and 2,800+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

List Members with the Google Chat API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to List Members with the Google Chat API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the List Members action
1. Connect your Google Chat account
2. Select a Space ID
3. Optional- Configure Page Size
4. Optional- Configure Page Token
5. Optional- Configure Filter
6. Optional- Configure Show Invited
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

List Members with Google Chat API on New Requests from HTTP / Webhook API

HTTP / Webhook + Google Chat

Try it

List Members with Google Chat API on New Submission from Typeform API

Typeform + Google Chat

Try it

List Members with Google Chat API on New Submission (Instant) from Jotform API

Jotform + Google Chat

Try it

List Members with Google Chat API on New Custom Webhook Events from Stripe API

Stripe + Google Chat

Try it

List Members with Google Chat API on New Scheduled Tasks from Pipedream API

Pipedream + Google Chat

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

List Members on Google Chat

Description:Lists memberships in a space. [See the documentation](https://developers.google.com/chat/api/reference/rest/v1/spaces.members/list)

Version:0.0.2

Key:google_chat-list-members

View on GitHub

Code#

import app from "../../google_chat.app.mjs";

export default {
  key: "google_chat-list-members",
  name: "List Members",
  description: "Lists memberships in a space. [See the documentation](https://developers.google.com/chat/api/reference/rest/v1/spaces.members/list)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    app,
    spaceId: {
      propDefinition: [
        app,
        "spaceId",
      ],
    },
    pageSize: {
      type: "integer",
      label: "Page Size",
      description: "The maximum number of memberships to return. If unspecified, at most 100 memberships are returned.",
      optional: true,
    },
    pageToken: {
      type: "string",
      label: "Page Token",
      description: "A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page.",
      optional: true,
    },
    filter: {
      type: "string",
      label: "Filter",
      description: "Specify a query filter by role and type. [See the documentation](https://developers.google.com/chat/api/reference/rest/v1/spaces.members/list#query-parameters)",
      optional: true,
    },
    showInvited: {
      type: "boolean",
      label: "Show Invited",
      description: "When true, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.app.listMembers({
      $,
      spaceId: this.spaceId,
      params: {
        showInvited: this.showInvited,
        filter: this.filter,
        pageSize: this.pageSize,
        pageToken: this.pageToken,
      },
    });
    $.export("$summary", `Successfully fetched ${response.memberships.length} memberships`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Google Chat	`app`	`app`	This component uses the Google Chat app.
Space ID	`spaceId`	`string`	Select a value from the drop down menu.
Page Size	`pageSize`	`integer`	The maximum number of memberships to return. If unspecified, at most 100 memberships are returned.
Page Token	`pageToken`	`string`	A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page.
Filter	`filter`	`string`	Specify a query filter by role and type. See the documentation
Show Invited	`showInvited`	`boolean`	When true, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned.

Authentication#

Google Chat uses OAuth authentication. When you connect your Google Chat account, Pipedream will open a popup window where you can sign into Google Chat and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Chat API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofilehttps://www.googleapis.com/auth/chat.membershipshttps://www.googleapis.com/auth/chat.memberships.apphttps://www.googleapis.com/auth/chat.messageshttps://www.googleapis.com/auth/chat.messages.reactionshttps://www.googleapis.com/auth/chat.spaces