Execute Runbook with Airplane API on New Inbound Call (Instant) from RingCentral API

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

Trigger workflow on

New Inbound Call (Instant) from the RingCentral API

Next, do this

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

Select this integration
Configure the New Inbound Call (Instant) trigger
1. Connect your RingCentral account
2. Select one or more Extensions
Configure the Execute Runbook action
1. Connect your Airplane account
2. Optional- Configure Runbook ID
3. Optional- Configure Slug
4. Optional- Configure Parameter Values
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 Inbound Call (Instant) on RingCentral

Description:Emit new event on each incoming call

Version:0.1.5

Key:ringcentral-new-inbound-call

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.

Trigger Code#

import common from "../common/http-based.mjs";

export default {
  ...common,
  key: "ringcentral-new-inbound-call",
  name: "New Inbound Call (Instant)",
  description: "Emit new event on each incoming call",
  version: "0.1.5",
  type: "source",
  props: {
    ...common.props,
    extensionId: {
      propDefinition: [
        common.props.ringcentral,
        "extensionId",
      ],
    },
  },
  methods: {
    ...common.methods,
    getSupportedNotificationTypes() {
      return new Set([
        "ringcentral-extension-telephony-sessions-event-inbound-call",
      ]);
    },
    getPropValues() {
      return {
        extensionId: this.extensionId,
      };
    },
    generateMeta(data) {
      const {
        timestamp,
        body: eventDetails,
      } = data;
      const { telephonySessionId: id } = eventDetails;
      const { from: { phoneNumber: callerPhoneNumber } } = eventDetails.parties[0];

      const maskedCallerNumber = this.getMaskedNumber(callerPhoneNumber);
      const summary = `New inbound call from ${maskedCallerNumber}`;
      const ts = Date.parse(timestamp);

      return {
        id,
        summary,
        ts,
      };
    },
    isEventRelevant(event) {
      const { body: eventDetails } = event.body;
      const { status: { code: statusCode } } = eventDetails.parties[0];
      return [
        "Setup",
        "Proceeding",
        "Answered",
      ].includes(statusCode);
    },
  },
};

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
RingCentral	`ringcentral`	`app`	This component uses the RingCentral 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.
Extensions	`extensionId`	`string[]`	Select a value from the drop down menu.

Trigger 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:

About RingCentral#

Experience Intelligent Phone, Meetings, Contact Center, and AI Solutions with RingCentral, the complete cloud communications platform.

Action#

Execute Runbook on Airplane

Description:Execute a runbook and receive a session ID to track the runbook's execution. [See the documentation](https://docs.airplane.dev/reference/api#runbooks-execute)

Version:0.0.1

Key:airplane-execute-runbook

View on GitHub

Airplane Overview#

The Airplane API facilitates the creation and management of tasks and runs within the Airplane toolkit, which is geared towards automating developer operations and internal tools. In Pipedream, you can leverage this API to automate workflows, integrate with various services, and handle background tasks. By connecting Airplane to other apps on Pipedream, you can streamline processes like deploying code, managing feature flags, or orchestrating complex workflows that interact with other APIs and services.

Action Code#

import airplane from "../../airplane.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "airplane-execute-runbook",
  name: "Execute Runbook",
  description: "Execute a runbook and receive a session ID to track the runbook's execution. [See the documentation](https://docs.airplane.dev/reference/api#runbooks-execute)",
  version: "0.0.1",
  type: "action",
  props: {
    airplane,
    id: {
      type: "string",
      label: "Runbook ID",
      description: "Unique ID of the runbook. You can find your runbook's ID by visiting the runbook's page on Airplane. The runbook ID is located at the end of the url. e.g. the runbook ID for `https://app.airplane.dev/runbooks/rbk20220120z15kl79` is `rbk20220120z15kl79`",
      optional: true,
    },
    slug: {
      type: "string",
      label: "Slug",
      description: "Unique slug of the runbook. You can find your runbook's slug next to the runbook's name within the runbook editor on Airplane. Either an ID or a slug must be provided.`",
      optional: true,
    },
    paramValues: {
      type: "object",
      label: "Parameter Values",
      description: "Mapping of parameter slug to value. You can find your runbooks's parameter slugs inside the runbook editor on Airplane.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.id && !this.slug) {
      throw new ConfigurationError("Either an ID or a slug must be provided.");
    }

    const response = await this.airplane.executeRunbook({
      data: {
        id: this.id,
        slug: this.slug,
        paramValues: this.paramValues,
      },
      $,
    });

    if (response) {
      $.export("$summary", "Successfully executed runbook.");
    }

    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
Airplane	`airplane`	`app`	This component uses the Airplane app.
Runbook ID	`id`	`string`	Unique ID of the runbook. You can find your runbook's ID by visiting the runbook's page on Airplane. The runbook ID is located at the end of the url. e.g. the runbook ID for `https://app.airplane.dev/runbooks/rbk20220120z15kl79` is `rbk20220120z15kl79`
Slug	`slug`	`string`	Unique slug of the runbook. You can find your runbook's slug next to the runbook's name within the runbook editor on Airplane. Either an ID or a slug must be provided.`
Parameter Values	`paramValues`	`object`	Mapping of parameter slug to value. You can find your runbooks's parameter slugs inside the runbook editor on Airplane.

Execute Runbook with Airplane API on New Inbound Call (Instant) from RingCentral API

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

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

Developers ♥ Pipedream

1-24of2,800+apps by most popular

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