Create Customer with Shift4 API on Weekly schedule from Schedule API

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

Trigger workflow on

Weekly schedule from the Schedule API

Next, do this

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

Select this integration
Configure the Weekly schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Customer action
1. Connect your Shift4 account
2. Configure Email
3. Optional- Configure Description
4. Optional- Configure Card
5. Optional- Configure Metadata
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#

Weekly schedule on Schedule

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

Version:0.0.1

Key:schedule-weekly

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: "Weekly schedule",
  version: "0.0.1",
  key: "schedule-weekly",
  type: "source",
  description: "Trigger your workflow on one or more days each week 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 Customer on Shift4

Description:Creates a new customer object. [See the documentation](https://dev.shift4.com/docs/api#customers-create-a-customer)

Version:0.0.1

Key:shift4-create-customer

View on GitHub

Shift4 Overview#

The Shift4 API provides robust payment processing capabilities, enabling secure transactions for various business needs. On Pipedream, you can leverage this API to create automated workflows that respond to events, handle payments, and sync transaction data with other services. By integrating Shift4 with Pipedream, you unlock a realm of possibilities for automating payment operations, analyzing sales data, and improving customer experiences with real-time actions.

Action Code#

import { parseObject } from "../../common/utils.mjs";
import shift4 from "../../shift4.app.mjs";

export default {
  key: "shift4-create-customer",
  name: "Create Customer",
  description: "Creates a new customer object. [See the documentation](https://dev.shift4.com/docs/api#customers-create-a-customer)",
  version: "0.0.1",
  type: "action",
  props: {
    shift4,
    email: {
      type: "string",
      label: "Email",
      description: "The email address of the customer.",
    },
    description: {
      type: "string",
      label: "Description",
      description: "A description for the customer.",
      optional: true,
    },
    card: {
      propDefinition: [
        shift4,
        "card",
      ],
      optional: true,
    },
    metadata: {
      propDefinition: [
        shift4,
        "metadata",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.shift4.createCustomer({
      $,
      data: {
        email: this.email,
        description: this.description,
        card: this.card && parseObject(this.card),
        metadata: this.metadata && parseObject(this.metadata),
      },
    });

    $.export("$summary", `Successfully created customer 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
Shift4	`shift4`	`app`	This component uses the Shift4 app.
Email	`email`	`string`	The email address of the customer.
Description	`description`	`string`	A description for the customer.
Card	`card`	`string`	Card token, card details or card identifier.
Metadata	`metadata`	`object`	Metadata object.

Action Authentication#

Shift4 uses API keys for authentication. When you connect your Shift4 account, Pipedream securely stores the keys so you can easily authenticate to Shift4 APIs in both code and no-code steps.

To retrieve your API keys,