Update Ticket with Zendesk API on New Application Data Collected from Drimify API

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

Trigger workflow on

New Application Data Collected from the Drimify 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 Drimify 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 Application Data Collected trigger
1. Connect your Drimify account
2. Configure timer
3. Select one or more Application ID
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 Tags
11. Optional- Select a Tag Action
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 Application Data Collected on Drimify

Description:Emit new event when application data has been collected. [See the documentation](https://endpoint.drimify.com/api/docs?ui=re_doc#tag/AppDataCollection/operation/api_app_data_collections_get_collection)

Version:0.0.1

Key:drimify-new-application-data

View on GitHub

Drimify Overview#

Drimify offers a suite of tools to create engaging and interactive content like quizzes, games, and e-learning modules. With the Drimify API, you can automate the creation and management of these interactive elements, extract analytics, and personalize user experiences. On Pipedream, you can leverage these API capabilities to build serverless workflows that connect Drimify with other apps, streamlining processes like lead generation, user engagement tracking, and content updates.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import drimify from "../../drimify.app.mjs";

export default {
  key: "drimify-new-application-data",
  name: "New Application Data Collected",
  description: "Emit new event when application data has been collected. [See the documentation](https://endpoint.drimify.com/api/docs?ui=re_doc#tag/AppDataCollection/operation/api_app_data_collections_get_collection)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    drimify,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    applicationId: {
      propDefinition: [
        drimify,
        "applicationId",
      ],
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || "1970-01-01T00:00:00";
    },
    _setLastDate(lastDate) {
      this.db.set("lastDate", lastDate);
    },
    async emitEvent(maxResults = false) {
      const lastDate = this._getLastDate();

      const response = this.drimify.paginate({
        fn: this.drimify.listAppDataCollections,
      });

      let responseArray = [];
      for await (const item of response) {
        if (Date.parse(item.date) <= Date.parse(lastDate)) break;
        responseArray.push(item);
      }

      if (responseArray.length) {
        if (maxResults && (responseArray.length > maxResults)) {
          responseArray.length = maxResults;
        }
        this._setLastDate(responseArray[0].date);
      }

      for (const item of responseArray.reverse()) {
        this.$emit(item, {
          id: item.idunic || item.id,
          summary: `New Data Collected with ID: ${item.id}`,
          ts: Date.parse(item.date),
        });
      }
    },
  },
  hooks: {
    async deploy() {
      await this.emitEvent(25);
    },
  },
  async run() {
    await this.emitEvent();
  },
};

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
Drimify	`drimify`	`app`	This component uses the Drimify app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Application ID	`applicationId`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

About Drimify#

Drimify empowers you to easily create games and gamification experiences that help you reach your goals. Supercharged games, super-easy creation.

Action#

Update Ticket on Zendesk

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

Version:0.1.5

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 and optionally manages tags. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#update-ticket).",
  type: "action",
  version: "0.1.5",
  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",
      ],
    },
    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",
    },
  },
  methods: {
    updateTicket({
      ticketId, ...args
    } = {}) {
      return this.app.update({
        path: `/tickets/${ticketId}`,
        ...args,
      });
    },
  },
  async run({ $: step }) {
    const {
      ticketId,
      ticketCommentBody,
      ticketCommentBodyIsHTML,
      ticketPriority,
      ticketSubject,
      ticketStatus,
      ticketCommentPublic,
      customSubdomain,
      ticketTags,
      tagAction,
    } = this;

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

    ticketComment.public = ticketCommentPublic;

    const response = await this.updateTicket({
      step,
      ticketId,
      customSubdomain,
      data: {
        ticket: {
          comment: ticketComment,
          priority: ticketPriority,
          subject: ticketSubject,
          status: ticketStatus,
        },
      },
    });

    // 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`
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" }`

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 Application Data Collected from Drimify API

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

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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