Create or Update User with Userflow API on Meeting Ended (Instant) from Zoom API

Pipedream makes it easy to connect APIs for Userflow, Zoom and 2,400+ other apps remarkably fast.

Trigger workflow on

Meeting Ended (Instant) from the Zoom API

Next, do this

Create or Update User with the Userflow 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#

This integration creates a workflow with a Zoom trigger and Userflow action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Meeting Ended (Instant) trigger
1. Connect your Zoom account
2. Configure apphook
Configure the Create or Update User action
1. Connect your Userflow account
2. Select a User ID
3. Optional- Configure Number Of Groups
4. Optional- Configure Number Of Memberships
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

Meeting Ended (Instant) on Zoom

Description:Emit new event each time a meeting ends where you're the host

Version:0.1.3

Key:zoom-meeting-ended

View on GitHub

Zoom Overview#

The Zoom API lets you tap into a rich set of functionalities to enhance the video conferencing experience within your own app or workflow. With the Zoom API on Pipedream, you can automatically create meetings, manage users, send meeting notifications, and more, orchestrating these actions within a broader automation. This allows for seamless integration with other services, enabling both data collection and action triggers based on Zoom events.

Pipedream workflows allow you to run any Node.js code that connects to the Zoom API. Just create a new workflow, then add prebuilt Zoom actions (create a meeting, send a chat message, etc.) or write your own code. These workflows can be triggered by HTTP requests, timers, email, or on any app-based event (new tweets, a Github PR, Zoom events, etc).

Trigger Code#

import common from "../common/common.mjs";
import constants from "../common/constants.mjs";

export default {
  ...common,
  key: "zoom-meeting-ended",
  name: "Meeting Ended (Instant)",
  description: "Emit new event each time a meeting ends where you're the host",
  version: "0.1.3",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    // eslint-disable-next-line pipedream/props-label, pipedream/props-description
    apphook: {
      type: "$.interface.apphook",
      appProp: "app",
      eventNames() {
        return [
          constants.CUSTOM_EVENT_TYPES.MEETING_ENDED,
        ];
      },
    },
  },
  hooks: {
    async deploy() {
      const { meetings } = await this.app.listMeetings({
        params: {
          page_size: 25,
          type: "previous_meetings",
        },
      });
      if (!meetings || meetings.length === 0) {
        return;
      }
      const detailedMeetings = [];
      for (const meeting of meetings) {
        try {
          const details = await this.app.getPastMeetingDetails({
            meetingId: meeting.id,
          });
          detailedMeetings.push(details);
        } catch {
          // catch error thrown by getPastMeetingDetails if meeting has not ended
          continue;
        }
      }
      const objects = this.sortByDate(detailedMeetings, "end_time");
      for (const object of objects) {
        this.emitEvent({
          object,
        }, object);
      }
    },
  },
  methods: {
    ...common.methods,
    emitEvent(payload, object) {
      const meta = this.generateMeta(object);
      this.$emit({
        event: constants.CUSTOM_EVENT_TYPES.MEETING_ENDED,
        payload,
      }, meta);
    },
    generateMeta(object) {
      return {
        id: object.uuid,
        summary: `Meeting ${object.topic} ended`,
        ts: +new Date(object.end_time),
      };
    },
  },
};

Trigger 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
Zoom	`app`	`app`	This component uses the Zoom app.
	`apphook`	`$.interface.apphook`

Trigger Authentication#

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

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

About Zoom#

Zoom is the leader in modern enterprise video communications, with an easy, reliable cloud platform for video and audio conferencing, chat, and webinars.

Action#

Create or Update User on Userflow

Description:Creates or updates a user in Userflow. If the user does not already exist in Userflow, it will be created. If it already exists, the given attributes will be merged into the existing user's attributes. [See the documentation](https://docs.userflow.com/api/users/create-or-update)

Version:0.0.1

Key:userflow-create-update-user

View on GitHub

Userflow Overview#

The Userflow API allows you to automate and integrate the process of creating and managing in-app guides and walkthroughs. Using the API within Pipedream, you can programmatically trigger events, update user attributes, and manage flows, thereby creating a personalized user experience within your application. This opens up possibilities for syncing user data, customizing user onboarding experiences, and tracking user progress without manual intervention.

Action Code#

import app from "../../userflow.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "userflow-create-update-user",
  name: "Create or Update User",
  description: "Creates or updates a user in Userflow. If the user does not already exist in Userflow, it will be created. If it already exists, the given attributes will be merged into the existing user's attributes. [See the documentation](https://docs.userflow.com/api/users/create-or-update)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    userId: {
      propDefinition: [
        app,
        "userId",
      ],
    },
    numberOfGroups: {
      type: "integer",
      label: "Number Of Groups",
      description: "The number of groups to create/update for the user.",
      reloadProps: true,
      optional: true,
    },
    numberOfMemberships: {
      type: "integer",
      label: "Number Of Memberships",
      description: "The number of memberships to create/update for the user.",
      reloadProps: true,
      optional: true,
    },
  },
  async additionalProps() {
    const {
      app,
      numberOfGroups = 0,
      numberOfMemberships = 0,
    } = this;
    let groups = [];

    const { data: userAttributes } = await app.listAttributeDefinitions({
      params: {
        scope: constants.SCOPE.USER,
        limit: 10,
      },
    });

    const { data: groupAttributes } = await app.listAttributeDefinitions({
      params: {
        scope: constants.SCOPE.GROUP,
        limit: 10,
      },
    });

    const { data: membershipAttributes } = await app.listAttributeDefinitions({
      params: {
        scope: constants.SCOPE.GROUP_MEMBERSHIP,
        limit: 10,
      },
    });

    if (numberOfGroups || numberOfMemberships) {
      ({ data: groups } = await app.listGroups({
        params: {
          limit: 100,
        },
      }));
    }

    const userAttributesProps = userAttributes.reduce((props, {
      name, display_name: label, data_type: dataType, description,
    }) => ({
      ...props,
      [`${constants.KEYATTR.USER}${name}`]: {
        type: constants.DATA_TYPE_TO_PROP_TYPE[dataType] || "string",
        label,
        description: description || label,
        optional: true,
      },
    }), {});

    const groupAttributesProps =
      Array.from({
        length: numberOfGroups || 0,
      }).reduce((props, _, index) => ({
        ...props,
        [`${constants.KEYATTR.GROUP}${index + 1}${constants.SEP}id`]: {
          type: "string",
          label: `Group ${index + 1} - ID`,
          description: "The unique identifier for the group.",
          optional: true,
          options: groups.map(({
            id: value, attributes: { name: label },
          }) => ({
            value,
            label: label || value,
          })),
        },
        ...Object.fromEntries(
          Object.entries(groupAttributes)
            .map(([
              ,
              {
                name,
                display_name: label,
                data_type: dataType,
                description,
              },
            ]) => [
              `${constants.KEYATTR.GROUP}${index + 1}${constants.SEP}${name}`,
              {
                type: constants.DATA_TYPE_TO_PROP_TYPE[dataType] || "string",
                label: `Group ${index + 1} - ${label}`,
                description: description || label,
                optional: true,
              },
            ]),
        ),
      }), {});

    const membershipAttributesProps =
      Array.from({
        length: numberOfMemberships || 0,
      }).reduce((props, _, index) => ({
        ...props,
        ...Object.fromEntries(
          Object.entries(membershipAttributes)
            .map(([
              ,
              {
                name,
                display_name: label,
                data_type: dataType,
                description,
              },
            ]) => [
              `${constants.KEYATTR.MEMBERSHIP}${index + 1}${constants.SEP}${name}`,
              {
                type: constants.DATA_TYPE_TO_PROP_TYPE[dataType] || "string",
                label: `Membership ${index + 1} - ${label}`,
                description: description || label,
                optional: true,
              },
            ]),
        ),
        [`${constants.KEYATTR.MEMBERSHIP}${index + 1}${constants.SEP}groupId`]: {
          type: "string",
          label: `Membership ${index + 1} - Group ID`,
          description: "The unique identifier for the group.",
          optional: true,
          options: groups.map(({
            id: value, attributes: { name: label },
          }) => ({
            value,
            label: label || value,
          })),
        },
        [`${constants.KEYATTR.MEMBERSHIP}${index + 1}${constants.SEP}groupAttributes`]: {
          type: "object",
          label: `Membership ${index + 1} - Group Attributes`,
          description: "A map of group attributes to set for the group.",
          optional: true,
        },
      }), {});

    return {
      ...userAttributesProps,
      ...groupAttributesProps,
      ...membershipAttributesProps,
    };
  },
  methods: {
    createUpdateUser(args = {}) {
      return this.app.post({
        path: "/users",
        ...args,
      });
    },
    getUserAttributes(data) {
      if (!data) {
        return;
      }
      return Object.fromEntries(
        Object.entries(data)
          .filter(([
            key,
          ]) => key.startsWith(constants.KEYATTR.USER))
          .map(([
            key,
            value,
          ]) => [
            key.replace(constants.KEYATTR.USER, ""),
            value,
          ]),
      );
    },
    getGroupAttributes(data, length = 0) {
      if (!data) {
        return;
      }
      const groups = Array.from({
        length,
      }).reduce((acc, _, index) => {
        const searchString = `${constants.KEYATTR.GROUP}${index + 1}${constants.SEP}`;
        const id = data[`${searchString}id`];
        const attributes = Object.fromEntries(
          Object.entries(data)
            .filter(([
              key,
            ]) => key.startsWith(searchString) && key !== `${searchString}id`)
            .map(([
              key,
              value,
            ]) => [
              key.replace(searchString, ""),
              value,
            ]),
        );
        const group = {
          id,
          attributes,
        };
        return [
          ...acc,
          group,
        ];
      }, []);

      if (!groups?.length) {
        return;
      }

      return groups;
    },
    getMembershipAttributes(data, length = 0) {
      if (!data) {
        return;
      }
      const memberships = Array.from({
        length,
      }).reduce((acc, _, index) => {
        const searchString = `${constants.KEYATTR.MEMBERSHIP}${index + 1}${constants.SEP}`;
        const groupId = data[`${searchString}groupId`];
        const groupAttributes = data[`${searchString}groupAttributes`];
        const attributes = Object.fromEntries(
          Object.entries(data)
            .filter(([
              key,
            ]) => key.startsWith(searchString) && key !== `${searchString}groupId` && key !== `${searchString}groupAttributes`)
            .map(([
              key,
              value,
            ]) => [
              key.replace(searchString, ""),
              value,
            ]),
        );
        const membership = {
          attributes,
          group: {
            id: groupId,
            attributes: groupAttributes,
          },
        };
        return [
          ...acc,
          membership,
        ];
      }, []);

      if (!memberships?.length) {
        return;
      }

      return memberships;
    },
  },
  async run({ $ }) {
    const {
      getUserAttributes,
      getGroupAttributes,
      getMembershipAttributes,
      numberOfGroups,
      numberOfMemberships,
      createUpdateUser,
      userId,
      ...data
    } = this;

    const response = await createUpdateUser({
      $,
      data: {
        id: userId,
        attributes: getUserAttributes(data),
        groups: getGroupAttributes(data, numberOfGroups),
        memberships: getMembershipAttributes(data, numberOfMemberships),
      },
    });

    $.export("$summary", `Successfully created or updated user with ID \`${response.id}\``);
    return response;
  },
};

Action Configuration#

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

Label	Prop	Type	Description
Userflow	`app`	`app`	This component uses the Userflow app.
User ID	`userId`	`string`	Select a value from the drop down menu.
Number Of Groups	`numberOfGroups`	`integer`	The number of groups to create/update for the user.
Number Of Memberships	`numberOfMemberships`	`integer`	The number of memberships to create/update for the user.

Create or Update User with Userflow API on Meeting Ended (Instant) from Zoom API

Pipedream makes it easy to connect APIs for Userflow, Zoom and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular