Create Plan with Shift4 API on New Events (Instant) from Twilio SendGrid API

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

Trigger workflow on

New Events (Instant) from the Twilio SendGrid 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 Twilio SendGrid 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 Events (Instant) trigger
1. Connect your Twilio SendGrid account
2. Select one or more Event Types
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 Events (Instant) on Twilio SendGrid

Description:Emit new event when any of the specified SendGrid events is received

Version:0.0.6

Key:sendgrid-events

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Trigger Code#

import common from "../common/http-based.mjs";
import deliveryEventTypes from "./delivery-event-types.mjs";
import engagementEventTypes from "./engagement-event-types.mjs";

export default {
  ...common,
  key: "sendgrid-events",
  name: "New Events (Instant)",
  description: "Emit new event when any of the specified SendGrid events is received",
  version: "0.0.6",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    eventTypes: {
      type: "string[]",
      label: "Event Types",
      description: "The type of events to listen to",
      options(context) {
        const { page } = context;
        if (page !== 0) {
          return {
            options: [],
          };
        }

        const options = [
          ...deliveryEventTypes,
          ...engagementEventTypes,
        ];
        return {
          options,
        };
      },
    },
  },
  methods: {
    ...common.methods,
    baseWebhookSettings() {
      // The list of events that a webhook can listen to. This method returns an
      // exhaustive list of all such flags disabled, and each event source can
      // then override the flags that are relevant to the event they handle.
      //
      // See the docs for more information:
      // https://sendgrid.com/docs/api-reference/
      const eventTypesData = [
        ...deliveryEventTypes,
        ...engagementEventTypes,
      ];
      return eventTypesData.reduce((accum, eventTypeData) => ({
        ...accum,
        [eventTypeData.value]: false,
      }), {});
    },
    webhookEventFlags() {
      return this.eventTypes.reduce((accum, eventType) => ({
        ...accum,
        [eventType]: true,
      }), {});
    },
    generateMeta(data) {
      const {
        event: eventType,
        sg_event_id: id,
        timestamp: ts,
      } = data;
      const summary = `New event: ${eventType}`;
      return {
        id,
        summary,
        ts,
      };
    },
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid 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.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

About Twilio SendGrid#

Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.

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”

Create Plan with Shift4 API on New Events (Instant) from Twilio SendGrid API

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