Add New Call with Gong API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Add New Call with the Gong 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 Gong 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 Add New Call action
1. Connect your Gong account
2. Configure Client Unique ID
3. Configure Actual Start
4. Select a Direction
5. Select a Primary User
6. Configure Parties
7. Optional- Configure Title
8. Optional- Configure Purpose
9. Optional- Configure Scheduled Start
10. Optional- Configure Scheduled End
11. Optional- Configure Duration
12. Optional- Configure Disposition
13. Optional- Configure Meeting URL
14. Optional- Select a Call Provider Code
15. Optional- Configure Download Media URL
16. Optional- Select a Workspace ID
17. Optional- Select a Language Code
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#

Add New Call on Gong

Description:Add a new call. [See the documentation](https://us-66463.app.gong.io/settings/api/documentation#post-/v2/calls)

Version:0.0.2

Key:gong-add-new-call

View on GitHub

Gong Overview#

The Gong API allows you to tap into Gong's conversation intelligence capabilities, enabling you to retrieve call recordings, transcripts, and analytics data for sales engagements. By integrating Gong with Pipedream, you can automate workflows that react to this sales data, enrich CRM records, trigger follow-up actions, and sync insights across your sales stack. It's a goldmine for sales teams looking to leverage conversational insights and make data-driven decisions.

Action Code#

import app from "../../gong.app.mjs";
import LANGS from "../../common/languages.mjs";
import constants from "../../common/constants.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "gong-add-new-call",
  name: "Add New Call",
  description: "Add a new call. [See the documentation](https://us-66463.app.gong.io/settings/api/documentation#post-/v2/calls)",
  type: "action",
  version: "0.0.2",
  props: {
    app,
    clientUniqueId: {
      type: "string",
      label: "Client Unique ID",
      description: "A call's unique identifier in the PBX or the recording system. Gong uses this identifier to prevent repeated attempts to upload the same recording.",
    },
    actualStart: {
      type: "string",
      label: "Actual Start",
      description: "The actual date and time when the call started in the ISO-8601 format (e.g., `2018-02-18T02:30:00-07:00` or `2018-02-18T08:00:00Z`, where Z stands for UTC).",
    },
    direction: {
      type: "string",
      label: "Direction",
      description: "Whether the call is inbound (someone called the company), outbound (a rep dialed someone outside the company), or a conference call.",
      options: constants.DIRECTIONS,
    },
    primaryUser: {
      label: "Primary User",
      description: "The Gong internal user ID of the team member who hosted the call.",
      propDefinition: [
        app,
        "userId",
      ],
    },
    parties: {
      type: "string[]",
      label: "Parties",
      description: "A list of the call's participants. A party must be provided for the **Primary User**. Each party can have a JSON stucture like this example: `{ \"phoneNumber\": \"123123\", \"emailAddress\": \"email@example.com\", \"name\": \"Name\", \"mediaChannelId\": \"1\" }`",
    },
    title: {
      type: "string",
      label: "Title",
      description: "The title of the call. This title is available in the Gong system for indexing and search.",
      optional: true,
    },
    purpose: {
      type: "string",
      label: "Purpose",
      description: "The purpose of the call. This optional field is a free text of up to 255 characters.",
      optional: true,
    },
    scheduledStart: {
      type: "string",
      label: "Scheduled Start",
      description: "The date and time the call was scheduled to begin in the ISO-8601 format (e.g., `2018-02-18T02:30:00-07:00` or `2018-02-18T08:00:00Z`, where Z stands for UTC);",
      optional: true,
    },
    scheduledEnd: {
      type: "string",
      label: "Scheduled End",
      description: "The date and time the call was scheduled to end in the ISO-8601 format (e.g., `2018-02-18T02:30:00-07:00` or `2018-02-18T08:00:00Z`, where Z stands for UTC);",
      optional: true,
    },
    duration: {
      type: "integer",
      label: "Duration",
      description: "The actual call duration in seconds.",
      optional: true,
    },
    disposition: {
      type: "string",
      label: "Disposition",
      description: "The disposition of the call. The disposition is free text of up to 255 characters.",
      optional: true,
    },
    meetingUrl: {
      type: "string",
      label: "Meeting URL",
      description: "The URL of the conference call by which users join the meeting",
      optional: true,
    },
    callProviderCode: {
      type: "string",
      label: "Call Provider Code",
      description: "The code identifies the provider conferencing or telephony system. For example: `zoom`, `clearslide`, `gotomeeting`, `ringcentral`, `outreach`, `insidesales`, etc. These values are predefined by Gong, please contact help@gong.io to find the proper value for your system.",
      optional: true,
      options: constants.CALL_PROVIDER_CODES,
    },
    downloadMediaUrl: {
      type: "string",
      label: "Download Media URL",
      description: "The URL from which Gong can download the media file. The URL must be unique, the audio or video file must be a maximum of 1.5GB. If you provide this URL, you should not perform the **Add call media** step.",
      optional: true,
    },
    workspaceId: {
      description: "Optional workspace identifier. If specified, the call will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied.",
      optional: true,
      propDefinition: [
        app,
        "workspaceId",
      ],
    },
    languageCode: {
      type: "string",
      label: "Language Code",
      description: "The language code the call should be transcribed to. This field is optional as Gong automatically detects the language spoken in the call and transcribes it accordingly. Set this field only if you are sure of the language the call is in.",
      optional: true,
      options: LANGS,
    },
  },
  methods: {
    addNewCall(args = {}) {
      return this.app.post({
        path: "/calls",
        ...args,
      });
    },
    getParties() {
      const {
        primaryUser,
        parties,
      } = this;

      return utils.parseArray(parties)
        .map((party) => {
          const parsed = utils.parse(party);
          return {
            ...parsed,
            userId: primaryUser,
          };
        });
    },
  },
  run({ $: step }) {
    const {
      // eslint-disable-next-line no-unused-vars
      app,
      getParties,
      addNewCall,
      ...data
    } = this;

    return addNewCall({
      step,
      data: {
        ...data,
        parties: getParties(),
      },
      summary: (response) => `Successfully added call with request ID \`${response.requestId}\``,
    });
  },
};

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
Gong	`app`	`app`	This component uses the Gong app.
Client Unique ID	`clientUniqueId`	`string`	A call's unique identifier in the PBX or the recording system. Gong uses this identifier to prevent repeated attempts to upload the same recording.
Actual Start	`actualStart`	`string`	The actual date and time when the call started in the ISO-8601 format (e.g., `2018-02-18T02:30:00-07:00` or `2018-02-18T08:00:00Z`, where Z stands for UTC).
Direction	`direction`	`string`	Select a value from the drop down menu:`InboundOutboundConferenceUnknown`
Primary User	`primaryUser`	`string`	Select a value from the drop down menu.
Parties	`parties`	`string[]`	A list of the call's participants. A party must be provided for the Primary User. Each party can have a JSON stucture like this example: `{ "phoneNumber": "123123", "emailAddress": "email@example.com", "name": "Name", "mediaChannelId": "1" }`
Title	`title`	`string`	The title of the call. This title is available in the Gong system for indexing and search.
Purpose	`purpose`	`string`	The purpose of the call. This optional field is a free text of up to 255 characters.
Scheduled Start	`scheduledStart`	`string`	The date and time the call was scheduled to begin in the ISO-8601 format (e.g., `2018-02-18T02:30:00-07:00` or `2018-02-18T08:00:00Z`, where Z stands for UTC);
Scheduled End	`scheduledEnd`	`string`	The date and time the call was scheduled to end in the ISO-8601 format (e.g., `2018-02-18T02:30:00-07:00` or `2018-02-18T08:00:00Z`, where Z stands for UTC);
Duration	`duration`	`integer`	The actual call duration in seconds.
Disposition	`disposition`	`string`	The disposition of the call. The disposition is free text of up to 255 characters.
Meeting URL	`meetingUrl`	`string`	The URL of the conference call by which users join the meeting
Call Provider Code	`callProviderCode`	`string`	Select a value from the drop down menu:`zoomclearslidegotomeetingringcentraloutreachinsidesales`
Download Media URL	`downloadMediaUrl`	`string`	The URL from which Gong can download the media file. The URL must be unique, the audio or video file must be a maximum of 1.5GB. If you provide this URL, you should not perform the Add call media step.
Workspace ID	`workspaceId`	`string`	Select a value from the drop down menu.
Language Code	`languageCode`	`string`	Select a value from the drop down menu:`af-ZAam-ETar-AEar-BHar-DZar-EGar-ILar-IQar-JOar-KWar-LBar-MAar-MRar-OMar-PSar-QAar-SAar-TNar-YEaz-AZbg-BGbn-BDbn-INbs-BAca-EScs-CZda-DKde-ATde-CHde-DEel-GRen-ABen-AUen-CAen-GBen-IEen-INen-NZen-PHen-SGen-USen-WLen-ZAes-ARes-BOes-CLes-COes-CRes-DOes-ECes-ESes-GTes-HNes-MXes-NIes-PAes-PEes-PRes-PYes-SVes-USes-UYet-EEeu-ESfa-IRfi-FIfil-PHfr-BEfr-CAfr-CHfr-FRgl-ESgu-INhe-ILhi-INhr-HRhu-HUhy-AMid-IDis-ISit-CHit-ITja-JPjv-IDka-GEkk-KZkm-KHkn-INko-KRlo-LAlt-LTlv-LVmk-MKml-INmn-MNmr-INms-MYmy-MMne-NPnl-BEnl-NLno-NOpa-Guru-INpl-PLpt-BRpt-PTro-ROru-RUsi-LKsk-SKsl-SIsq-ALsr-RSsu-IDsv-SEsw-KEsw-TZta-INta-LKta-MYta-SGte-INth-THtr-TRuk-UAur-INur-PKuz-UZvi-VNyue-Hant-HKzh-CNzh-TWzu-ZA`

Action Authentication#

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

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

api:calls:read:basicapi:calls:createapi:users:readapi:crm:integrations:readapi:library:readapi:data-privacy:readapi:users:readapi:meetings:user:createapi:engagement-data:writeapi:workspaces:readapi:calls:read:transcript

About Gong#

The Revenue Intelligence Platform

More Ways to Connect Gong + Pipedream#

Other Popular Integrations#

Retrieve Transcripts Of Calls with Gong API on New Scheduled Tasks from Pipedream API

Pipedream + Gong

Add New Call with Gong API on New Scheduled Tasks from Pipedream API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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