Create Contact with RingCentral API on New Ticket from Gorgias API

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

Trigger workflow on

New Ticket from the Gorgias API

Next, do this

Create Contact with the RingCentral 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 RingCentral 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 Create Contact action
1. Connect your RingCentral account
2. Configure Account ID
3. Select one or more Extensions
4. Optional- Configure Email
5. Optional- Configure First Name
6. Optional- Configure Last Name
7. Optional- Configure Mobile Phone
8. Optional- Configure Additional Options
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.7

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.7",
  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#

Create Contact on RingCentral

Description:Creates a user personal contact. [See the documentation](https://developers.ringcentral.com/api-reference/External-Contacts/createContact)

Version:0.0.1

Key:ringcentral-create-contact

View on GitHub

RingCentral Overview#

RingCentral is a comprehensive cloud communication platform that melds messaging, video, and phone services. Integrating RingCentral with Pipedream allows for automated workflows involving SMS sending, call management, and leveraging communication logs for data-driven insights. With Pipedream's serverless execution model, you can trigger actions based on specific RingCentral events or schedule tasks to run at predetermined intervals, all without writing extensive code.

Action Code#

import ringcentral from "../../ringcentral.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "ringcentral-create-contact",
  name: "Create Contact",
  description: "Creates a user personal contact. [See the documentation](https://developers.ringcentral.com/api-reference/External-Contacts/createContact)",
  version: "0.0.1",
  type: "action",
  props: {
    ringcentral,
    accountId: {
      propDefinition: [
        ringcentral,
        "accountId",
      ],
    },
    extensionId: {
      propDefinition: [
        ringcentral,
        "extensionId",
      ],
      description: "Internal identifier of the RingCentral extension/user",
    },
    email: {
      type: "string",
      label: "Email",
      description: "Email address of the contact",
      optional: true,
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name of the contact",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name of the contact",
      optional: true,
    },
    mobilePhone: {
      type: "string",
      label: "Mobile Phone",
      description: "Mobile phone of the contact",
      optional: true,
    },
    additionalOptions: {
      type: "object",
      label: "Additional Options",
      description: "Additional parameters to set for the contact. [See the documentation](https://developers.ringcentral.com/api-reference/External-Contacts/createContact) for all available parameters. Values will be parsed as JSON where applicable. Example: `{ \"notes\": \"Notes for the contact\" }`",
      optional: true,
    },
  },
  methods: {
    createContact({
      accountId, extensionId, ...args
    }) {
      return this.ringcentral.makeRequest({
        method: "POST",
        path: `/account/${accountId}/extension/${extensionId}/address-book/contact`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const { // eslint-disable-next-line no-unused-vars
      ringcentral, createContact, accountId, extensionId, additionalOptions, ...data
    } = this;

    const response =
      await createContact({
        $,
        accountId,
        extensionId,
        data: {
          ...data,
          ...(additionalOptions && utils.parseObjectEntries(additionalOptions)),
        },
      });

    $.export("$summary", `Successfully created contact (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
RingCentral	`ringcentral`	`app`	This component uses the RingCentral app.
Account ID	`accountId`	`string`	Internal identifier of a RingCentral account or tilde (`~`) to indicate the account logged-in within the current session.
Extensions	`extensionId`	`string[]`	Select a value from the drop down menu.
Email	`email`	`string`	Email address of the contact
First Name	`firstName`	`string`	First name of the contact
Last Name	`lastName`	`string`	Last name of the contact
Mobile Phone	`mobilePhone`	`string`	Mobile phone of the contact
Additional Options	`additionalOptions`	`object`	Additional parameters to set for the contact. See the documentation for all available parameters. Values will be parsed as JSON where applicable. Example: `{ "notes": "Notes for the contact" }`

Action Authentication#

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

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

Create Contact with RingCentral API on New Ticket from Gorgias API

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

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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