Send SMS with BulkGate API on New Row Custom Query from PostgreSQL API

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

Trigger workflow on

New Row Custom Query from the PostgreSQL API

Next, do this

Send SMS with the BulkGate 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 BulkGate 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 Send SMS action
1. Connect your BulkGate account
2. Configure Recipient Number
3. Configure Message Text
4. Optional- Configure Is Unicode
5. Optional- Select a Sender ID
6. Optional- Configure Sender ID Value
7. Optional- Configure Country
8. Optional- Configure Application ID
9. Optional- Configure Application Token
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.6

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.6",
  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",
      ],
    },
    values: {
      propDefinition: [
        common.props.postgresql,
        "values",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateMeta(row, column) {
      return {
        id: row[column],
        summary: "New Row",
        ts: Date.now(),
      };
    },
  },
  async run() {
    const {
      schema,
      table,
      column,
      query,
      values = [],
    } = this;

    if (!Array.isArray(values)) {
      throw new Error("No valid values provided. The values property must be an array.");
    }

    const numberOfValues = query?.match(/\$/g)?.length || 0;
    if (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(schema, table, column);
    if (!isColumnUnique) {
      throw new Error("The column selected contains duplicate values. Column must be unique");
    }

    const rows = await this.postgresql.executeQuery({
      text: query,
      values,
    });
    for (const row of rows) {
      const meta = this.generateMeta(row, 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`	Your custom SQL Query using `$1`, `$2`... to represent values (eg. `INSERT INTO users(name, email) VALUES($1, $2)`
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#

Send SMS on BulkGate

Description:Sends an SMS message to a phone number. [See the docs](https://help.bulkgate.com/docs/en/http-simple-transactional-post-json.html).

Version:0.0.1

Key:bulkgate-send-sms

View on GitHub

BulkGate Overview#

The BulkGate API enables automated sending of SMS messages, offering a powerful way to communicate with customers or users directly through their mobile devices. With this API on Pipedream, you can craft workflows that trigger SMS notifications based on specific events, such as new sign-ups, transaction alerts, or appointment reminders. It's a tool for enhancing customer engagement, support, and conversion through timely and personalized messaging.

Action Code#

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

export default {
  key: "bulkgate-send-sms",
  name: "Send SMS",
  description: "Sends an SMS message to a phone number. [See the docs](https://help.bulkgate.com/docs/en/http-simple-transactional-post-json.html).",
  type: "action",
  version: "0.0.1",
  props: {
    app,
    number: {
      propDefinition: [
        app,
        "number",
      ],
    },
    text: {
      propDefinition: [
        app,
        "text",
      ],
    },
    unicode: {
      propDefinition: [
        app,
        "unicode",
      ],
    },
    senderId: {
      propDefinition: [
        app,
        "senderId",
      ],
    },
    senderIdValue: {
      propDefinition: [
        app,
        "senderIdValue",
      ],
    },
    country: {
      propDefinition: [
        app,
        "country",
      ],
    },
    appId: {
      propDefinition: [
        app,
        "appId",
      ],
    },
    appToken: {
      propDefinition: [
        app,
        "appToken",
      ],
    },
  },
  methods: {
    sendSMS(args = {}) {
      return this.app.create({
        path: "/simple/transactional",
        ...args,
      });
    },
  },
  async run({ $: step }) {
    const {
      number,
      text,
      unicode,
      senderId,
      senderIdValue,
      country,
      appId,
      appToken,
    } = this;

    const response = await this.sendSMS({
      step,
      data: {
        number,
        text,
        unicode,
        sender_id: senderId,
        sender_id_value: senderIdValue,
        country,
        appId,
        appToken,
      },
    });

    step.export("$summary", `Successfully sent SMS with ID ${response.data.sms_id}`);

    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
BulkGate	`app`	`app`	This component uses the BulkGate app.
Recipient Number	`number`	`string`	The phone number you want to send the SMS to.
Message Text	`text`	`string`	Text of SMS message (max. 612 characters, or 268 characters if Unicode is used), UTF-8 encoding
Is Unicode	`unicode`	`boolean`	`Yes/true/1` for Unicode SMS, `no/false/0` for 7bit SMS.
Sender ID	`senderId`	`string`	Select a value from the drop down menu:`{ "label": "System Number", "value": "gSystem" }{ "label": "Short Code", "value": "gShort" }{ "label": "Text sender", "value": "gText" }{ "label": "Mobile Connect", "value": "gMobile" }{ "label": "Mobile Connect push - Sends a notification to the Mobile Connect app", "value": "gPush" }{ "label": "Own Number (number verification required)", "value": "gOwn" }{ "label": "BulkGate Profile ID", "value": "gProfile" }{ "label": "BulkGate Profile ID", "value": "<int>" }`
Sender ID Value	`senderIdValue`	`string`	Sender value - gOwn (e.g. `420 777 777 777`), gText (e.g. `BulkGate`), gProfile (e.g. `423`), gMobile or gPush (`KEY`).
Country	`country`	`string`	Provide the recipients numbers in an international format (with prefix, e.g. `44`) or add the country code in ISO 3166-1 alpha-2 format (`7820125799` + `GB` = `447820125799`). See the country example request. If `null`, your set timezone will be used to fill the information
Application ID	`appId`	`string`	The ID of the application you want to use to send the SMS.
Application Token	`appToken`	`string`	The token of the application you want to use to send the SMS.