Generate Access Token with LiveKit API on New Message In Channels (Instant) from Slack API

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

Trigger workflow on

New Message In Channels (Instant) from the Slack 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 Slack 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 Message In Channels (Instant) trigger
1. Connect your Slack account
2. Optional- Select one or more Channels
3. Configure slackApphook
4. Optional- Configure Resolve Names
5. Optional- Configure Ignore Bots
6. Optional- Configure Ignore replies in threads
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 Message In Channels (Instant) on Slack

Description:Emit new event when a new message is posted to one or more channels

Version:1.0.24

Key:slack-new-message-in-channels

View on GitHub

Slack Overview#

The Pipedream Slack app enables you to build event-driven workflows that interact with the Slack API. Once you authorize the Pipedream app's access to your workspace, you can use Pipedream workflows to perform common Slack actions or write your own code against the Slack API.

The Pipedream Slack app is not a typical app. You don't interact with it directly as a bot, and it doesn't add custom functionality to your workspace out of the box. It makes it easier to automate anything you'd typically use the Slack API for, using Pipedream workflows.

Automate posting updates to your team channels
Create a bot to answer common questions
Integrate with your existing tools and services
And much more!

Trigger Code#

import common from "../common/base.mjs";
import constants from "../common/constants.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "slack-new-message-in-channels",
  name: "New Message In Channels (Instant)",
  version: "1.0.24",
  description: "Emit new event when a new message is posted to one or more channels",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    conversations: {
      propDefinition: [
        common.props.slack,
        "conversation",
      ],
      type: "string[]",
      label: "Channels",
      description: "Select one or more channels to monitor for new messages.",
      optional: true,
    },
    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
    slackApphook: {
      type: "$.interface.apphook",
      appProp: "slack",
      async eventNames() {
        return this.conversations || [
          "message",
        ];
      },
    },
    resolveNames: {
      propDefinition: [
        common.props.slack,
        "resolveNames",
      ],
    },
    ignoreBot: {
      propDefinition: [
        common.props.slack,
        "ignoreBot",
      ],
    },
    ignoreThreads: {
      type: "boolean",
      label: "Ignore replies in threads",
      description: "Ignore replies to messages in threads",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "New message in channel";
    },
    async processEvent(event) {
      if (event.type !== "message") {
        console.log(`Ignoring event with unexpected type "${event.type}"`);
        return;
      }
      if (event.subtype && !constants.ALLOWED_MESSAGE_IN_CHANNEL_SUBTYPES.includes(event.subtype)) {
        // This source is designed to just emit an event for each new message received.
        // Due to inconsistencies with the shape of message_changed and message_deleted
        // events, we are ignoring them for now. If you want to handle these types of
        // events, feel free to change this code!!
        console.log("Ignoring message with subtype.");
        return;
      }
      if ((this.ignoreBot) && (event.subtype == "bot_message" || event.bot_id)) {
        return;
      }
      // There is no thread message type only the thread_ts field
      // indicates if the message is part of a thread in the event.
      if (this.ignoreThreads && event.thread_ts) {
        console.log("Ignoring reply in thread");
        return;
      }
      if (this.resolveNames) {
        if (event.user) {
          event.user_id = event.user;
          event.user = await this.getUserName(event.user);
        } else if (event.bot_id) {
          event.bot = await this.getBotName(event.bot_id);
        }
        event.channel_id = event.channel;
        event.channel = await this.getConversationName(event.channel);
        if (event.team) {
          event.team_id = event.team;
          event.team = await this.getTeamName(event.team);
        }
      }
      return 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
Slack	`slack`	`app`	This component uses the Slack app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Channels	`conversations`	`string[]`	Select a value from the drop down menu.
	`slackApphook`	`$.interface.apphook`
Resolve Names	`resolveNames`	`boolean`	Instead of returning `channel`, `team`, and `user` as IDs, return their human-readable names.
Ignore Bots	`ignoreBot`	`boolean`	Ignore messages from bots
Ignore replies in threads	`ignoreThreads`	`boolean`	Ignore replies to messages in threads

Trigger Authentication#

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

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

channels:historychannels:readchannels:writeemoji:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writereactions:readreactions:writereminders:readreminders:writestars:readteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:userfiles:write:usercommandsusers.profile:writeusers.profile:readsearch:read

About Slack#

Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

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,

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

Generate Access Token with LiveKit API on New Message In Channels (Instant) from Slack API

Pipedream makes it easy to connect APIs for LiveKit, Slack 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