Send SMS Verification with FraudLabs Pro API on BigQuery - New Row from Google Cloud API

Pipedream makes it easy to connect APIs for FraudLabs Pro, Google Cloud and 2,400+ other apps remarkably fast.

Trigger workflow on

BigQuery - New Row from the Google Cloud API

Next, do this

Send SMS Verification with the FraudLabs Pro 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 Google Cloud trigger and FraudLabs Pro action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the BigQuery - New Row trigger
1. Connect your Google Cloud account
2. Configure Polling interval
3. Configure Event Size
4. Select a Dataset ID
5. Select a Table Name
6. Select a Unique Key
Configure the Send SMS Verification action
1. Connect your FraudLabs Pro account
2. Configure Telephone Number
3. Configure Message
4. Optional- Configure Country Code
5. Optional- Configure Result Format
6. Optional- Configure OTP Timeout
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#

BigQuery - New Row on Google Cloud

Description:Emit new events when a new row is added to a table

Version:0.1.6

Key:google_cloud-bigquery-new-row

View on GitHub

Google Cloud Overview#

The Google Cloud API opens a world of possibilities for enhancing cloud operations and automating tasks. It empowers you to manage, scale, and fine-tune various services within the Google Cloud Platform (GCP) programmatically. With Pipedream, you can harness this power to create intricate workflows, trigger cloud functions based on events from other apps, manage resources, and analyze data, all in a serverless environment. The ability to interconnect GCP services with numerous other apps enriches automation, making it easier to synchronize data, streamline development workflows, and deploy applications efficiently.

Trigger Code#

import crypto from "crypto";
import { isString } from "lodash-es";
import googleCloud from "../../google_cloud.app.mjs";
import common from "../common/bigquery.mjs";

export default {
  ...common,
  key: "google_cloud-bigquery-new-row",
  // eslint-disable-next-line pipedream/source-name
  name: "BigQuery - New Row",
  description: "Emit new events when a new row is added to a table",
  version: "0.1.6",
  dedupe: "unique",
  type: "source",
  props: {
    ...common.props,
    tableId: {
      propDefinition: [
        googleCloud,
        "tableId",
        ({ datasetId }) => ({
          datasetId,
        }),
      ],
    },
    uniqueKey: {
      type: "string",
      label: "Unique Key",
      description: "The name of a column in the table to use for deduplication. See [the docs](https://github.com/PipedreamHQ/pipedream/tree/master/components/google_cloud/sources/bigquery-new-row#technical-details) for more info.",
      async options(context) {
        const { page } = context;
        if (page !== 0) {
          return [];
        }

        const columnNames = await this._getColumnNames();
        return columnNames.sort();
      },
    },
  },
  hooks: {
    ...common.hooks,
    async deploy() {
      await this._validateColumn(this.uniqueKey);
      const lastResultId = await this._getIdOfLastRow(this.getInitialEventCount());
      this._setLastResultId(lastResultId);
    },
    async activate() {
      if (this._getLastResultId()) {
        // ID of the last result has already been initialised during deploy(),
        // so we skip the rest of the activation.
        return;
      }

      await this._validateColumn(this.uniqueKey);
      const lastResultId = await this._getIdOfLastRow();
      this._setLastResultId(lastResultId);
    },
    deactivate() {
      this._setLastResultId(null);
    },
  },
  methods: {
    ...common.methods,
    _getLastResultId() {
      return this.db.get("lastResultId");
    },
    _setLastResultId(lastResultId) {
      this.db.set("lastResultId", lastResultId);
      console.log(`
        Next scan of table '${this.tableId}' will start at ${this.uniqueKey}=${lastResultId}
      `);
    },
    /**
     * Utility method to make sure that a certain column exists in the target
     * table. Useful for SQL query sanitizing.
     *
     * @param {string} columnNameToValidate The name of the column to validate
     * for existence
     */
    async _validateColumn(columnNameToValidate) {
      if (!isString(columnNameToValidate)) {
        throw new Error("columnNameToValidate must be a string");
      }

      const columnNames = await this._getColumnNames();
      if (!columnNames.includes(columnNameToValidate)) {
        throw new Error(`Nonexistent column: ${columnNameToValidate}`);
      }
    },
    async _getColumnNames() {
      const table = this.googleCloud
        .getBigQueryClient()
        .dataset(this.datasetId)
        .table(this.tableId);
      const [
        metadata,
      ] = await table.getMetadata();
      const { fields } = metadata.schema;
      return fields.map(({ name }) => name);
    },
    async _getIdOfLastRow(offset = 0) {
      const limit = offset + 1;
      const query = `
        SELECT *
        FROM \`${this.tableId}\`
        ORDER BY \`${this.uniqueKey}\` DESC
        LIMIT @limit
      `;
      const queryOpts = {
        query,
        params: {
          limit,
        },
      };
      const rows = await this.getRowsForQuery(queryOpts, this.datasetId);
      if (rows.length === 0) {
        console.log(`
          No records found in the target table, will start scanning from the beginning
        `);
        return;
      }

      const startingRow = rows.pop();
      return startingRow[this.uniqueKey];
    },
    getQueryOpts() {
      const lastResultId = this._getLastResultId();
      const query = `
        SELECT *
        FROM \`${this.tableId}\`
        WHERE \`${this.uniqueKey}\` >= @lastResultId
        ORDER BY \`${this.uniqueKey}\` ASC
      `;
      const params = {
        lastResultId,
      };
      return {
        query,
        params,
      };
    },
    generateMeta(row, ts) {
      const id = row[this.uniqueKey];
      const summary = `New row: ${id}`;
      return {
        id,
        summary,
        ts,
      };
    },
    generateMetaForCollection(rows, ts) {
      const hash = crypto.createHash("sha1");
      rows
        .map((i) => i[this.uniqueKey])
        .map((i) => i.toString())
        .forEach((i) => hash.update(i));
      const id = hash.digest("base64");

      const rowCount = rows.length;
      const entity = rowCount === 1
        ? "row"
        : "rows";
      const summary = `${rowCount} new ${entity}`;

      return {
        id,
        summary,
        ts,
      };
    },
  },
};

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
Google Cloud	`googleCloud`	`app`	This component uses the Google Cloud app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	How often to run your query
Event Size	`eventSize`	`integer`	The number of rows to include in a single event (by default, emits 1 event per row)
Dataset ID	`datasetId`	`string`	Select a value from the drop down menu.
Table Name	`tableId`	`string`	Select a value from the drop down menu.
Unique Key	`uniqueKey`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

Create a service account in GCP and set the permissions you need for Pipedream workflows.
Generate a service account key
Download the key details in JSON format
Upload the key below.

About Google Cloud#

The Google Cloud Platform, including BigQuery

Action#

Send SMS Verification on FraudLabs Pro

Description:Send an SMS with verification code and a custom message for authentication purpose. Please refer to the [documentation](https://www.fraudlabspro.com/developer/api/send-verification) for the explanation of the result returned. NOTE: You need to register for an API key before using this REST API. Please visit [Micro Plan](https://www.fraudlabspro.com/sign-up) to sign up for an API key if you do not have one. In addition, you will also have to make sure you have enough SMS credits to send any verification SMS.

Version:0.0.3

Key:fraudlabs_pro-send-sms-verification

View on GitHub

FraudLabs Pro Overview#

The FraudLabs Pro API offers a robust suite of fraud prevention tools that empower users to screen online transactions for fraud. It leverages advanced scoring analytics to rate the risk level of a transaction based on various verification checks, such as IP address, email, transaction velocity, and more. Using Pipedream, developers can integrate these capabilities into workflows to automate fraud checks, augment data analysis, and trigger actions based on fraud scores.

Action Code#

import fraudlabsProApp from "../../fraudlabs_pro.app.mjs";

export default {
  name: "Send SMS Verification",
  description: "Send an SMS with verification code and a custom message for authentication purpose. Please refer to the [documentation](https://www.fraudlabspro.com/developer/api/send-verification) for the explanation of the result returned. NOTE: You need to register for an API key before using this REST API. Please visit [Micro Plan](https://www.fraudlabspro.com/sign-up) to sign up for an API key if you do not have one. In addition, you will also have to make sure you have enough SMS credits to send any verification SMS.",
  key: "fraudlabs_pro-send-sms-verification",
  version: "0.0.3",
  type: "action",
  props: {
    fraudlabsProApp,
    tel: {
      type: "string",
      label: "Telephone Number",
      description: "The recipient mobile phone number in E164 format which is a plus followed by just numbers with no spaces or parentheses. For example, `+12015550123`",
    },
    mesg: {
      type: "string",
      label: "Message",
      description: "The message template for the SMS. Add <otp> as placeholder for the actual OTP to be generated. Max length is 140 characters. For example, `Your OTP for the transaction is <otp>`",
    },
    countryCode: {
      type: "string",
      label: "Country Code",
      description: "*(optional)* ISO 3166 country code for the recipient mobile phone number. If parameter is supplied, then some basic telephone number validation is done.",
      optional: true,
    },
    format: {
      propDefinition: [
        fraudlabsProApp,
        "format",
      ],
    },
    otpTimeout: {
      type: "string",
      label: "OTP Timeout",
      description: "*(optional)* Timeout feature for OTP value in seconds. Default is `3600` seconds(1 hour). Min timeout is 15 seconds whereas max timeout is `86400` seconds(24 hours).",
      optional: true,
    },
  },
  async run({ $ }) {

    const {
      tel,
      mesg,
      countryCode,
      format,
      otpTimeout,
    } = this;

    const response =
    await this.fraudlabsProApp.sendSmsVerification({
      tel,
      format,
      mesg,
      country_code: countryCode ?? "",
      otp_timeout: otpTimeout ?? "",
    });

    if ('error' in response) {
      throw new Error(`Fraudlabs Pro response: error code ${response.error.error_code} - ${response.error.error_message}`);
    } else {
      $.export("$summary", "Successfully sent SMS verification");
    }
    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
FraudLabs Pro	`fraudlabsProApp`	`app`	This component uses the FraudLabs Pro app.
Telephone Number	`tel`	`string`	The recipient mobile phone number in E164 format which is a plus followed by just numbers with no spaces or parentheses. For example, `+12015550123`
Message	`mesg`	`string`	The message template for the SMS. Add <otp> as placeholder for the actual OTP to be generated. Max length is 140 characters. For example, `Your OTP for the transaction is <otp>`
Country Code	`countryCode`	`string`	(optional) ISO 3166 country code for the recipient mobile phone number. If parameter is supplied, then some basic telephone number validation is done.
Result Format	`format`	`string`	(optional) Format of the result. Available values are `json` or `xml`. If unspecified, json format will be used for the response message.
OTP Timeout	`otpTimeout`	`string`	(optional) Timeout feature for OTP value in seconds. Default is `3600` seconds(1 hour). Min timeout is 15 seconds whereas max timeout is `86400` seconds(24 hours).