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

Pipedream makes it easy to connect APIs for Postalytics, 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 Postalytics 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 Postalytics 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 Postalytics account
2. Configure First Name
3. Configure Last Name
4. Optional- Configure Company
5. Optional- Configure Phone
6. Configure Address Street
7. Configure Address Street 2
8. Configure Address City
9. Configure Address State
10. Configure Address Zip
11. Optional- Configure Email Address
12. Optional- Configure Var Field 1
13. Optional- Configure Var Field 2
14. Optional- Configure Var Field 3
15. Optional- Configure Var Field 4
16. Optional- Configure Var Field 5
17. Optional- Configure Var Field 6
18. Optional- Configure Var Field 7
19. Optional- Configure Var Field 8
20. Optional- Configure Var Field 9
21. Optional- Configure Var Field 10
22. Select a List ID
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 Postalytics

Description:Creates a new contact in Postalytics. [See the documentation](https://postalytics.docs.apiary.io/#reference/contact-api/contact-list-collection/add-contact)

Version:0.0.1

Key:postalytics-create-contact

View on GitHub

Postalytics Overview#

The Postalytics API lets you automate direct mail marketing campaigns, manage contacts, and track results. By integrating Postalytics with Pipedream, you can build serverless workflows that leverage your marketing stack, sync data across platforms, and personalize your outreach efforts. You can trigger direct mail pieces based on customer behavior, update your CRM with mailing results, or create custom analytics dashboards.

Action Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "postalytics-create-contact",
  name: "Create Contact",
  description: "Creates a new contact in Postalytics. [See the documentation](https://postalytics.docs.apiary.io/#reference/contact-api/contact-list-collection/add-contact)",
  version: "0.0.1",
  type: "action",
  props: {
    ...common.props,
    listId: {
      propDefinition: [
        common.props.postalytics,
        "listId",
      ],
    },
  },
  methods: {
    getFn() {
      return this.postalytics.createContact;
    },
    getObject({ listId }, objToSend) {
      objToSend.data["contact_list_id"] = listId;
      return objToSend;
    },
    getSummary({
      firstName, lastName,
    }) {
      return `Successfully created contact with name: ${firstName} ${lastName}`;
    },
  },
};

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
Postalytics	`postalytics`	`app`	This component uses the Postalytics app.
First Name	`firstName`	`string`	Recipient's first name must be between 1 and 50 characters long.
Last Name	`lastName`	`string`	Recipient's last name must be between 1 and 50 characters long.
Company	`company`	`string`	If provided, can be up to 100 characters long.
Phone	`phone`	`string`	If provided, can be up to 100 characters long.
Address Street	`addressStreet`	`string`	Recipient's street, can be up to 100 characters long.
Address Street 2	`addressStreet2`	`string`	Recipient's street2, can be up to 100 characters long.
Address City	`addressCity`	`string`	Recipient's address, can be up to 100 characters long.
Address State	`addressState`	`string`	Recipient's state, must be a 2 letter state short-name code or a valid full state name.
Address Zip	`addressZip`	`string`	Recipient's zip code, must be in valid zip format.
Email Address	`emailAddress`	`string`	Recipient's email address up to 100 characters long
Var Field 1	`varField1`	`string`	Any string up to 255 characters
Var Field 2	`varField2`	`string`	Any string up to 255 characters
Var Field 3	`varField3`	`string`	Any string up to 255 characters
Var Field 4	`varField4`	`string`	Any string up to 255 characters
Var Field 5	`varField5`	`string`	Any string up to 255 characters
Var Field 6	`varField6`	`string`	Any string up to 255 characters
Var Field 7	`varField7`	`string`	Any string up to 255 characters
Var Field 8	`varField8`	`string`	Any string up to 255 characters
Var Field 9	`varField9`	`string`	Any string up to 255 characters
Var Field 10	`varField10`	`string`	Any string up to 255 characters
List ID	`listId`	`string`	Select a value from the drop down menu.