Create Ticket with Zendesk API on New Event from Superdocu API

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

Trigger workflow on

New Event from the Superdocu API

Next, do this

Create 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 Superdocu 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 Event trigger
1. Connect your Superdocu account
2. Configure Secret
Configure the Create Ticket action
1. Connect your Zendesk account
2. Configure Comment body
3. Optional- Select a Ticket Priority
4. Optional- Configure Ticket Subject
5. Optional- Select a Ticket Status
6. 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 Event on Superdocu

Description:Emit new events from Superdocu. You can configure your webhook [here](https://www.superdocu.com/en/c/settings/api)

Version:0.0.1

Key:superdocu-new-event

View on GitHub

Superdocu Overview#

The Superdocu API empowers users to automate document collection and management processes, streamlining the way businesses handle paperwork for clients and employees. It facilitates the creation of document requests, tracking of submissions, and management of user data, all programmatically. Leveraging the Superdocu API on Pipedream allows users to build powerful, serverless workflows that can interact with a broad array of other applications, improving efficiency, reducing manual labor, and ensuring critical documents are collected and processed on time.

Trigger Code#

import crypto from "crypto";
import app from "../../superdocu.app.mjs";

export default {
  type: "source",
  key: "superdocu-new-event",
  name: "New Event",
  description: "Emit new events from Superdocu. You can configure your webhook [here](https://www.superdocu.com/en/c/settings/api)",
  version: "0.0.1",
  props: {
    app,
    secret: {
      type: "string",
      label: "Secret",
      description: "The secret used to sign the webhook. [Click here](https://developers.superdocu.com/webhooks) for more information.",
    },
    http: "$.interface.http",
  },
  methods: {
    _checkSignature(timestamp, signature) {
      const plain = `${this.secret}${timestamp}`;
      const shasum = crypto.createHash("sha256").update(plain);
      const signatureComputed = shasum.digest("base64");
      if (signature !== signatureComputed) {
        throw new Error("Invalid signature. Event aborted.");
      }
    },
    _checkReplayAttack(t) {
      const fiveMinutes = 5 * 60 * 1000;
      const tolerance = fiveMinutes;
      const timestampMilliseconds = Number(t) * 1000;

      if (timestampMilliseconds < Date.now() - tolerance) {
        throw new Error("Invalid Timestamp Signature. The signature's timestamp is outside of the tolerance zone. Event aborted");
      }
    },
    _emit(event) {
      this.$emit(event, {
        id: `${event.object_id}${event.event}`,
        summary: `${event.event} - ${event.object_id}`,
        ts: event.fired_at,
      });
    },
  },
  async run(event) {
    this._checkSignature(event.headers["x-hub-timestamp"], event.headers["x-hub-signature"]);
    this._checkReplayAttack(event.headers["x-hub-timestamp"]);
    this._emit(event.body);
  },
};

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
Superdocu	`app`	`app`	This component uses the Superdocu app.
Secret	`secret`	`string`	The secret used to sign the webhook. Click here for more information.
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 Authentication#

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

To retrieve your API key,

Navigate to your Superdocu account and sign in
Go to “Settings” > “API”

About Superdocu#

Superdocu helps companies collect documents from their contacts: clients, employees or partners.

Action#

Create Ticket on Zendesk

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

Version:0.1.2

Key:zendesk-create-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-create-ticket",
  name: "Create Ticket",
  description: "Creates a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#create-ticket).",
  type: "action",
  version: "0.1.2",
  props: {
    app,
    ticketCommentBody: {
      propDefinition: [
        app,
        "ticketCommentBody",
      ],
    },
    ticketPriority: {
      propDefinition: [
        app,
        "ticketPriority",
      ],
    },
    ticketSubject: {
      propDefinition: [
        app,
        "ticketSubject",
      ],
    },
    ticketStatus: {
      propDefinition: [
        app,
        "ticketStatus",
      ],
    },
    customSubdomain: {
      propDefinition: [
        app,
        "customSubdomain",
      ],
    },
  },
  methods: {
    createTicket(args = {}) {
      return this.app.create({
        path: "/tickets",
        ...args,
      });
    },
  },
  async run({ $: step }) {
    const {
      ticketCommentBody,
      ticketPriority,
      ticketSubject,
      ticketStatus,
      customSubdomain,
    } = this;

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

    step.export("$summary", `Successfully created 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.
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