Create User Invite with Ramp API on Monthly Schedule from Schedule API

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

Trigger workflow on

Monthly Schedule from the Schedule API

Next, do this

Create User Invite with the Ramp 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 Schedule trigger and Ramp action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Monthly Schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create User Invite action
1. Connect your Ramp account
2. Configure Email
3. Configure First Name
4. Configure Last Name
5. Select a Role
6. Optional- Select a Department ID
7. Optional- Select a Direct Manager ID
8. Optional- Select a Location ID
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#

Monthly Schedule on Schedule

Description:Trigger your workflow on one or more days each month at a specific time (with timezone support).

Version:0.0.2

Key:schedule-monthly

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

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

export default {
  name: "Monthly Schedule",
  version: "0.0.2",
  key: "schedule-monthly",
  type: "source",
  description: "Trigger your workflow on one or more days each month at a specific time (with timezone support).",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 10 1 * *",
      },
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create User Invite on Ramp

Description:Sends out an invite for a new user. [See the documentation](https://docs.ramp.com/developer-api/v1/reference/rest/users#post-developer-v1-users-deferred)

Version:0.0.2

Key:ramp-create-user-invite

View on GitHub

Ramp Overview#

The Ramp API provides programmatic access to financial and accounting functionalities, allowing for the management of company cards, transactions, and reporting. By leveraging the Ramp API within Pipedream, you can automate intricate finance operations, synchronize transaction data with accounting software, trigger notifications based on spending activities, and analyze financial data in real-time, integrating with other services for enhanced financial workflows.

Action Code#

import ramp from "../../ramp.app.mjs";
import { v4 as uuidv4 } from "uuid";

export default {
  key: "ramp-create-user-invite",
  name: "Create User Invite",
  description: "Sends out an invite for a new user. [See the documentation](https://docs.ramp.com/developer-api/v1/reference/rest/users#post-developer-v1-users-deferred)",
  version: "0.0.2",
  type: "action",
  props: {
    ramp,
    email: {
      type: "string",
      label: "Email",
      description: "The employee's email address",
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name of the employee",
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name of the employee",
    },
    role: {
      propDefinition: [
        ramp,
        "role",
      ],
    },
    departmentId: {
      propDefinition: [
        ramp,
        "departmentId",
      ],
    },
    directManagerId: {
      propDefinition: [
        ramp,
        "userId",
      ],
      label: "Direct Manager ID",
      description: "Unique identifier of the employee's direct manager",
      optional: true,
    },
    locationId: {
      propDefinition: [
        ramp,
        "locationId",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.ramp.createUserInvite({
      $,
      data: {
        email: this.email,
        first_name: this.firstName,
        last_name: this.lastName,
        role: this.role,
        department_id: this.departmentId,
        direct_manager_id: this.directManagerId,
        location_id: this.locationId,
        idempotency_key: uuidv4(),
      },
    });
    $.export("$summary", `Invite sent successfully to new user ${this.firstName} ${this.lastName}`);
    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
Ramp	`ramp`	`app`	This component uses the Ramp app.
Email	`email`	`string`	The employee's email address
First Name	`firstName`	`string`	First name of the employee
Last Name	`lastName`	`string`	Last name of the employee
Role	`role`	`string`	Select a value from the drop down menu:`AUDITORBUSINESS_ADMINBUSINESS_BOOKKEEPERBUSINESS_OWNERBUSINESS_USERDEVELOPER_ADMINGUEST_USERIT_ADMINVENDOR_NETWORK_ADMIN`
Department ID	`departmentId`	`string`	Select a value from the drop down menu.
Direct Manager ID	`directManagerId`	`string`	Select a value from the drop down menu.
Location ID	`locationId`	`string`	Select a value from the drop down menu.

Action Authentication#

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

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

transactions:readcards:readcards:writespend_programs:readspend_programs:writeusers:readusers:writelocations:readlocations:writelimits:readlimits:writedepartments:readdepartments:writebusiness:readreceipts:readtransfers:readvendors:readmerchants:readaccounting:readreceipts:write