Delete User with Zoom API on Category Overspent from You Need a Budget API

Pipedream makes it easy to connect APIs for Zoom, You Need a Budget and 1,600+ other apps remarkably fast.

Trigger workflow on

Category Overspent from the You Need a Budget API

Next, do this

Delete User with the Zoom API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the Category Overspent trigger
1. Connect your You Need a Budget account
2. Configure timer
3. Select a Budget ID
4. Select a Category ID
Configure the Delete User action
1. Connect your Zoom account
2. Configure user_id
3. Optional- Select a action
4. Optional- Configure transfer_email
5. Optional- Configure transfer_meeting
6. Optional- Configure transfer_webinar
7. Optional- Configure transfer_recording
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#

Category Overspent on You Need a Budget

Description:Emit new event when a category budget is overspent

Version:0.0.3

Key:you_need_a_budget-category-overspent

View on GitHub

You Need a Budget Overview#

The You Need a Budget (YNAB) API provides APIs to interact with YNAB users’
budgets, transactions, and more. With the YNAB API, developers have the ability
to build applications that are tailored to an individual's budget and financial
lifestyle.

Whether you're looking to create an app to assist with budgeting and tracking
expenses, generating reports, or getting a real-time view of an individual's
budget and movements, the YNAB API provides the tools to do it. The YNAB API is
easy to use, secure, and versatile.

Here are some examples of how you can use the YNAB API:

Build an application to track expenses and generate reports
Monitor the balances of multiple budgets
Generate a budget snapshot based on accounts
Create custom visualizations and analytics tools
Create notifications when specific budget values change
Automate budgeting tasks, such as transfers and payments between accounts
Create interactive dashboards and track real-time trends
Enforce budgeting rules, such as threshold limits or budget goal tracking

Trigger Code#

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

export default {
  ...common,
  key: "you_need_a_budget-category-overspent",
  // eslint-disable-next-line pipedream/source-name
  name: "Category Overspent",
  description: "Emit new event when a category budget is overspent",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    categoryId: {
      propDefinition: [
        common.props.app,
        "categoryId",
        (c) => ({
          budgetId: c.budgetId,
        }),
      ],
    },
  },
  methods: {
    ...common.methods,
    generateMeta(balance, amount) {
      return {
        id: balance,
        summary: `Balance (${balance}) for ${this.getThisMonth()} dropped below ${amount}`,
      };
    },
  },
  async run() {
    const { category } = await this.app.getCategoryBudget({
      budgetId: this.budgetId,
      categoryId: this.categoryId.value,
    });

    const balance = this.app.convertFromMilliunit(category.balance);
    const budgeted = this.app.convertFromMilliunit(category.budgeted);

    if (balance < budgeted) {
      const meta = this.generateMeta(balance, budgeted);
      this.$emit(category, meta);
    }
  },
};

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
You Need a Budget	`app`	`app`	This component uses the You Need a Budget app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Budget ID	`budgetId`	`string`	Select a value from the drop down menu.
Category ID	`categoryId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

About You Need a Budget#

Money doesn’t have to be messy. The YNAB budgeting app and its simple four-rule method will help you organize your finances, demolish your debt, save piles of cash, and reach your financial goals faster.

Action#

Delete User on Zoom

Description:Disassociates (unlinks) a user from the associated account or permanently deletes a user.

Version:0.2.1

Key:zoom-delete-user

View on GitHub

Zoom Overview#

Connecting Zoom to any app using Pipedream

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).

Getting Started

First, sign up for Pipedream at https://pipedream.com.
Visit https://pipedream.com/accounts.
Click the button labeled Click Here to Connect an App.
Search for "Zoom" and select either Zoom or Zoom Admin (see the differences below):

This will open up a new window prompting you to authorize Pipedream's access to your Zoom account. Once you authorize access, you should see your Zoom account listed among your apps.

Create a new workflow, add a new step, search for "Zoom" or "Zoom Admin". Once you've selected either app, you can choose to either "Run Node.js code" or select one of the prebuilt actions for performing common API operations.
At this stage, you'll be asked to link the Zoom account you connected above, authorizing the request to the Zoom API with your credentials:

Zoom vs Zoom Admin app

Zoom users can be classified into two groups: non-admins and admins. Admins have account-level permissions that users do not, and Zoom has corresponding admin-level scopes that aren't relevant for normal users. Therefore, Pipedream exposes two apps — Zoom and Zoom Admin — to serve the two groups.

In the Zoom Marketplace, these apps are named Pipedream, and Pipedream for Zoom Admins, respectively.

Non-admins have permissions to manage standard Zoom resources in their account: meetings, webinars, recordings, and more. If you're a non-admin, you'll want to use the Zoom app.

Zoom admins have permissions to manage account-level resources, like users and reports. They can also manage webinars and meetings across their organization. If you're an admin and need to manage these resources via API, you'll want to use the Zoom Admin app.

The Zoom API docs on permissions provide detailed information on these permissions and their associated OAuth scopes.

Action Code#

// legacy_hash_id: a_a4iKYo
import { axios } from "@pipedream/platform";

export default {
  key: "zoom-delete-user",
  name: "Delete User",
  description: "Disassociates (unlinks) a user from the associated account or permanently deletes a user.",
  version: "0.2.1",
  type: "action",
  props: {
    zoom: {
      type: "app",
      app: "zoom",
    },
    user_id: {
      type: "string",
      description: "The user ID or email address of the user.",
    },
    action: {
      type: "string",
      description: "Delete action options:<br>`disassociate` - Disassociate a user.<br>`delete`-  Permanently delete a user.<br>Note: To delete pending user in the account, use `disassociate",
      optional: true,
      options: [
        "disassociate",
        "delete",
      ],
    },
    transfer_email: {
      type: "string",
      description: "Transfer email.",
      optional: true,
    },
    transfer_meeting: {
      type: "boolean",
      description: "Transfer meeting.",
      optional: true,
    },
    transfer_webinar: {
      type: "boolean",
      description: "Transfer webinar.",
      optional: true,
    },
    transfer_recording: {
      type: "boolean",
      description: "Transfer recording.",
      optional: true,
    },
  },
  async run({ $ }) {
  //See the API docs here: https://marketplace.zoom.us/docs/api-reference/zoom-api/users/userdelete
    const config = {
      method: "delete",
      url: `https://api.zoom.us/v2/users/${this.user_id}`,
      params: {
        action: this.action,
        transfer_email: this.transfer_email,
        transfer_meeting: this.transfer_meeting,
        transfer_webinar: this.transfer_webinar,
        transfer_recording: this.transfer_recording,
      },
      headers: {
        "Authorization": `Bearer ${this.zoom.$auth.oauth_access_token}`,
        "Content-Type": "application/json",
      },
    };
    return await axios($, config);
  },
};

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
Zoom	`zoom`	`app`	This component uses the Zoom app.
user_id	`user_id`	`string`	The user ID or email address of the user.
action	`action`	`string`	Select a value from the drop down menu:`disassociatedelete`
transfer_email	`transfer_email`	`string`	Transfer email.
transfer_meeting	`transfer_meeting`	`boolean`	Transfer meeting.
transfer_webinar	`transfer_webinar`	`boolean`	Transfer webinar.
transfer_recording	`transfer_recording`	`boolean`	Transfer recording.

Action 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.