Create Plan with Shift4 API on New Custom Webhook Events from Stripe API

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

Trigger workflow on

New Custom Webhook Events from the Stripe API

Next, do this

Create Plan 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 Stripe 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 New Custom Webhook Events trigger
1. Connect your Stripe account
2. Select one or more Events
Configure the Create Plan action
1. Connect your Shift4 account
2. Configure Amount
3. Configure Currency
4. Select a Interval
5. Configure Name
6. Optional- Configure Interval Count
7. Optional- Configure Billing Cycles
8. Optional- Configure Trial Period Days
9. Optional- Select a Recurs To
10. 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#

New Custom Webhook Events on Stripe

Description:Emit new event on each webhook event

Version:0.1.1

Key:stripe-custom-webhook-events

View on GitHub

Stripe Overview#

The Stripe API is a powerful tool for managing online payments, subscriptions, and invoices. With Pipedream, you can leverage this API to automate payment processing, monitor transactions, and sync billing data with other services. Pipedream's no-code platform allows for quick integration and creation of serverless workflows that react to Stripe events in real-time. For instance, you might automatically update customer records, send personalized emails after successful payments, or escalate failed transactions to your support team.

Trigger Code#

import constants from "../common/constants.mjs";
import sampleEmit from "./test-event.mjs";
import common from "../common/webhook-base.mjs";

export default {
  ...common,
  key: "stripe-custom-webhook-events",
  name: "New Custom Webhook Events",
  type: "source",
  version: "0.1.1",
  description: "Emit new event on each webhook event",
  props: {
    ...common.props,
    enabledEvents: {
      type: "string[]",
      label: "Events",
      description: "Events to listen for. Select `*` for all events",
      options: constants.WEBHOOK_EVENTS,
      default: [
        "*",
      ],
    },
  },
  methods: {
    ...common.methods,
    getEvents() {
      return this.enabledEvents;
    },
  },
  sampleEmit,
};

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
Stripe	`stripe`	`app`	This component uses the Stripe app.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Events	`enabledEvents`	`string[]`	Select a value from the drop down menu:`*account.application.authorizedaccount.application.deauthorizedaccount.external_account.createdaccount.external_account.deletedaccount.external_account.updatedaccount.updatedapplication_fee.createdapplication_fee.refund.updatedapplication_fee.refundedbalance.availablecapability.updatedcharge.capturedcharge.dispute.closedcharge.dispute.createdcharge.dispute.funds_reinstatedcharge.dispute.funds_withdrawncharge.dispute.updatedcharge.expiredcharge.failedcharge.pendingcharge.refund.updatedcharge.refundedcharge.succeededcharge.updatedcheckout.session.async_payment_failedcheckout.session.async_payment_succeededcheckout.session.completedcoupon.createdcoupon.deletedcoupon.updatedcredit_note.createdcredit_note.updatedcredit_note.voidedcustomer.createdcustomer.deletedcustomer.discount.createdcustomer.discount.deletedcustomer.discount.updatedcustomer.source.createdcustomer.source.deletedcustomer.source.expiringcustomer.source.updatedcustomer.subscription.createdcustomer.subscription.deletedcustomer.subscription.pending_update_appliedcustomer.subscription.pending_update_expiredcustomer.subscription.trial_will_endcustomer.subscription.updatedcustomer.tax_id.createdcustomer.tax_id.deletedcustomer.tax_id.updatedcustomer.updatedfile.createdinvoice.createdinvoice.deletedinvoice.finalizedinvoice.marked_uncollectibleinvoice.paidinvoice.payment_action_requiredinvoice.payment_failedinvoice.payment_succeededinvoice.sentinvoice.upcominginvoice.updatedinvoice.voidedinvoiceitem.createdinvoiceitem.deletedinvoiceitem.updatedissuing_authorization.createdissuing_authorization.requestissuing_authorization.updatedissuing_card.createdissuing_card.updatedissuing_cardholder.createdissuing_cardholder.updatedissuing_dispute.createdissuing_dispute.funds_reinstatedissuing_dispute.updatedissuing_transaction.createdissuing_transaction.updatedmandate.updatedorder.createdorder.payment_failedorder.payment_succeededorder.updatedorder_return.createdpayment_intent.amount_capturable_updatedpayment_intent.canceledpayment_intent.createdpayment_intent.payment_failedpayment_intent.processingpayment_intent.succeededpayment_method.attachedpayment_method.card_automatically_updatedpayment_method.detachedpayment_method.updatedpayout.canceledpayout.createdpayout.failedpayout.paidpayout.updatedperson.createdperson.deletedperson.updatedplan.createdplan.deletedplan.updatedprice.createdprice.deletedprice.updatedproduct.createdproduct.deletedproduct.updatedradar.early_fraud_warning.createdradar.early_fraud_warning.updatedrecipient.createdrecipient.deletedrecipient.updatedreporting.report_run.failedreporting.report_run.succeededreporting.report_type.updatedreview.closedreview.openedsetup_intent.canceledsetup_intent.createdsetup_intent.setup_failedsetup_intent.succeededsigma.scheduled_query_run.createdsku.createdsku.deletedsku.updatedsource.canceledsource.chargeablesource.failedsource.mandate_notificationsource.refund_attributes_requiredsource.transaction.createdsource.transaction.updatedsubscription_schedule.abortedsubscription_schedule.canceledsubscription_schedule.completedsubscription_schedule.createdsubscription_schedule.expiringsubscription_schedule.releasedsubscription_schedule.updatedtax_rate.createdtax_rate.updatedtopup.canceledtopup.createdtopup.failedtopup.reversedtopup.succeededtransfer.createdtransfer.failedtransfer.paidtransfer.reversedtransfer.updated`

Trigger Authentication#

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

Stripe uses API keys to authenticate requests (more info in their docs here).

To connect Pipedream to your Stripe account,

Create a Stripe API key
Click "Create Restricted Key"
Enter the Restricted API key below.

To help ensure proper security, we recommend you create a Restricted key with scopes relevant to the specific operations you will use in Pipedream.

About Stripe#

Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.

Action#

Create Plan on Shift4

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

Version:0.0.1

Key:shift4-create-plan

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-plan",
  name: "Create Plan",
  description: "Creates a new plan object. [See the documentation](https://dev.shift4.com/docs/api#plan-create)",
  version: "0.0.1",
  type: "action",
  props: {
    shift4,
    amount: {
      propDefinition: [
        shift4,
        "amount",
      ],
      description: "Subscription charge amount in minor units of a given currency. For example, 10€ is represented as \"1000\", and 10¥ is represented as \"10\".",
    },
    currency: {
      propDefinition: [
        shift4,
        "currency",
      ],
      description: "Subscription charge currency represented as a three-letter ISO currency code.",
    },
    interval: {
      type: "string",
      label: "Interval",
      description: "The interval at which a plan is set to recur. Could be 'day', 'week', 'month', or 'year'.",
      options: [
        "day",
        "week",
        "month",
        "year",
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "The name of the plan.",
    },
    intervalCount: {
      type: "integer",
      label: "Interval Count",
      description: "The number of intervals between each subscription billing. For example, if `interval`=`month` and `intervalCount`=`3`, subscriptions created with this plan will be billed every 3 months.",
      optional: true,
    },
    billingCycles: {
      type: "integer",
      label: "Billing Cycles",
      description: "The number of billing cycles for the payment period. If left blank, the subscription will continue indefinitely.",
      optional: true,
    },
    trialPeriodDays: {
      type: "integer",
      label: "Trial Period Days",
      description: "The number of trial period days granted when subscribing a customer to this plan.",
      optional: true,
    },
    recursTo: {
      propDefinition: [
        shift4,
        "recursTo",
      ],
      optional: true,
    },
    metadata: {
      propDefinition: [
        shift4,
        "metadata",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      shift4,
      metadata,
      ...data
    } = this;

    const response = await shift4.createPlan({
      $,
      data: {
        ...data,
        metadata: metadata && parseObject(metadata),
      },
    });

    $.export("$summary", `Successfully created plan 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.
Amount	`amount`	`integer`	Subscription charge amount in minor units of a given currency. For example, 10€ is represented as "1000", and 10¥ is represented as "10".
Currency	`currency`	`string`	Subscription charge currency represented as a three-letter ISO currency code.
Interval	`interval`	`string`	Select a value from the drop down menu:`dayweekmonthyear`
Name	`name`	`string`	The name of the plan.
Interval Count	`intervalCount`	`integer`	The number of intervals between each subscription billing. For example, if `interval`=`month` and `intervalCount`=`3`, subscriptions created with this plan will be billed every 3 months.
Billing Cycles	`billingCycles`	`integer`	The number of billing cycles for the payment period. If left blank, the subscription will continue indefinitely.
Trial Period Days	`trialPeriodDays`	`integer`	The number of trial period days granted when subscribing a customer to this plan.
Recurs To	`recursTo`	`string`	Select a value from the drop down menu.
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,

Navigate to your Shift4 account and sign in
Click the dropdown on the top right
Go to “Account Settings” > “API keys”

About Shift4#

We’re changing the way the world experiences commerce.

More Ways to Connect Shift4 + Stripe#

Other Popular Integrations#

Create Charge with Shift4 API on New Abandoned Cart from Stripe API

Stripe + Shift4

Create Plan with Shift4 API on New Custom Webhook Events from Stripe API

Pipedream makes it easy to connect APIs for Shift4, Stripe 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