Create Charge with Shift4 API on New Ticket Added to View (Instant) from Zendesk API

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

Trigger workflow on

New Ticket Added to View (Instant) from the Zendesk API

Next, do this

Create Charge with the Shift4 API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Zendesk 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 Ticket Added to View (Instant) trigger
1. Connect your Zendesk account
2. Select a Trigger Category ID
3. Optional- Configure Custom Subdomain
4. Optional- Select one or more Fields
5. Optional- Configure JSON Body
6. Select a View ID
Configure the Create Charge action
1. Connect your Shift4 account
2. Optional- Select a Customer ID
3. Configure Amount
4. Configure Currency
5. Optional- Select a Type
6. Optional- Configure Description
7. Optional- Configure Card
8. Optional- Configure Payment Method
9. Optional- Configure Flow
10. Optional- Configure Captured
11. Optional- Configure Shipping
12. Optional- Configure Billing
13. Optional- Configure 3D Secure
14. 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 Ticket Added to View (Instant) on Zendesk

Description:Emit new event when a ticket is added to the specified view

Version:0.0.2

Key:zendesk-ticket-added-to-view

View on GitHub

Zendesk Overview#

The Zendesk API enables seamless integration of Zendesk's customer service platform with your existing business processes and third-party applications. By leveraging this API with Pipedream, you can automate ticket tracking, sync customer data, escalate issues, and streamline communication across multiple channels. This can significantly increase efficiency, accelerate response times, and enhance the overall customer experience. Automations can range from simple notifications to complex workflows involving data transformation and multi-step actions across various services.

Trigger Code#

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

export default {
  ...common,
  key: "zendesk-ticket-added-to-view",
  name: "New Ticket Added to View (Instant)",
  description: "Emit new event when a ticket is added to the specified view",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    viewId: {
      propDefinition: [
        common.props.app,
        "viewId",
      ],
    },
  },
  methods: {
    ...common.methods,
    getWebhookName() {
      return "Ticket Added To View Webhook";
    },
    getTriggerTitle() {
      return "Ticket Added To View Trigger";
    },
    getTriggerConditions() {
      return {
        any: [
          {
            field: "update_type",
            value: "Change",
          },
          {
            field: "update_type",
            value: "Create",
          },
        ],
      };
    },
    async isRelevant(payload) {
      const { tickets } = await this.app.listTicketsInView({
        viewId: this.viewId,
      });
      const foundTicket = tickets.find(({ id }) => id == payload.ticketId);
      return foundTicket;
    },
  },
};

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
Zendesk	`app`	`app`	This component uses the Zendesk app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Trigger Category ID	`categoryId`	`string`	Select a value from the drop down menu.
Custom Subdomain	`customSubdomain`	`string`	For Enterprise Zendesk accounts: optionally specify the subdomain to use. This will override the subdomain that was provided when connecting your Zendesk account to Pipedream. For example, if you Zendesk URL is https://examplehelp.zendesk.com, your subdomain is `examplehelp`
Fields	`fields`	`string[]`	Select a value from the drop down menu.
JSON Body	`jsonBody`	`string`	Custom JSON Body of the incoming payload. Setting `jsonBody` will overwrite the `fields` prop
View ID	`viewId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

triggers:writewebhooks:writereadtickets:writetickets:readusers:writeorganizations:readorganizations:write

About Zendesk#

Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.

Action#

Create Charge on Shift4

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

Version:0.0.1

Key:shift4-create-charge

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 { ConfigurationError } from "@pipedream/platform";
import { TYPE_OPTIONS } from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import shift4 from "../../shift4.app.mjs";

export default {
  key: "shift4-create-charge",
  name: "Create Charge",
  description: "Creates a new charge object. [See the documentation](https://dev.shift4.com/docs/api#charges-create-a-new-charge)",
  version: "0.0.1",
  type: "action",
  props: {
    shift4,
    customerId: {
      propDefinition: [
        shift4,
        "customerId",
      ],
      optional: true,
    },
    amount: {
      propDefinition: [
        shift4,
        "amount",
      ],
    },
    currency: {
      propDefinition: [
        shift4,
        "currency",
      ],
    },
    type: {
      type: "string",
      label: "Type",
      description: "The type of the charge.",
      options: TYPE_OPTIONS,
      optional: true,
    },
    description: {
      propDefinition: [
        shift4,
        "description",
      ],
      optional: true,
    },
    card: {
      propDefinition: [
        shift4,
        "card",
      ],
      optional: true,
    },
    paymentMethod: {
      type: "string",
      label: "Payment Method",
      description: "Payment method details or identifier.",
      optional: true,
    },
    flow: {
      type: "object",
      label: "Flow",
      description: "Details specific to the payment method charge.",
      optional: true,
    },
    captured: {
      type: "boolean",
      label: "Captured",
      description: "Whether this charge should be immediately captured.",
      optional: true,
    },
    shipping: {
      type: "object",
      label: "Shipping",
      description: "Shipping details. Sample object: `{name: \"string\", address: {line1: \"string\", line2: \"string\", zip: \"string\", city: \"string\", state: \"string\", country: \"country represented as two-letter ISO country code\"}}`",
      optional: true,
    },
    billing: {
      type: "object",
      label: "Billing",
      description: "Billing details. Sample object: `{name: \"string\", email: \"string\", address: {line1: \"string\", line2: \"string\", zip: \"string\", city: \"string\", state: \"string\", country: \"country represented as two-letter ISO country code\"}, vat: \"string\"}`",
      optional: true,
    },
    threeDSecure: {
      type: "object",
      label: "3D Secure",
      description: "3D Secure options.",
      optional: true,
    },
    metadata: {
      propDefinition: [
        shift4,
        "metadata",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.customerId && !this.card && !this.paymentMethod) {
      throw new ConfigurationError("Either **CustomerId**, **Card** or **PaymentMethod** is required!");
    }

    try {
      const response = await this.shift4.createCharge({
        $,
        data: {
          amount: this.amount,
          currency: this.currency,
          type: this.type,
          description: this.description,
          customerId: this.customerId,
          card: this.card && parseObject(this.card),
          paymentMethod: this.paymentMethod && parseObject(this.paymentMethod),
          flow: this.flow && parseObject(this.flow),
          captured: this.captured,
          shipping: this.shipping && parseObject(this.shipping),
          billing: this.billing && parseObject(this.billing),
          threeDSecure: this.threeDSecure && parseObject(this.threeDSecure),
          metadata: this.metadata && parseObject(this.metadata),
        },
      });

      $.export("$summary", `Successfully created charge with Id: ${response.id}`);
      return response;
    } catch ({ message }) {
      throw new ConfigurationError(JSON.parse(message).error.message);
    }
  },
};

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.
Customer ID	`customerId`	`string`	Select a value from the drop down menu.
Amount	`amount`	`integer`	The charge amount in minor units of a given currency. For example, 10€ is represented as '1000'.
Currency	`currency`	`string`	The charge currency represented as a three-letter ISO currency code.
Type	`type`	`string`	Select a value from the drop down menu:`{ "label": "First Recurring", "value": "first_recurring" }{ "label": "Subsequent Recurring", "value": "subsequent_recurring" }{ "label": "Merchant Initiated", "value": "merchant_initiated" }{ "label": "Customer Initiated", "value": "customer_initiated" }`
Description	`description`	`string`	A description for the charge.
Card	`card`	`string`	Card token, card details or card identifier.
Payment Method	`paymentMethod`	`string`	Payment method details or identifier.
Flow	`flow`	`object`	Details specific to the payment method charge.
Captured	`captured`	`boolean`	Whether this charge should be immediately captured.
Shipping	`shipping`	`object`	Shipping details. Sample object: `{name: "string", address: {line1: "string", line2: "string", zip: "string", city: "string", state: "string", country: "country represented as two-letter ISO country code"}}`
Billing	`billing`	`object`	Billing details. Sample object: `{name: "string", email: "string", address: {line1: "string", line2: "string", zip: "string", city: "string", state: "string", country: "country represented as two-letter ISO country code"}, vat: "string"}`
3D Secure	`threeDSecure`	`object`	3D Secure options.
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 Charge with Shift4 API on New Ticket Added to View (Instant) from Zendesk API

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

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

Developers ♥ Pipedream

1-24of2,000+apps by most popular

1
-
24
of
2,000+
apps by most popular