Update Ticket with Zendesk API on New Submission from SurveyCTO API

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

Trigger workflow on

New Submission from the SurveyCTO 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 SurveyCTO 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 Submission trigger
1. Connect your SurveyCTO account
2. Configure timer
3. Select a Form ID
Configure the Update Ticket action
1. Connect your Zendesk account
2. Select a Ticket ID
3. Configure Comment body
4. Optional- Select a Ticket Priority
5. Optional- Configure Ticket Subject
6. Optional- Select a Ticket Status
7. Optional- Configure Custom Subdomain
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 Submission on SurveyCTO

Description:Emit new event each time a new form submission is received in SurveyCTO. [See the documentation](https://support.surveycto.com/hc/en-us/articles/360033156894-REST-API-documentation). Note: The [role](https://docs.surveycto.com/04-monitoring-and-management/01-the-basics/00b.managing-user-roles.html) of the authenticated user must "Allow server API access".

Version:0.0.1

Key:surveycto-new-submission

View on GitHub

SurveyCTO Overview#

The SurveyCTO API enables automated interactions with SurveyCTO services, a platform focusing on data collection and organization for research and survey projects. With this API, you can seamlessly retrieve, push, and manage survey data. Integrating SurveyCTO with Pipedream opens a realm of possibilities for automating data workflows, such as triggering actions based on new survey submissions, syncing collected data with other databases or apps, or even automating reports and notifications.

Trigger Code#

import surveycto from "../../surveycto.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import sampleEmit from "./test-event.mjs";

export default {
  key: "surveycto-new-submission",
  name: "New Submission",
  description: "Emit new event each time a new form submission is received in SurveyCTO. [See the documentation](https://support.surveycto.com/hc/en-us/articles/360033156894-REST-API-documentation). Note: The [role](https://docs.surveycto.com/04-monitoring-and-management/01-the-basics/00b.managing-user-roles.html) of the authenticated user must \"Allow server API access\".",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    surveycto,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    formId: {
      propDefinition: [
        surveycto,
        "formId",
      ],
    },
  },
  methods: {
    _getLastTs() {
      return this.db.get("lastTs") || 0;
    },
    _setLastTs(lastTs) {
      this.db.set("lastTs", lastTs);
    },
    generateMeta(submission) {
      return {
        id: submission.KEY,
        summary: `New Submission ${submission.KEY}`,
        ts: Date.parse(submission.SubmissionDate),
      };
    },
  },
  async run() {
    const lastTs = this._getLastTs();
    let maxTs = lastTs;
    const submissions = await this.surveycto.listSubmissions({
      formId: this.formId,
      params: {
        date: lastTs,
      },
    });
    for (const submission of submissions) {
      const ts = Date.parse(submission.SubmissionDate);
      if (ts > lastTs) {
        const meta = this.generateMeta(submission); console.log(meta);
        this.$emit(submission, meta);
        if (ts > maxTs) {
          maxTs = ts;
        }
      }
    }
    this._setLastTs(maxTs);
  },
  sampleEmit,
};

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
SurveyCTO	`surveycto`	`app`	This component uses the SurveyCTO app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Form ID	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

SurveyCTO requires their users enter their SurveyCTO email and password in order to connect to their API. For more info, refer to SurveyCTO, documentation.

In addition, you need to enable API Access in order to connect successfully.

On SurveyCTO Web UI, access Configure tab.
On the Configure tab, scroll down to User roles and permissions section.
Under Administrator (full access, plus subscription management) role, click Edit, then check Allow server API access.

About SurveyCTO#

SurveyCTO is the most reliable, secure, and scalable mobile data collection platform for researchers and professionals working in offline settings.

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.1.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.1.2",
  props: {
    app,
    ticketId: {
      propDefinition: [
        app,
        "ticketId",
      ],
    },
    ticketCommentBody: {
      propDefinition: [
        app,
        "ticketCommentBody",
      ],
    },
    ticketPriority: {
      propDefinition: [
        app,
        "ticketPriority",
      ],
    },
    ticketSubject: {
      propDefinition: [
        app,
        "ticketSubject",
      ],
    },
    ticketStatus: {
      propDefinition: [
        app,
        "ticketStatus",
      ],
    },
    customSubdomain: {
      propDefinition: [
        app,
        "customSubdomain",
      ],
    },
  },
  methods: {
    updateTicket({
      ticketId, ...args
    } = {}) {
      return this.app.update({
        path: `/tickets/${ticketId}`,
        ...args,
      });
    },
  },
  async run({ $: step }) {
    const {
      ticketId,
      ticketCommentBody,
      ticketPriority,
      ticketSubject,
      ticketStatus,
      customSubdomain,
    } = this;

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

    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.
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`
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`

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

Try it

Delete Ticket with Zendesk API on New Submission from SurveyCTO API

SurveyCTO + Zendesk

Try it

Popular Triggers#

New Submission from the SurveyCTO API

Emit new event each time a new form submission is received in SurveyCTO. See the documentation. Note: The role of the authenticated user must "Allow server API access".

Try it

New Ticket (Instant) from the Zendesk API

Emit new event when a ticket is created

Try it

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

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

Try it

Ticket Closed (Instant) from the Zendesk API

Emit new event when a ticket has changed to closed status

Try it

Ticket Pending (Instant) from the Zendesk API

Emit new event when a ticket has changed to pending status