Create User with MX Technologies API on New Room Event (Instant) from LiveKit API

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

Trigger workflow on

New Room Event (Instant) from the LiveKit API

Next, do this

Create User with the MX Technologies 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 MX Technologies 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 User action
1. Connect your MX Technologies account
2. Configure Email
3. Optional- Configure ID
4. Optional- Configure Is Disabled
5. Optional- Configure Metadata
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 User on MX Technologies

Description:Creates a new user in the MX Technologies platform. [See the documentation](https://docs.mx.com/api-reference/platform-api/reference/create-user)

Version:0.0.1

Key:mx_technologies-create-user

View on GitHub

MX Technologies Overview#

The MX Technologies API provides a range of financial data solutions, enabling users to obtain insights into personal finances, conduct risk analysis, and offer personalized financial advice. Within Pipedream, you can harness the power of the MX API to automate financial data aggregation, customer profiling, and trigger custom workflows based on financial events or changes in user data.

Action Code#

import mxTechnologies from "../../mx_technologies.app.mjs";

export default {
  key: "mx_technologies-create-user",
  name: "Create User",
  description: "Creates a new user in the MX Technologies platform. [See the documentation](https://docs.mx.com/api-reference/platform-api/reference/create-user)",
  version: "0.0.1",
  type: "action",
  props: {
    mxTechnologies,
    email: {
      type: "string",
      label: "Email",
      description: "The end user's email address.",
    },
    id: {
      type: "string",
      label: "ID",
      description: "A unique, partner-defined, enforced identifier for the **user**. This value must be URL-safe. The **id** field must only contain letters, numbers, and the dash and underscore characters.",
      optional: true,
    },
    isDisabled: {
      type: "boolean",
      label: "Is Disabled",
      description: "This indicates whether the user has been disabled. Defaults to **false**.",
      optional: true,
    },
    metadata: {
      propDefinition: [
        mxTechnologies,
        "metadata",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.mxTechnologies.createUser({
      $,
      data: {
        user: {
          email: this.email,
          id: this.id,
          is_disabled: this.isDisabled,
          metadata: this.metadata && JSON.stringify(this.metadata),
        },
      },
    });
    $.export("$summary", `Successfully created user with Id: ${response.user.guid}`);
    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
MX Technologies	`mxTechnologies`	`app`	This component uses the MX Technologies app.
Email	`email`	`string`	The end user's email address.
ID	`id`	`string`	A unique, partner-defined, enforced identifier for the user. This value must be URL-safe. The id field must only contain letters, numbers, and the dash and underscore characters.
Is Disabled	`isDisabled`	`boolean`	This indicates whether the user has been disabled. Defaults to false.
Metadata	`metadata`	`object`	Additional information you can store about this user. MX recommends using JSON-structured data.