Chat With Document with AskYourPDF API on New Ticket from Gorgias API

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

Trigger workflow on

New Ticket from the Gorgias API

Next, do this

Chat With Document 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 Gorgias 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 Gorgias account
2. Optional- Select a Channel
3. Optional- Select a Via
4. Optional- Select a User ID
5. Optional- Select one or more Tag IDs
Configure the Chat With Document action
1. Connect your AskYourPDF account
2. Configure Document ID
3. Configure Sender
4. Configure Message
5. Optional- Configure Stream
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 Gorgias

Description:Emit new event when a ticket is created. [See the documentation](https://developers.gorgias.com/reference/the-event-object)

Version:0.1.6

Key:gorgias_oauth-ticket-created

View on GitHub

Gorgias Overview#

Gorgias is a helpdesk platform that centralizes customer interactions and automates common support tasks. Utilizing the Gorgias API on Pipedream allows you to streamline customer service processes by creating automated workflows. With these integrations, you can sync customer data, manage tickets, automate responses, and track support metrics, effectively turning Gorgias into an engine for customer support automation.

Trigger Code#

import base from "../common/base.mjs";
import eventTypes from "../common/event-types.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...base,
  key: "gorgias_oauth-ticket-created",
  name: "New Ticket",
  description: "Emit new event when a ticket is created. [See the documentation](https://developers.gorgias.com/reference/the-event-object)",
  version: "0.1.6",
  type: "source",
  props: {
    ...base.props,
    channel: {
      propDefinition: [
        base.props.gorgias_oauth,
        "channel",
      ],
      default: "",
      description: "The channel used to send the message.",
    },
    via: {
      propDefinition: [
        base.props.gorgias_oauth,
        "via",
      ],
      default: "",
      description: "How the message has been received, or sent from Gorgias.",
    },
    assigneeId: {
      propDefinition: [
        base.props.gorgias_oauth,
        "userId",
      ],
    },
    tagIds: {
      type: "string[]",
      label: "Tag IDs",
      description: "The tag ids to filter tickets by.",
      propDefinition: [
        base.props.gorgias_oauth,
        "tagId",
      ],
    },
  },
  methods: {
    ...base.methods,
    getEventType() {
      return eventTypes.TICKET_CREATED;
    },
    isRelevant(ticket) {
      const tagIds = ticket.tags.map(({ id }) => id);
      return (!this.channel || ticket.channel === this.channel)
        && (!this.via || ticket.via === this.via)
        && (!this.assigneeId || ticket?.assignee_user_id === this.assigneeId)
        && (!this.tagIds || this.tagIds.some((tagId) => tagIds.includes(tagId)));
    },
    async processHistoricalEvent(event) {
      const ticket = await this.retrieveTicket(event.object_id);
      return {
        ticket,
      };
    },
    async processEvent(event) {
      const { ticket } = event;
      if (this.isRelevant(ticket)) {
        this.emitEvent(ticket);
      }
    },
  },
  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
Gorgias	`gorgias_oauth`	`app`	This component uses the Gorgias 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.
Channel	`channel`	`string`	Select a value from the drop down menu:`aircallapichatemailfacebookfacebook-mentionfacebook-messengerfacebook-recommendationshelp-centerinstagram-ad-commentinstagram-commentinstagram-mentioninstagram-direct-messageinternal-notephonesmstwittertwitter-direct-messageyotpo-review`
Via	`via`	`string`	Select a value from the drop down menu:`help-centertwitterself_serviceapiformchatfacebookyotpo-reviewtwitter-direct-messageruletwilioyotpogorgias_chatfacebook-messengersmsinstagram-mentioninstagram-ad-commentfacebook-mentionaircallhelpdeskzendeskfacebook-recommendationsinstagram-commentinstagram-direct-messageinternal-noteshopifyemailphoneinstagram`
User ID	`assigneeId`	`integer`	Select a value from the drop down menu.
Tag IDs	`tagIds`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

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

openidemailprofileofflinewrite:all

About Gorgias#

Gorgias is the ecommerce helpdesk that turns your customer service into a profit center.

Action#

Chat With Document on AskYourPDF

Description:Chat with a document. [See the documentation](https://docs.askyourpdf.com/askyourpdf-docs/#3.-chat-endpoint)

Version:0.0.2

Key:askyourpdf-chat-with-document

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";

export default {
  key: "askyourpdf-chat-with-document",
  name: "Chat With Document",
  description: "Chat with a document. [See the documentation](https://docs.askyourpdf.com/askyourpdf-docs/#3.-chat-endpoint)",
  type: "action",
  version: "0.0.2",
  props: {
    app,
    docId: {
      type: "string",
      label: "Document ID",
      description: "The ID of the document for the conversation.",
    },
    sender: {
      type: "string",
      label: "Sender",
      description: "The sender of the chat message. The sender should be `user`.",
      default: "user",
    },
    message: {
      type: "string",
      label: "Message",
      description: "The chat message content.",
    },
    stream: {
      type: "boolean",
      label: "Stream",
      description: "Flag for streaming. Default is false",
      optional: true,
      default: false,
    },
  },
  methods: {
    chatWithDocument({
      docId, ...args
    } = {}) {
      return this.app.post({
        path: `/chat/${docId}`,
        ...args,
      });
    },
  },
  run({ $: step }) {
    const {
      // eslint-disable-next-line no-unused-vars
      app,
      chatWithDocument,
      docId,
      sender,
      message,
      stream,
    } = this;

    return chatWithDocument({
      step,
      docId,
      data: [
        {
          sender,
          message,
        },
      ],
      params: {
        stream,
      },
      summary: (response) => `Successfully chatted with document at: \`${response.created || (new Date()).toISOString()}\``,
    });
  },
};

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.
Document ID	`docId`	`string`	The ID of the document for the conversation.
Sender	`sender`	`string`	The sender of the chat message. The sender should be `user`.
Message	`message`	`string`	The chat message content.
Stream	`stream`	`boolean`	Flag for streaming. Default is false