Create Contact with RingCentral API on New Room Event (Instant) from LiveKit API

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

Trigger workflow on

New Room Event (Instant) from the LiveKit 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 LiveKit 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 Room Event (Instant) trigger
1. Connect your LiveKit account
2. Select one or more Event Types
3. Optional- Configure Room Name Filter
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 Room Event (Instant) on LiveKit

Description:Emit new event for LiveKit room activities via webhook. [See the documentation](https://docs.livekit.io/home/server/webhooks/).

Version:0.0.1

Key:livekit-new-room-event-instant

View on GitHub

Trigger Code#

import app from "../../livekit.app.mjs";

export default {
  key: "livekit-new-room-event-instant",
  name: "New Room Event (Instant)",
  description: "Emit new event for LiveKit room activities via webhook. [See the documentation](https://docs.livekit.io/home/server/webhooks/).",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    http: "$.interface.http",
    eventTypes: {
      type: "string[]",
      label: "Event Types",
      description: "Select which types of events to monitor",
      options: [
        {
          label: "Room Started (e.g., call initiated)",
          value: "room_started",
        },
        {
          label: "Room Finished (e.g., call ended)",
          value: "room_finished",
        },
        {
          label: "Participant Joined (e.g., call answered)",
          value: "participant_joined",
        },
        {
          label: "Participant Left (e.g., call ended)",
          value: "participant_left",
        },
        {
          label: "Track Published (e.g., video track published)",
          value: "track_published",
        },
        {
          label: "Track Unpublished (e.g., video track unpublished)",
          value: "track_unpublished",
        },
        {
          label: "Egress Started (e.g., egress started for recording or streaming)",
          value: "egress_started",
        },
        {
          label: "Egress Updated (e.g., egress updated for recording or streaming)",
          value: "egress_updated",
        },
        {
          label: "Egress Ended (e.g., egress ended for recording or streaming)",
          value: "egress_ended",
        },
        {
          label: "Ingress Started (e.g., ingress started for recording or streaming)",
          value: "ingress_started",
        },
        {
          label: "Ingress Ended (e.g., ingress ended for recording or streaming)",
          value: "ingress_ended",
        },
      ],
    },
    roomNameFilter: {
      type: "string",
      label: "Room Name Filter",
      description: "Only emit events for this specific room. Leave empty to monitor all rooms.",
      optional: true,
    },
  },
  methods: {
    shouldEmitEvent({
      event, room,
    }) {
      // Check if event type is in our filter
      if (!this.eventTypes.includes(event)) {
        return false;
      }

      // Filter by room if specified, with case-insensitive comparison
      if (this.roomNameFilter
        && room?.name?.toLowerCase() !== this.roomNameFilter.toLowerCase()) {
        return false;
      }

      return true;
    },
    generateSummary(event) {
      const room = event.room?.name || "Unknown room";

      switch (event.event) {
      case "room_started":
        return `Room started: ${room}`;
      case "room_finished":
        return `Room finished: ${room}`;
      case "participant_joined": {
        const joinedParticipant = event.participant?.identity || "Unknown";
        return `${joinedParticipant} joined room: ${room}`;
      }
      case "participant_left": {
        const leftParticipant = event.participant?.identity || "Unknown";
        return `${leftParticipant} left room: ${room}`;
      }
      case "track_published": {
        const publishedBy = event.participant?.identity || "Unknown";
        const trackType = event.track?.type || "track";
        return `${publishedBy} published ${trackType} in room: ${room}`;
      }
      case "track_unpublished": {
        const unpublishedBy = event.participant?.identity || "Unknown";
        const unpublishedTrackType = event.track?.type || "track";
        return `${unpublishedBy} unpublished ${unpublishedTrackType} in room: ${room}`;
      }
      case "egress_started": {
        const egressId = event.egressInfo?.egressId || "Unknown";
        return `Egress started (${egressId}) in room: ${room}`;
      }
      case "egress_updated": {
        const egressId = event.egressInfo?.egressId || "Unknown";
        return `Egress updated (${egressId}) in room: ${room}`;
      }
      case "egress_ended": {
        const egressId = event.egressInfo?.egressId || "Unknown";
        return `Egress ended (${egressId}) in room: ${room}`;
      }
      case "ingress_started": {
        const ingressId = event.ingressInfo?.ingressId || "Unknown";
        return `Ingress started (${ingressId}) in room: ${room}`;
      }
      case "ingress_ended": {
        const ingressId = event.ingressInfo?.ingressId || "Unknown";
        return `Ingress ended (${ingressId}) in room: ${room}`;
      }
      default:
        return `${event.event} in room: ${room}`;
      }
    },
  },
  async run({
    headers, bodyRaw,
  }) {
    if (!headers.authorization) {
      throw new Error("Missing Authorization header");
    }

    const webhookEvent = await this.app.verifyWebhook(bodyRaw, headers.authorization);

    if (this.shouldEmitEvent(webhookEvent)) {
      this.$emit(webhookEvent, {
        id: webhookEvent.id,
        summary: this.generateSummary(webhookEvent),
        ts: parseInt(webhookEvent.createdAt) * 1000,
      });
    }
  },
};

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
LiveKit	`app`	`app`	This component uses the LiveKit app.
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.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu:`{ "label": "Room Started (e.g., call initiated)", "value": "room_started" }{ "label": "Room Finished (e.g., call ended)", "value": "room_finished" }{ "label": "Participant Joined (e.g., call answered)", "value": "participant_joined" }{ "label": "Participant Left (e.g., call ended)", "value": "participant_left" }{ "label": "Track Published (e.g., video track published)", "value": "track_published" }{ "label": "Track Unpublished (e.g., video track unpublished)", "value": "track_unpublished" }{ "label": "Egress Started (e.g., egress started for recording or streaming)", "value": "egress_started" }{ "label": "Egress Updated (e.g., egress updated for recording or streaming)", "value": "egress_updated" }{ "label": "Egress Ended (e.g., egress ended for recording or streaming)", "value": "egress_ended" }{ "label": "Ingress Started (e.g., ingress started for recording or streaming)", "value": "ingress_started" }{ "label": "Ingress Ended (e.g., ingress ended for recording or streaming)", "value": "ingress_ended" }`
Room Name Filter	`roomNameFilter`	`string`	Only emit events for this specific room. Leave empty to monitor all rooms.

Trigger Authentication#

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

To retrieve your API Key, Secret Key and Project URL,

Navigate to your LiveKit account and sign in
Go to “Settings” > "Project" for Project URL
Go to “Settings” > "Keys" for API Key and Secret Key

About LiveKit#

Build realtime AI. Instantly transport audio + video between LLMs and your users.

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 Room Event (Instant) from LiveKit API

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

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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