Add Document Via File Upload with AskYourPDF API on New Ticket from Freshservice API

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

Trigger workflow on

New Ticket from the Freshservice API

Next, do this

Add Document Via File Upload with the AskYourPDF 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 Freshservice trigger and AskYourPDF 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 trigger
1. Connect your Freshservice account
2. Configure timer
Configure the Add Document Via File Upload action
1. Connect your AskYourPDF account
2. Configure File Path or URL
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 on Freshservice

Description:Emit new event for each created ticket. [See documentation](https://api.freshservice.com/#view_all_ticket)

Version:0.0.2

Key:freshservice-new-ticket

View on GitHub

Freshservice Overview#

The Freshservice API opens up a realm of possibilities for streamlining IT service management processes. It allows you to interact programmatically with Freshservice features, such as creating tickets, managing users, updating service catalog items, and more. Leveraging the Freshservice API on Pipedream, you can automate repetitive tasks, create complex workflows that react to events in Freshservice in real time, and connect Freshservice to a multitude of other services to enhance its capabilities and your productivity.

Trigger Code#

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

export default {
  name: "New Ticket",
  version: "0.0.2",
  key: "freshservice-new-ticket",
  description: "Emit new event for each created ticket. [See documentation](https://api.freshservice.com/#view_all_ticket)",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      static: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  methods: {
    emitEvent(data) {
      this.$emit(data, {
        id: data.id,
        summary: `New ticket with ID ${data.id}`,
        ts: Date.parse(data.created_at),
      });
    },
    async emitEvents() {
      const { tickets: resources } = await this.app.getTickets({
        params: {
          filter: "new_and_my_open",
          order_type: "desc",
        },
      });

      resources.reverse().forEach(this.emitEvent);
    },
  },
  hooks: {
    async deploy() {
      await this.emitEvents();
    },
  },
  async run() {
    await this.emitEvents();
  },
};

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
Freshservice	`app`	`app`	This component uses the Freshservice app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

Your Freshservice API key is in your Profile > Settings page, below the change password section on the right.

Your domain is displayed in your Freshdesk URL. For example, https://{your_domain_here}.freshservice.com/.

About Freshservice#

Cloud-based IT Service Management solution

Action#

Add Document Via File Upload on AskYourPDF

Description:Add a document via file upload. [See the documentation](https://docs.askyourpdf.com/askyourpdf-docs/#2.-adding-document-via-file-upload)

Version:0.1.0

Key:askyourpdf-add-document-via-file-upload

View on GitHub

AskYourPDF Overview#

AskYourPDF API allows you to extract text and data from PDF files programmatically. On Pipedream, leverage this API to automate workflows involving PDF data extraction, such as parsing invoices, extracting data for reports, or importing information into a database. With Pipedream's ability to integrate with various apps, you can create workflows that trigger on specific events and handle extracted PDF data with custom logic and actions.

Action Code#

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

export default {
  key: "askyourpdf-add-document-via-file-upload",
  name: "Add Document Via File Upload",
  description: "Add a document via file upload. [See the documentation](https://docs.askyourpdf.com/askyourpdf-docs/#2.-adding-document-via-file-upload)",
  type: "action",
  version: "0.1.0",
  props: {
    app,
    file: {
      type: "string",
      label: "File Path or URL",
      description: "The file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`)",
    },
  },
  methods: {
    addDocumentViaFileUpload(args = {}) {
      return this.app.post({
        path: "/api/upload",
        ...args,
      });
    },
  },
  run({ $: step }) {
    const {
      // eslint-disable-next-line no-unused-vars
      app,
      addDocumentViaFileUpload,
      ...data
    } = this;

    return addDocumentViaFileUpload({
      step,
      data,
      headers: constants.MULTIPART_FORM_DATA_HEADERS,
      summary: (response) => `Successfully added document via file upload with Doc ID: \`${response.docId}\``,
    });
  },
};

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
AskYourPDF	`app`	`app`	This component uses the AskYourPDF app.
File Path or URL	`file`	`string`	The file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`)