Create Ticket Message with Gorgias API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Create Ticket Message with the Gorgias 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 Pipedream trigger and Gorgias action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the Create Ticket Message action
1. Connect your Gorgias account
2. Select a Ticket ID
3. Configure From Agent
4. Select a From User
5. Select a To User
6. Select a From Customer
7. Select a To Customer
8. Configure Message
9. Select a Channel
10. Select a Via
11. Optional- Configure Subject
12. Optional- Configure Attachment URL
13. Optional- Configure Attachment File Name
14. Optional- Configure Sent Datetime
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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

Action#

Create Ticket Message on Gorgias

Description:Create a message for a ticket in the Gorgias system. [See the documentation](https://developers.gorgias.com/reference/create-ticket-message)

Version:0.0.5

Key:gorgias_oauth-create-ticket-message

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.

Action Code#

import gorgiasOauth from "../../gorgias_oauth.app.mjs";
import {
  axios, ConfigurationError,
} from "@pipedream/platform";

export default {
  key: "gorgias_oauth-create-ticket-message",
  name: "Create Ticket Message",
  description: "Create a message for a ticket in the Gorgias system. [See the documentation](https://developers.gorgias.com/reference/create-ticket-message)",
  version: "0.0.5",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    gorgiasOauth,
    ticketId: {
      propDefinition: [
        gorgiasOauth,
        "ticketId",
      ],
      description: "The ID of the ticket to add a message to",
    },
    fromAgent: {
      type: "boolean",
      label: "From Agent",
      description: "Whether the message was sent by your company to a customer, or the opposite",
      reloadProps: true,
    },
    fromUser: {
      propDefinition: [
        gorgiasOauth,
        "userId",
      ],
      label: "From User",
      description: "User who sent the message",
      optional: false,
      hidden: true,
    },
    toUser: {
      propDefinition: [
        gorgiasOauth,
        "userId",
      ],
      label: "To User",
      description: "The user receiving the message",
      optional: false,
      hidden: true,
    },
    fromCustomer: {
      propDefinition: [
        gorgiasOauth,
        "customerId",
      ],
      label: "From Customer",
      description: "The customer who sent the message",
      hidden: true,
    },
    toCustomer: {
      propDefinition: [
        gorgiasOauth,
        "customerId",
      ],
      label: "To Customer",
      description: "The customer receiving the message",
      hidden: true,
    },
    message: {
      type: "string",
      label: "Message",
      description: "Message of the ticket. Accepts HTML",
    },
    channel: {
      propDefinition: [
        gorgiasOauth,
        "channel",
      ],
      optional: false,
      default: "email",
      reloadProps: true,
    },
    via: {
      propDefinition: [
        gorgiasOauth,
        "via",
      ],
      optional: false,
    },
    subject: {
      propDefinition: [
        gorgiasOauth,
        "subject",
      ],
      optional: true,
    },
    attachmentUrl: {
      type: "string",
      label: "Attachment URL",
      description: "The URL to access to the attached file",
      optional: true,
    },
    attachmentName: {
      type: "string",
      label: "Attachment File Name",
      description: "The name of the file to attach",
      optional: true,
    },
    sentDatetime: {
      type: "string",
      label: "Sent Datetime",
      description: "When the message was sent. If ommited, the message will be sent by Gorgias. E.g. `2025-01-27T19:38:52.028Z`",
      optional: true,
    },
  },
  additionalProps(props) {
    const isInternalNote = this.channel === "internal-note";
    props.toUser.hidden = this.fromAgent || isInternalNote;
    props.fromCustomer.hidden = this.fromAgent || isInternalNote;
    props.toCustomer.hidden = !this.fromAgent || isInternalNote;
    props.fromUser.hidden = !this.fromAgent;
    return {};
  },
  methods: {
    /**
     * Get attachment information from URL
     * @param {object} $ - Step object
     * @param {string} url - Attachment URL
     * @returns {object} Content type and size information
     */
    async getAttachmentInfo($, url) {
      const { headers } = await axios($, {
        method: "HEAD",
        url,
        returnFullResponse: true,
      });
      return {
        contentType: headers["content-type"],
        size: headers["content-length"],
      };
    },
    /**
     * Get email address for user or customer
     * @param {object} $ - Step object
     * @param {string} id - User or customer ID
     * @param {string} type - Type of email to get (from/to)
     * @returns {string} Email address
     */
    async getEmail($, id, type = "from") {
      const {
        gorgiasOauth: {
          retrieveUser, retrieveCustomer,
        },
      } = this;
      const fn = this.fromAgent
        ? type === "from"
          ? retrieveUser
          : retrieveCustomer
        : type === "from"
          ? retrieveCustomer
          : retrieveUser;

      const { email } = await fn({
        $,
        id,
      });
      return email;
    },
  },
  async run({ $ }) {
    if ((this.attachmentUrl && !this.attachmentName)
      || (!this.attachmentUrl && this.attachmentName)
    ) {
      throw new ConfigurationError("Must enter both Attachment URL and Attachment File Name");
    }

    const isInternalNote = this.channel === "internal-note";

    if (isInternalNote && this.fromAgent === false) {
      throw new ConfigurationError("From Agent must be set to `true` when creating an internal note");
    }

    let contentType, size;
    if (this.attachmentUrl) {
      ({
        contentType, size,
      } = await this.getAttachmentInfo($, this.attachmentUrl));
    }

    const fromId = this.fromAgent
      ? this.fromUser
      : this.fromCustomer;

    const toId = this.fromAgent
      ? this.toCustomer
      : this.toUser;

    if (!fromId) {
      throw new ConfigurationError(`"${this.fromAgent
        ? "From User"
        : "From Customer"}" is required when "From Agent" is set to \`${this.fromAgent}\``);
    }
    // For internal notes, we don't need to validation
    if (!isInternalNote) {
      if (!toId) {
        throw new ConfigurationError(`"${this.fromAgent
          ? "To Customer"
          : "To User"}" is required when "From Agent" is set to \`${this.fromAgent}\``);
      }
    }

    const messageData = {
      channel: this.channel,
      body_html: this.message,
      via: this.via,
      subject: this.subject,
      from_agent: this.fromAgent,
      sent_datetime: this.sentDatetime,
      attachments: this.attachmentUrl && [
        {
          url: this.attachmentUrl,
          name: this.attachmentName,
          content_type: contentType,
          size,
        },
      ],
      sender: {
        id: fromId,
      },
    };

    // Only add source and receiver for non-internal notes
    if (!isInternalNote) {
      messageData.source = {
        from: {
          address: await this.getEmail($, fromId, "from"),
        },
        to: [
          {
            address: await this.getEmail($, toId, "to"),
          },
        ],
      };
      messageData.receiver = {
        id: toId,
      };
    }

    const response = await this.gorgiasOauth.createMessage({
      $,
      ticketId: this.ticketId,
      data: messageData,
    });

    $.export("$summary", `Successfully created ${isInternalNote
      ? "internal note"
      : "ticket message"} with ID: ${response.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
Gorgias	`gorgiasOauth`	`app`	This component uses the Gorgias app.
Ticket ID	`ticketId`	`integer`	Select a value from the drop down menu.
From Agent	`fromAgent`	`boolean`	Whether the message was sent by your company to a customer, or the opposite
Message	`message`	`string`	Message of the ticket. Accepts HTML
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`
Subject	`subject`	`string`	The subject of the ticket
Attachment URL	`attachmentUrl`	`string`	The URL to access to the attached file
Attachment File Name	`attachmentName`	`string`	The name of the file to attach
Sent Datetime	`sentDatetime`	`string`	When the message was sent. If ommited, the message will be sent by Gorgias. E.g. `2025-01-27T19:38:52.028Z`

Action 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

Create Ticket Message with Gorgias API on New Scheduled Tasks from Pipedream API

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

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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