Update Ticket with Zendesk API on New Inventory Update from Vend API

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

Trigger workflow on

New Inventory Update from the Vend API

Next, do this

Update Ticket with the Zendesk 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 Vend trigger and Zendesk action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Inventory Update trigger
1. Connect your Vend account
2. Select a Event Type
Configure the Update Ticket action
1. Connect your Zendesk account
2. Select a Ticket ID
3. Configure Comment body
4. Optional- Configure Comment body is HTML
5. Optional- Select a Ticket Priority
6. Optional- Configure Ticket Subject
7. Optional- Select a Ticket Status
8. Optional- Configure Comment Public
9. Optional- Configure Custom Subdomain
10. Optional- Configure Attachments
11. Optional- Configure Tags
12. Optional- Select a Tag Action
13. Optional- Select a Assignee ID
14. Optional- Configure Assignee Email
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 Inventory Update on Vend

Description:Emit new event for each update on inventory. [See docs here](https://docs.vendhq.com/reference/post-webhooks)

Version:0.0.1

Key:vend-inventory-update

View on GitHub

Vend Overview#

The Vend API offers programmatic access to retail management features, enabling users to automate processes related to inventory, sales, products, customers, and more within their retail business. Through Pipedream, you can harness this API to create custom workflows that trigger on various events within Vend, process data, integrate with other apps, and automate actions to streamline retail operations, enhance customer engagement, and optimize sales strategies.

Trigger Code#

import vend from "../../vend.app.mjs";
import constants from "../common/constants.mjs";

export default {
  name: "New Inventory Update",
  version: "0.0.1",
  key: "vend-inventory-update",
  description: "Emit new event for each update on inventory. [See docs here](https://docs.vendhq.com/reference/post-webhooks)",
  type: "source",
  dedupe: "unique",
  props: {
    vend,
    db: "$.service.db",
    http: "$.interface.http",
    eventType: {
      label: "Event Type",
      description: "The type of the event",
      type: "string",
      options: constants.WEBHOOK_EVENT_TYPES,
    },
  },
  methods: {
    _getWebhookId() {
      return this.db.get("webhookId");
    },
    _setWebhookId(webhookId) {
      this.db.set("webhookId", webhookId);
    },
  },
  hooks: {
    async activate() {
      const response = await this.vend.createWebhook({
        url: this.http.endpoint,
        active: true,
        type: this.eventType,
      });

      this._setWebhookId(response.id);
    },
    async deactivate() {
      const webhookId = this._getWebhookId();
      await this.vend.removeWebhook(webhookId);
    },
  },
  async run(event) {
    const { body: { payload } } = event;

    const resource = JSON.parse(payload);

    const ts = new Date();

    this.$emit(resource, {
      id: ts,
      summary: `New event ${this.eventType} (${resource.id}) `,
      ts: 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
Vend	`vend`	`app`	This component uses the Vend 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.
Event Type	`eventType`	`string`	Select a value from the drop down menu:`{ "label": "Sale Update", "value": "sale.update" }{ "label": "Product Update", "value": "product.update" }{ "label": "Customer Update", "value": "customer.update" }{ "label": "Inventory Update", "value": "inventory.update" }{ "label": "Register Closure Create", "value": "register_closure.create" }{ "label": "Register Closure Update", "value": "register_closure.update" }{ "label": "Consignment Send", "value": "consignment.send" }{ "label": "Consignment Receive", "value": "consignment.receive" }`

Trigger Authentication#

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

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

About Vend#

Retail POS Software

Action#

Update Ticket on Zendesk

Description:Updates a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#update-ticket).

Version:0.2.2

Key:zendesk-update-ticket

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.

Action Code#

import app from "../../zendesk.app.mjs";

export default {
  key: "zendesk-update-ticket",
  name: "Update Ticket",
  description: "Updates a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#update-ticket).",
  type: "action",
  version: "0.2.2",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    app,
    ticketId: {
      propDefinition: [
        app,
        "ticketId",
      ],
    },
    ticketCommentBody: {
      propDefinition: [
        app,
        "ticketCommentBody",
      ],
    },
    ticketCommentBodyIsHTML: {
      propDefinition: [
        app,
        "ticketCommentBodyIsHTML",
      ],
    },
    ticketPriority: {
      propDefinition: [
        app,
        "ticketPriority",
      ],
    },
    ticketSubject: {
      propDefinition: [
        app,
        "ticketSubject",
      ],
    },
    ticketStatus: {
      propDefinition: [
        app,
        "ticketStatus",
      ],
    },
    ticketCommentPublic: {
      propDefinition: [
        app,
        "ticketCommentPublic",
      ],
    },
    customSubdomain: {
      propDefinition: [
        app,
        "customSubdomain",
      ],
    },
    attachments: {
      propDefinition: [
        app,
        "attachments",
      ],
    },
    ticketTags: {
      propDefinition: [
        app,
        "ticketTags",
      ],
    },
    tagAction: {
      type: "string",
      label: "Tag Action",
      description: "How to handle the tags: set (replace all existing tags), add (append to existing tags), or remove (remove specified tags)",
      options: [
        {
          label: "Set Tags (Replace All)",
          value: "set",
        },
        {
          label: "Add Tags (Append)",
          value: "add",
        },
        {
          label: "Remove Tags",
          value: "remove",
        },
      ],
      optional: true,
      default: "set",
    },
    assigneeId: {
      propDefinition: [
        app,
        "assigneeId",
      ],
    },
    assigneeEmail: {
      propDefinition: [
        app,
        "assigneeEmail",
      ],
    },
  },
  methods: {
    updateTicket({
      ticketId, ...args
    } = {}) {
      return this.app.update({
        path: `/tickets/${ticketId}`,
        ...args,
      });
    },
  },
  async run({ $: step }) {
    const {
      ticketId,
      ticketCommentBody,
      ticketCommentBodyIsHTML,
      ticketPriority,
      ticketSubject,
      ticketStatus,
      ticketCommentPublic,
      customSubdomain,
      attachments,
      ticketTags,
      tagAction,
      assigneeId,
      assigneeEmail,
    } = this;

    const ticketComment = ticketCommentBodyIsHTML
      ? {
        html_body: ticketCommentBody,
      }
      : {
        body: ticketCommentBody,
      };

    ticketComment.public = ticketCommentPublic;

    // Upload attachments if provided
    if (attachments && attachments.length > 0) {
      try {
        const uploadTokens = await this.app.uploadFiles({
          attachments,
          customSubdomain,
          step,
        });

        if (uploadTokens.length > 0) {
          ticketComment.uploads = uploadTokens;
        }
      } catch (error) {
        step.export("$summary", `Failed to upload attachments: ${error.message}`);
        throw error;
      }
    }

    // Build ticket data object
    const ticketData = {
      comment: ticketComment,
      priority: ticketPriority,
      subject: ticketSubject,
      status: ticketStatus,
    };

    // Add assignee fields if provided
    if (assigneeId) {
      ticketData.assignee_id = assigneeId;
    }
    if (assigneeEmail) {
      ticketData.assignee_email = assigneeEmail;
    }

    const response = await this.updateTicket({
      step,
      ticketId,
      customSubdomain,
      data: {
        ticket: ticketData,
      },
    });

    const attachmentCount = ticketComment.uploads?.length || 0;
    const assigneeUpdated = assigneeId || assigneeEmail;

    let summary = `Successfully updated ticket with ID ${response.ticket.id}`;

    const updates = [];
    if (attachmentCount > 0) {
      updates.push(`${attachmentCount} attachment(s)`);
    }
    if (assigneeUpdated) {
      updates.push("assignee");
    }

    if (updates.length > 0) {
      summary += ` with ${updates.join(" and ")}`;
    }

    step.export("$summary", summary);

    // Handle tag operations if tags are provided
    if (ticketTags && ticketTags.length > 0) {
      let tagResponse;

      switch (tagAction) {
      case "add":
        tagResponse = await this.app.addTicketTags({
          step,
          ticketId,
          tags: ticketTags,
          customSubdomain,
        });
        break;
      case "remove":
        tagResponse = await this.app.removeTicketTags({
          step,
          ticketId,
          tags: ticketTags,
          customSubdomain,
        });
        break;
      case "set":
      default:
        tagResponse = await this.app.setTicketTags({
          step,
          ticketId,
          tags: ticketTags,
          customSubdomain,
        });
        break;
      }

      // Include tag information in summary
      const tagSummary = `and ${tagAction === "set"
        ? "set"
        : tagAction === "add"
          ? "added"
          : "removed"} ${ticketTags.length} tag(s)`;
      step.export("$summary", `Successfully updated ticket with ID ${response.ticket.id} ${tagSummary}`);
      // Include tag response in the return data
      return {
        ticket: response,
        tags: tagResponse,
      };
    }

    step.export("$summary", `Successfully updated ticket with ID ${response.ticket.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
Zendesk	`app`	`app`	This component uses the Zendesk app.
Ticket ID	`ticketId`	`string`	Select a value from the drop down menu.
Comment body	`ticketCommentBody`	`string`	The body of the comment.
Comment body is HTML	`ticketCommentBodyIsHTML`	`boolean`	Whether the comment body is HTML. Default is `false`, which expects Markdown
Ticket Priority	`ticketPriority`	`string`	Select a value from the drop down menu:`urgenthighnormallow`
Ticket Subject	`ticketSubject`	`string`	The subject of the ticket.
Ticket Status	`ticketStatus`	`string`	Select a value from the drop down menu:`newopenpendingholdsolvedclosed`
Comment Public	`ticketCommentPublic`	`boolean`	Whether the comment is public. Default is `true`
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`
Attachments	`attachments`	`string[]`	File paths or URLs to attach to the ticket. Multiple files can be attached.
Tags	`ticketTags`	`string[]`	Array of tags to apply to the ticket. These will replace any existing tags on the ticket.
Tag Action	`tagAction`	`string`	Select a value from the drop down menu:`{ "label": "Set Tags (Replace All)", "value": "set" }{ "label": "Add Tags (Append)", "value": "add" }{ "label": "Remove Tags", "value": "remove" }`
Assignee ID	`assigneeId`	`string`	Select a value from the drop down menu.
Assignee Email	`assigneeEmail`	`string`	The email address of the agent to assign the ticket to

Action 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

Update Ticket with Zendesk API on New Inventory Update from Vend API

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