Generate Access Token with LiveKit API on New Pub/Sub Messages from Google Cloud API

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

Trigger workflow on

New Pub/Sub Messages from the Google Cloud API

Next, do this

Generate Access Token with the LiveKit 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 Google Cloud trigger and LiveKit action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Pub/Sub Messages trigger
1. Connect your Google Cloud account
2. Select a Type
Configure the Generate Access Token action
1. Connect your LiveKit account
2. Optional- Select a Room Name
3. Optional- Configure Token TTL (seconds)
4. Optional- Configure Participant Name
5. Configure Participant Identity
6. Optional- Configure Participant Metadata
7. Optional- Configure Can Publish
8. Optional- Configure Can Subscribe
9. Optional- Configure Can Publish Data
10. Optional- Configure Hidden Participant
11. Optional- Configure Room Create Permission
12. Optional- Configure Room List Permission
13. Optional- Configure Room Record Permission
14. Optional- Configure Room Admin Permission
15. Optional- Configure Ingress Admin Permission
16. Optional- Configure Can Update Own Metadata
17. Optional- Configure Recorder
18. Optional- Configure Agent
19. Optional- Configure Can Subscribe Metrics
20. Optional- Configure Destination Room
21. Optional- Configure Create Room If Not Exists
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 Pub/Sub Messages on Google Cloud

Description:Emit new Pub/Sub topic in your GCP account. Messages published to this topic are emitted from the Pipedream source.

Version:0.1.6

Key:google_cloud-new-pubsub-messages

View on GitHub

Google Cloud Overview#

The Google Cloud API opens a world of possibilities for enhancing cloud operations and automating tasks. It empowers you to manage, scale, and fine-tune various services within the Google Cloud Platform (GCP) programmatically. With Pipedream, you can harness this power to create intricate workflows, trigger cloud functions based on events from other apps, manage resources, and analyze data, all in a serverless environment. The ability to interconnect GCP services with numerous other apps enriches automation, making it easier to synchronize data, streamline development workflows, and deploy applications efficiently.

Trigger Code#

import { PubSub } from "@google-cloud/pubsub";
import googleCloud from "../../google_cloud.app.mjs";

export default {
  key: "google_cloud-new-pubsub-messages",
  name: "New Pub/Sub Messages",
  description: "Emit new Pub/Sub topic in your GCP account. Messages published to this topic are emitted from the Pipedream source.",
  version: "0.1.6",
  type: "source",
  dedupe: "unique", // Dedupe on Pub/Sub message ID
  props: {
    googleCloud,
    http: "$.interface.http",
    db: "$.service.db",
    topicType: {
      type: "string",
      label: "Type",
      description: "Do you have an existing Pub/Sub topic, or would you like to create a new one?",
      options: [
        "existing",
        "new",
      ],
      reloadProps: true,
    },
  },
  async additionalProps() {
    const topic = {
      type: "string",
      label: "Pub/Sub Topic Name",
      description: "Select a Pub/Sub topic from your GCP account to watch",
      options: async () => {
        return this.getTopics();
      },
    };
    if (this.topicType === "new") {
      topic.description = "**Pipedream will create a Pub/Sub topic with this name in your account**, converting it to a [valid Pub/Sub topic name](https://cloud.google.com/pubsub/docs/admin#resource_names).";
      delete topic.options;
    }
    return {
      topic,
    };
  },
  methods: {
    _getTopicName() {
      return this.db.get("topicName");
    },
    _setTopicName(topicName) {
      this.db.set("topicName", topicName);
    },
    _getSubscriptionName() {
      return this.db.get("subscriptionName");
    },
    _setSubscriptionName(subscriptionName) {
      this.db.set("subscriptionName", subscriptionName);
    },
    async getTopics() {
      const sdkParams = this.googleCloud.sdkParams();
      const pubSubClient = new PubSub(sdkParams);
      const topics = (await pubSubClient.getTopics())[0];
      if (topics.length > 0) {
        return topics.map((topic) => topic.name);
      }
      return [];
    },
    convertNameToValidPubSubTopicName(name) {
      // For valid names, see https://cloud.google.com/pubsub/docs/admin#resource_names
      return name
        // Must not start with `goog`. We add a `pd-` at the beginning if that's the case.
        .replace(/(^goog.*)/g, "pd-$1")
        // Must start with a letter, otherwise we add `pd-` at the beginning.
        .replace(/^(?![a-zA-Z]+)/, "pd-")
        // Only certain characters are allowed, the rest will be replaced with a `-`.
        .replace(/[^a-zA-Z0-9_\-.~+%]+/g, "-");
    },
  },
  hooks: {
    async activate() {
      const sdkParams = this.googleCloud.sdkParams();
      const pubSubClient = new PubSub(sdkParams);

      const currentTopic = {
        name: this.topic,
      };
      if (this.topicType === "new") {
        const topicName = this.convertNameToValidPubSubTopicName(this.topic);
        console.log(`Creating Pub/Sub topic ${topicName}`);
        const [
          topic,
        ] = await pubSubClient.createTopic(topicName);
        currentTopic.name = topic.name;
      }
      this._setTopicName(currentTopic.name);

      const pushEndpoint = this.http.endpoint;
      const subscriptionName = this.convertNameToValidPubSubTopicName(pushEndpoint);
      const subscriptionOptions = {
        pushConfig: {
          pushEndpoint,
        },
      };
      console.log(
        `Subscribing this source's URL to the Pub/Sub topic: ${pushEndpoint}
        (under name ${subscriptionName}).`,
      );
      const [
        subscriptionResult,
      ] = await pubSubClient
        .topic(currentTopic.name)
        .createSubscription(subscriptionName, subscriptionOptions);
      this._setSubscriptionName(subscriptionResult.name);
    },
    async deactivate() {
      const sdkParams = this.googleCloud.sdkParams();
      const pubSubClient = new PubSub(sdkParams);

      const subscriptionName = this._getSubscriptionName();
      if (subscriptionName) {
        await pubSubClient.subscription(subscriptionName).delete();
      }

      if (this.topicType === "new") {
        const topicName = this._getTopicName();
        if (topicName) {
          await pubSubClient.topic(topicName).delete();
        }
      }
    },
  },
  async run(event) {
    const {
      data,
      messageId,
      publishTime,
    } = event.body.message;

    if (!data) {
      console.warn("No message present, exiting");
      return;
    }
    const dataString = Buffer.from(data, "base64").toString("utf-8");
    const metadata = {
      id: messageId,
      summary: dataString,
      ts: +new Date(publishTime),
    };

    let dataObj;
    try {
      dataObj = JSON.parse(dataString);
    } catch (err) {
      console.error(
        `Couldn't parse message as JSON. Emitting raw message. Error: ${err}`,
      );
      dataObj = {
        rawMessage: dataString,
      };
    }
    this.$emit(dataObj, metadata);
  },
};

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
Google Cloud	`googleCloud`	`app`	This component uses the Google Cloud 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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Type	`topicType`	`string`	Select a value from the drop down menu:`existingnew`

Trigger Authentication#

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

Create a service account in GCP and set the permissions you need for Pipedream workflows.
Generate a service account key
Download the key details in JSON format
Upload the key below.

About Google Cloud#

The Google Cloud Platform, including BigQuery

Action#

Generate Access Token on LiveKit

Description:Generate an access token for a participant to join a LiveKit room. [See the documentation](https://github.com/livekit/node-sdks/tree/main/packages/livekit-server-sdk).

Version:0.0.1

Key:livekit-generate-access-token

View on GitHub

Action Code#

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

export default {
  key: "livekit-generate-access-token",
  name: "Generate Access Token",
  description: "Generate an access token for a participant to join a LiveKit room. [See the documentation](https://github.com/livekit/node-sdks/tree/main/packages/livekit-server-sdk).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    room: {
      description: "The name of the room to join",
      optional: true,
      propDefinition: [
        app,
        "room",
      ],
    },
    ttl: {
      type: "integer",
      label: "Token TTL (seconds)",
      description: "How long the access token should be valid for (in seconds)",
      optional: true,
    },
    name: {
      type: "string",
      label: "Participant Name",
      description: "Display name for the participant",
      optional: true,
    },
    identity: {
      type: "string",
      label: "Participant Identity",
      description: "Unique identity for the participant joining the call",
    },
    metadata: {
      type: "string",
      label: "Participant Metadata",
      description: "Optional metadata to attach to the participant",
      optional: true,
    },
    canPublish: {
      type: "boolean",
      label: "Can Publish",
      description: "Whether the participant can publish audio/video tracks",
      optional: true,
    },
    canSubscribe: {
      type: "boolean",
      label: "Can Subscribe",
      description: "Whether the participant can subscribe to other participants' tracks",
      optional: true,
    },
    canPublishData: {
      type: "boolean",
      label: "Can Publish Data",
      description: "Whether the participant can publish data messages",
      optional: true,
    },
    hidden: {
      type: "boolean",
      label: "Hidden Participant",
      description: "Whether the participant should be hidden from other participants",
      optional: true,
    },
    roomCreate: {
      type: "boolean",
      label: "Room Create Permission",
      description: "Permission to create rooms",
      optional: true,
    },
    roomList: {
      type: "boolean",
      label: "Room List Permission",
      description: "Permission to list rooms",
      optional: true,
    },
    roomRecord: {
      type: "boolean",
      label: "Room Record Permission",
      description: "Permission to start a recording",
      optional: true,
    },
    roomAdmin: {
      type: "boolean",
      label: "Room Admin Permission",
      description: "Permission to control the specific room",
      optional: true,
    },
    ingressAdmin: {
      type: "boolean",
      label: "Ingress Admin Permission",
      description: "Permission to control ingress, not specific to any room or ingress",
      optional: true,
    },
    canUpdateOwnMetadata: {
      type: "boolean",
      label: "Can Update Own Metadata",
      description: "Allow participant to update its own metadata",
      optional: true,
    },
    recorder: {
      type: "boolean",
      label: "Recorder",
      description: "Participant is recording the room, allows room to indicate it's being recorded",
      optional: true,
    },
    agent: {
      type: "boolean",
      label: "Agent",
      description: "Participant allowed to connect to LiveKit as Agent Framework worker",
      optional: true,
    },
    canSubscribeMetrics: {
      type: "boolean",
      label: "Can Subscribe Metrics",
      description: "Allow participant to subscribe to metrics",
      optional: true,
    },
    destinationRoom: {
      type: "string",
      label: "Destination Room",
      description: "Destination room which this participant can forward to",
      optional: true,
    },
    createRoomIfNotExists: {
      type: "boolean",
      label: "Create Room If Not Exists",
      description: "Whether to create the room if it doesn't exist",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      app,
      ttl,
      identity,
      name,
      metadata,
      room,
      createRoomIfNotExists,
      canPublish,
      canSubscribe,
      canPublishData,
      hidden,
      roomCreate,
      roomList,
      roomRecord,
      roomAdmin,
      ingressAdmin,
      canUpdateOwnMetadata,
      recorder,
      agent,
      canSubscribeMetrics,
      destinationRoom,
    } = this;

    // Create room if it doesn't exist and option is enabled
    if (createRoomIfNotExists) {
      await app.createRoom({
        name: room,
      });
    }

    // Create access token for the participant
    const response = await app.createAccessToken({
      identity,
      name,
      metadata,
      ttl,
      grant: {
        roomJoin: true,
        room,
        roomCreate,
        roomList,
        roomRecord,
        roomAdmin,
        ingressAdmin,
        canPublish,
        canSubscribe,
        canPublishData,
        canUpdateOwnMetadata,
        hidden,
        recorder,
        agent,
        canSubscribeMetrics,
        destinationRoom,
      },
    });

    $.export("$summary", "Successfully generated access token for participant to join the call.");

    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
LiveKit	`app`	`app`	This component uses the LiveKit app.
Room Name	`room`	`string`	Select a value from the drop down menu.
Token TTL (seconds)	`ttl`	`integer`	How long the access token should be valid for (in seconds)
Participant Name	`name`	`string`	Display name for the participant
Participant Identity	`identity`	`string`	Unique identity for the participant joining the call
Participant Metadata	`metadata`	`string`	Optional metadata to attach to the participant
Can Publish	`canPublish`	`boolean`	Whether the participant can publish audio/video tracks
Can Subscribe	`canSubscribe`	`boolean`	Whether the participant can subscribe to other participants' tracks
Can Publish Data	`canPublishData`	`boolean`	Whether the participant can publish data messages
Hidden Participant	`hidden`	`boolean`	Whether the participant should be hidden from other participants
Room Create Permission	`roomCreate`	`boolean`	Permission to create rooms
Room List Permission	`roomList`	`boolean`	Permission to list rooms
Room Record Permission	`roomRecord`	`boolean`	Permission to start a recording
Room Admin Permission	`roomAdmin`	`boolean`	Permission to control the specific room
Ingress Admin Permission	`ingressAdmin`	`boolean`	Permission to control ingress, not specific to any room or ingress
Can Update Own Metadata	`canUpdateOwnMetadata`	`boolean`	Allow participant to update its own metadata
Recorder	`recorder`	`boolean`	Participant is recording the room, allows room to indicate it's being recorded
Agent	`agent`	`boolean`	Participant allowed to connect to LiveKit as Agent Framework worker
Can Subscribe Metrics	`canSubscribeMetrics`	`boolean`	Allow participant to subscribe to metrics
Destination Room	`destinationRoom`	`string`	Destination room which this participant can forward to
Create Room If Not Exists	`createRoomIfNotExists`	`boolean`	Whether to create the room if it doesn't exist

Action 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,