Update Contact with VBOUT API on New Row Custom Query from PostgreSQL API

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

Trigger workflow on

New Row Custom Query from the PostgreSQL API

Next, do this

Update Contact with the VBOUT 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 VBOUT action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Row Custom Query trigger
1. Connect your PostgreSQL account
2. Configure Polling Interval
3. Select a Schema
4. Select a Table
5. Select a Column
6. Configure SQL Query
7. Optional- Configure Values
Configure the Update Contact action
1. Connect your VBOUT account
2. Select a List
3. Select a Contact
4. Optional- Configure Email Subject
5. Optional- Configure IP Address
6. Optional- Select a Status
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 Row Custom Query on PostgreSQL

Description:Emit new event when new rows are returned from a custom query that you provide. [See the documentation](https://node-postgres.com/features/queries)

Version:2.0.8

Key:postgresql-new-row-custom-query

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 Row Custom Query", key: "postgresql-new-row-custom-query", description: "Emit new event when new rows are returned from a custom query that you provide. [See the documentation](https://node-postgres.com/features/queries)", version: "2.0.8", type: "source", dedupe: "unique", props: { ...common.props, schema: { propDefinition: [ common.props.postgresql, "schema", ], }, table: { propDefinition: [ common.props.postgresql, "table", (c) => ({ schema: c.schema, }), ], }, column: { propDefinition: [ common.props.postgresql, "column", (c) => ({ table: c.table, schema: c.schema, }), ], }, query: { propDefinition: [ common.props.postgresql, "query", ], description: "Specify the query to select new or updated rows since the last poll. For example, `SELECT * FROM users WHERE country = 'US'`", }, values: { propDefinition: [ common.props.postgresql, "values", ], }, }, hooks: { async deploy() { if (this.values && !Array.isArray(this.values)) { throw new Error("No valid values provided. The values property must be an array."); } const numberOfValues = this.query?.match(/\$/g)?.length || 0; if (this.values && this.values.length !== numberOfValues) { throw new Error("The number of values provided does not match the number of values in the query."); } const isColumnUnique = await this.isColumnUnique(this.schema, this.table, this.column); if (!isColumnUnique) { throw new Error("The column selected contains duplicate values. Column must be unique"); } }, }, methods: { ...common.methods, generateMeta(row, column) { return { id: row[column], summary: "New Row", ts: Date.now(), }; }, }, async run() { const rows = await this.postgresql.executeQuery({ text: this.query, values: this.values, }); for (const row of rows) { const meta = this.generateMeta(row, this.column); this.$emit(row, meta); } }, };

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.
Table	`table`	`string`	Select a value from the drop down menu.
Column	`column`	`string`	Select a value from the drop down menu.
SQL Query	`query`	`string`	Specify the query to select new or updated rows since the last poll. For example, `SELECT * FROM users WHERE country = 'US'`
Values	`values`	`string[]`	List of values represented in your SQL Query above

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#

Update Contact on VBOUT

Description:This action updates a specific contact. [See the docs here](https://developers.vbout.com/docs#emailmarketing_editcontact)

Version:0.0.2

Key:vbout-update-contact

View on GitHub

VBOUT Overview#

The VBOUT API unlocks the potential to automate your marketing stack, leveraging Pipedream's capabilities for seamless integrations with other services. With VBOUT, you can manage contacts, automate email campaigns, track user actions, and analyze performance data. Pipedream enhances this by allowing you to capture events in real-time, process data with serverless code, and connect with countless apps to extend your marketing automation workflows.

Action Code#

import common from "../common/base.mjs"; export default { ...common, key: "vbout-update-contact", name: "Update Contact", description: "This action updates a specific contact. [See the docs here](https://developers.vbout.com/docs#emailmarketing_editcontact)", version: "0.0.2", annotations: { destructiveHint: true, openWorldHint: true, readOnlyHint: false, }, type: "action", props: { ...common.props, list: { propDefinition: [ common.props.vbout, "list", ], reloadProps: true, description: "Select the list to load contacts", }, contact: { propDefinition: [ common.props.vbout, "contact", (c) => ({ listId: c.list.value, }), ], description: "Select the contact you want to update.", }, email: { propDefinition: [ common.props.vbout, "emailSubject", ], optional: true, description: "The email of the contact.", }, ipaddress: { propDefinition: [ common.props.vbout, "ipaddress", ], optional: true, }, status: { propDefinition: [ common.props.vbout, "status", ], optional: true, }, }, async additionalProps() { const props = {}; if (this.list) { const { list: { fields } } = await this.vbout.getList({ id: this.list.value, }); for (const [ key, value, ] of Object.entries(fields)) { props[`fields-${key}`] = { type: "string", label: `${value} (${key})`, description: "custom field added to a specific list", optional: true, }; } } return props; }, methods: { async processEvent($) { const { // eslint-disable-next-line no-unused-vars vbout, list, contact, email, ipaddress, status, ...customFields } = this; const params = { id: contact.value, email, ipaddress, status, }; for (const key in customFields) { const item = customFields[key]; const customFieldName = (key.split("fields-"))[1]; params[`fields[${customFieldName}]`] = item; } return this.vbout.updateContact({ $, params, }); }, getSummary() { return `Contact ${this.contact.label} Successfully unsubscribed!`; }, }, };

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
VBOUT	`vbout`	`app`	This component uses the VBOUT app.
List	`list`	`string`	Select a value from the drop down menu.
Contact	`contact`	`string`	Select a value from the drop down menu.
Email Subject	`email`	`string`	The email of the contact.
IP Address	`ipaddress`	`string`	The ip of the contact.
Status	`status`	`integer`	Select a value from the drop down menu:`{ "label": "Unconfirmed", "value": 0 }{ "label": "Active", "value": 1 }{ "label": "Unsubscribe", "value": 2 }{ "label": "Bounced Email", "value": 3 }`

Action Authentication#

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

To retrieve your API key,

Navigate to your VBOUT account and sign in
Go to “Settings” > “API Integrations”