Create Order with PlentyONE API on New Ticket Comment Added (Instant) from Zendesk API

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

Trigger workflow on

New Ticket Comment Added (Instant) from the Zendesk API

Next, do this

Create Order with the PlentyONE 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 Zendesk trigger and PlentyONE 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 Comment Added (Instant) trigger
1. Connect your Zendesk account
2. Optional- Select a Trigger Category ID
3. Optional- Configure Custom Subdomain
Configure the Create Order action
1. Connect your PlentyONE account
2. Select a Order Type ID
3. Configure Plenty ID
4. Optional- Select a Status ID
5. Optional- Configure Owner ID
6. Optional- Select a Lock Status
7. Optional- Configure Order Items
8. Optional- Configure Properties
9. Optional- Configure Address Relations
10. Optional- Configure Relations
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 Comment Added (Instant) on Zendesk

Description:Emit new event when a ticket comment has been added

Version:0.1.0

Key:zendesk-new-ticket-comment-added

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 app from "../../zendesk.app.mjs";
import common from "../common/ticket.mjs";

export default {
  ...common,
  name: "New Ticket Comment Added (Instant)",
  key: "zendesk-new-ticket-comment-added",
  type: "source",
  description: "Emit new event when a ticket comment has been added",
  version: "0.1.0",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    http: "$.interface.http",
    categoryId: {
      propDefinition: [
        app,
        "categoryId",
      ],
    },
    customSubdomain: {
      propDefinition: [
        app,
        "customSubdomain",
      ],
    },
  },
  methods: {
    ...common.methods,
    _getLastTs() {
      return this.db.get("lastTs");
    },
    _setLastTs(ts) {
      this.db.set("lastTs", ts);
    },
    getWebhookName() {
      return "Ticket Comment Added Webhook";
    },
    getTriggerTitle() {
      return "Ticket Comment Added Trigger";
    },
    getTriggerConditions() {
      return {
        all: [
          {
            field: "update_type",
            value: "Change",
          },
        ],
      };
    },
    getTriggerPayload() {
      const payload = common.methods.getTriggerPayload.call(this);
      return {
        ...payload,
        ticketComments: "{{ticket.comments}}",
      };
    },
    convertCommentsToJson(raw) {
      return [
        ...raw.matchAll(/#<Comment (.*?)(value: "[^"]*")(.*?)>/g),
      ].map((match) => {
        const valueField = match[0].match(/(?<=, )value: "([^"]|\\")*[^\\]",/)?.[0];
        const baseMatch = match[0].replace(/^#<Comment /, "");
        const baseMatchWithoutValue = valueField
          ? baseMatch.split(valueField).join("")
          : baseMatch;
        const fields = baseMatchWithoutValue
          .split(",")
          .map((part) => part.trim())
          .map((pair) => {
            const [
              key,
              value,
            ] = pair.split(/:\s+/);
            // Clean up values: remove extra quotes or cast to appropriate types
            let cleaned = value;
            if (cleaned === "nil") cleaned = null;
            else if (cleaned === "true") cleaned = true;
            else if (cleaned === "false") cleaned = false;
            else if (/^\d+$/.test(cleaned)) cleaned = parseInt(cleaned, 10);
            else if (/^".*"$/.test(cleaned)) cleaned = cleaned.slice(1, -1);
            return [
              key,
              cleaned,
            ];
          });
        return Object.fromEntries(valueField
          ? [
            ...fields,
            [
              "value",
              valueField?.replace(/^value: ?/, ""),
            ],
          ]
          : fields);
      });
    },
    isRelevant(payload) {
      const lastTs = this._getLastTs() || 0;
      let maxTs = lastTs;
      const comments = this.convertCommentsToJson(payload.ticketComments);
      for (const comment of comments) {
        const ts = Date.parse(comment.created_at);
        maxTs = Math.max(maxTs, ts);
      }
      this._setLastTs(maxTs);
      return comments.length > 0 && maxTs > lastTs;
    },
    emitEvent(payload) {
      payload.ticketComments = this.convertCommentsToJson(payload.ticketComments);
      const {
        ticketComments, ...ticketData
      } = payload;
      for (const comment of ticketComments) {
        const ts = Date.parse(comment.created_at);
        const id = `${payload.ticketId}-${ts}`;
        this.$emit({
          ...comment,
          ticketData,
        }, {
          id,
          summary: comment.value,
          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
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`

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 Order on PlentyONE

Description:Creates a new order in PlentyONE. [See the documentation](https://developers.plentymarkets.com/en-gb/plentymarkets-rest-api/index.html#/Order/post_rest_orders)

Version:0.0.2

Key:plentyone-create-order

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import {
  LOCK_STATUS_OPTIONS,
  ORDER_TYPE_OPTIONS,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import plentyone from "../../plentyone.app.mjs";

export default {
  key: "plentyone-create-order",
  name: "Create Order",
  description: "Creates a new order in PlentyONE. [See the documentation](https://developers.plentymarkets.com/en-gb/plentymarkets-rest-api/index.html#/Order/post_rest_orders)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    plentyone,
    orderTypeId: {
      type: "integer",
      label: "Order Type ID",
      description: "The ID of the order type.",
      options: ORDER_TYPE_OPTIONS,
    },
    plentyId: {
      type: "integer",
      label: "Plenty ID",
      description: "The plenty ID of the client that the order belongs to.",
    },
    statusId: {
      propDefinition: [
        plentyone,
        "statusId",
      ],
      optional: true,
    },
    ownerId: {
      type: "integer",
      label: "Owner ID",
      description: "The user ID of the order's owner.",
      optional: true,
    },
    lockStatus: {
      type: "string",
      label: "Lock Status",
      description: "The lock status of the order.",
      options: LOCK_STATUS_OPTIONS,
      optional: true,
    },
    orderItems: {
      type: "string[]",
      label: "Order Items",
      description: "A list of objects of the order items. [See the documentation](https://developers.plentymarkets.com/en-gb/plentymarkets-rest-api/index.html#/Order/post_rest_orders) for more details.",
      optional: true,
    },
    properties: {
      type: "string[]",
      label: "Properties",
      description: "A list of objects of the order properties. [See the documentation](https://developers.plentymarkets.com/en-gb/plentymarkets-rest-api/index.html#/Order/post_rest_orders) for more details.",
      optional: true,
    },
    addressRelations: {
      type: "string[]",
      label: "Address Relations",
      description: "A list of objects of the order address relations. [See the documentation](https://developers.plentymarkets.com/en-gb/plentymarkets-rest-api/index.html#/Order/post_rest_orders) for more details.",
      optional: true,
    },
    relations: {
      type: "string[]",
      label: "Relations",
      description: "A list of objects of the order relations. [See the documentation](https://developers.plentymarkets.com/en-gb/plentymarkets-rest-api/index.html#/Order/post_rest_orders) for more details.",
      optional: true,
    },
  },
  async run({ $ }) {
    try {
      const response = await this.plentyone.createOrder({
        $,
        data: {
          typeId: this.orderTypeId,
          plentyId: this.plentyId,
          statusId: this.statusId,
          ownerId: this.ownerId,
          lockStatus: this.lockStatus,
          orderItems: parseObject(this.orderItems),
          properties: parseObject(this.properties),
          addressRelations: parseObject(this.addressRelations),
          relations: parseObject(this.relations),
        },
      });

      $.export("$summary", `Successfully created order: ${response.id}`);
      return response;
    } catch (error) {
      $.export("$summary", "Failed to create order");
      throw new ConfigurationError(error);
    }
  },
};

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
PlentyONE	`plentyone`	`app`	This component uses the PlentyONE app.
Order Type ID	`orderTypeId`	`integer`	Select a value from the drop down menu:`{ "label": "Sales order", "value": 1 }{ "label": "Delivery", "value": 2 }{ "label": "Returns", "value": 3 }{ "label": "Credit note", "value": 4 }{ "label": "Warranty", "value": 5 }{ "label": "Repair", "value": 6 }{ "label": "Offer", "value": 7 }{ "label": "Advance order", "value": 8 }{ "label": "Multi-order", "value": 9 }{ "label": "Multi credit note", "value": 10 }{ "label": "Multi delivery", "value": 11 }{ "label": "Reorder", "value": 12 }{ "label": "Partial delivery", "value": 13 }{ "label": "Subscription", "value": 14 }{ "label": "Redistribution", "value": 15 }`
Plenty ID	`plentyId`	`integer`	The plenty ID of the client that the order belongs to.
Status ID	`statusId`	`integer`	Select a value from the drop down menu.
Owner ID	`ownerId`	`integer`	The user ID of the order's owner.
Lock Status	`lockStatus`	`string`	Select a value from the drop down menu:`{ "label": "Unlocked", "value": "unlocked" }{ "label": "Permanently locked", "value": "permanentlyLocked" }{ "label": "Reversible locked", "value": "reversibleLocked" }`
Order Items	`orderItems`	`string[]`	A list of objects of the order items. See the documentation for more details.
Properties	`properties`	`string[]`	A list of objects of the order properties. See the documentation for more details.
Address Relations	`addressRelations`	`string[]`	A list of objects of the order address relations. See the documentation for more details.
Relations	`relations`	`string[]`	A list of objects of the order relations. See the documentation for more details.

Action Authentication#

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

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

Create Order with PlentyONE API on New Ticket Comment Added (Instant) from Zendesk API

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

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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