Create Message with Vitally API on New Table from PostgreSQL API

Pipedream makes it easy to connect APIs for Vitally, PostgreSQL and 2,400+ other apps remarkably fast.

Trigger workflow on

New Table from the PostgreSQL API

Next, do this

Create Message with the Vitally 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 PostgreSQL trigger and Vitally action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Table trigger
1. Connect your PostgreSQL account
2. Configure Polling Interval
3. Select a Schema
Configure the Create Message action
1. Connect your Vitally account
2. Select a Organization Id
3. Select a Conversation Id
4. Configure External Id
5. Optional- Configure Timestamp
6. Configure Message
7. Select a From
8. Select one or more To
9. Optional- Select one or more CC
10. Optional- Select one or more BCC
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 Table on PostgreSQL

Description:Emit new event when a new table is added to the database. [See the documentation](https://node-postgres.com/features/queries)

Version:2.0.6

Key:postgresql-new-table

View on GitHub

PostgreSQL Overview#

On Pipedream, you can leverage the PostgreSQL app to create workflows that automate database operations, synchronize data across platforms, and react to database events in real-time. Think handling new row entries, updating records from webhooks, or even compiling reports on a set schedule. Pipedream's serverless platform provides a powerful way to connect PostgreSQL with a variety of apps, enabling you to create tailored automation that fits your specific needs.

Trigger Code#

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

export default {
  ...common,
  name: "New Table",
  key: "postgresql-new-table",
  description: "Emit new event when a new table is added to the database. [See the documentation](https://node-postgres.com/features/queries)",
  version: "2.0.6",
  type: "source",
  props: {
    ...common.props,
    schema: {
      propDefinition: [
        common.props.postgresql,
        "schema",
      ],
    },
  },
  async run() {
    const previousTables = this._getPreviousValues() || [];

    const tables = await this.postgresql.getTables(this.schema);

    const newTables = tables.filter((table) => !previousTables.includes(table));
    for (const table of newTables) {
      const meta = this.generateMeta(table);
      this.$emit(table, meta);
    }

    this._setPreviousValues(tables);
  },
};

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
PostgreSQL	`postgresql`	`app`	This component uses the PostgreSQL app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
Schema	`schema`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

Connecting to Restricted Databases

Either enable the shared static IP for this account below, or configure a VPC to deploy any workflow in your workspace to a private network with a dedicated static IP. Learn more in our docs.

SSL Setup

Configure SSL on your PostgreSQL database by providing the CA (Certificate Authority), and choosing between Full Verification, Verify Certificate Authority (CA), or Skip Verification. Skipping verification is not recommended as this has serious security implications.

About PostgreSQL#

PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.

Action#

Create Message on Vitally

Description:Create a new message. [See the documentation](https://docs.vitally.io/pushing-data-to-vitally/rest-api/messages#create-a-message-post)

Version:0.0.2

Key:vitally-create-message

View on GitHub

Vitally Overview#

The Vitally API offers a window into customer success operations, enabling you to automate workflows, integrate with other tools, and manipulate customer data programmatically. With Pipedream, you can harness this API to create custom automations that react to events in Vitally, sync data between Vitally and other platforms, or maintain up-to-date customer profiles across your business stack.

Action Code#

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

export default {
  key: "vitally-create-message",
  name: "Create Message",
  version: "0.0.2",
  description: "Create a new message. [See the documentation](https://docs.vitally.io/pushing-data-to-vitally/rest-api/messages#create-a-message-post)",
  type: "action",
  props: {
    vitally,
    organizationId: {
      propDefinition: [
        vitally,
        "organizationId",
      ],
    },
    conversationId: {
      propDefinition: [
        vitally,
        "conversationId",
        ({ organizationId }) => ({
          organizationId,
        }),
      ],
    },
    externalId: {
      propDefinition: [
        vitally,
        "externalId",
      ],
      description: "The unique ID of the message in your system.",
    },
    timestamp: {
      type: "string",
      label: "Timestamp",
      description: "The ISO-formatted string timestamp of when the message was sent.",
      optional: true,
    },
    message: {
      type: "string",
      label: "Message",
      description: "The HTML content of the message.",
    },
    from: {
      propDefinition: [
        vitally,
        "assignedToId",
        ({ organizationId }) => ({
          organizationId,
        }),
      ],
      label: "From",
      description: "The sender participant.",
    },
    to: {
      propDefinition: [
        vitally,
        "assignedToId",
      ],
      type: "string[]",
      label: "To",
      description: "List of the recipient participants.",
    },
    cc: {
      propDefinition: [
        vitally,
        "assignedToId",
      ],
      type: "string[]",
      label: "CC",
      description: "List of the cc recipient participants.",
      optional: true,
    },
    bcc: {
      propDefinition: [
        vitally,
        "assignedToId",
      ],
      type: "string[]",
      label: "BCC",
      description: "List of the bcc recipient participants.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      vitally,
      organizationId,
      conversationId,
      from,
      to,
      cc,
      bcc,
      ...data
    } = this;

    const response = await vitally.createMessage({
      $,
      organizationId,
      conversationId,
      data: {
        ...data,
        from: {
          type: "user",
          id: from,
        },
        to: to && to.map((id) => ({
          type: "user",
          id,
        })),
        cc: cc && cc.map((id) => ({
          type: "user",
          id,
        })),
        bcc: bcc && bcc.map((id) => ({
          type: "user",
          id,
        })),
      },
    });

    $.export("$summary", `A new message with Id: ${response.id} was successfully created!`);
    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
Vitally	`vitally`	`app`	This component uses the Vitally app.
Organization Id	`organizationId`	`string`	Select a value from the drop down menu.
Conversation Id	`conversationId`	`string`	Select a value from the drop down menu.
External Id	`externalId`	`string`	The unique ID of the message in your system.
Timestamp	`timestamp`	`string`	The ISO-formatted string timestamp of when the message was sent.
Message	`message`	`string`	The HTML content of the message.
From	`from`	`string`	Select a value from the drop down menu.
To	`to`	`string[]`	Select a value from the drop down menu.
CC	`cc`	`string[]`	Select a value from the drop down menu.
BCC	`bcc`	`string[]`	Select a value from the drop down menu.

Action Authentication#

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

To retrieve your API Key,

Click the drop down on the top left with Vitally logo
Go to “Settings” > “Integrations” > Vitally REST API
Copy the API Key under Secret Token