Generate Access Token with LiveKit API

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

Trigger workflow on

HTTP requests, schedules and app events

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#

Create a workflow to Generate Access Token with the LiveKit API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

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
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Generate Access Token with LiveKit API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + LiveKit

Try it

Generate Access Token with LiveKit API on New Submission from Typeform API

Typeform + LiveKit

Try it

Generate Access Token with LiveKit API on New Submission (Instant) from Jotform API

Jotform + LiveKit

Try it

Generate Access Token with LiveKit API on New Scheduled Tasks from Pipedream API

Pipedream + LiveKit

Try it

Generate Access Token with LiveKit API on New Download Counts from npm API

npm + LiveKit

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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;
  },
};

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.
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

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,