Create Internet Service with Splynx API on New Row (Custom Query) from MySQL API

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

Trigger workflow on

New Row (Custom Query) from the MySQL API

Next, do this

Create Internet Service with the Splynx 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 MySQL trigger and Splynx 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 MySQL account
2. Configure timer
3. Select a Table
4. Optional- Select a De-duplication Key
5. Configure Where condition
6. Configure Values
Configure the Create Internet Service action
1. Connect your Splynx account
2. Select a Customer ID
3. Select a Tariff ID
4. Select a Status
5. Configure Description
6. Configure Quantity
7. Configure Start Date
8. Configure End Date
9. Configure Login
10. Select a Taking IPv4
11. Optional- Configure Additional Options
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 MySQL

Description:Emit new event when new rows are returned from a custom query. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/select.html)

Version:2.0.5

Key:mysql-new-row-custom-query

View on GitHub

MySQL Overview#

The MySQL application on Pipedream enables direct interaction with your MySQL databases, allowing you to perform CRUD operations—create, read, update, delete—on your data with ease. You can leverage these capabilities to automate data synchronization, report generation, and event-based triggers that kick off workflows in other apps. With Pipedream's serverless platform, you can connect MySQL to hundreds of other services without managing infrastructure, crafting complex code, or handling authentication.

Trigger Code#

import common from "../common/table.mjs";
import { v4 as uuidv4 } from "uuid";

const { mysql } = common.props;

export default {
  ...common,
  key: "mysql-new-row-custom-query",
  name: "New Row (Custom Query)",
  description: "Emit new event when new rows are returned from a custom query. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/select.html)",
  version: "2.0.5",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    column: {
      propDefinition: [
        mysql,
        "column",
        (c) => ({
          table: c.table,
        }),
      ],
      label: "De-duplication Key",
      description:
        "The name of a column in the table to use for de-duplication",
      optional: true,
    },
    condition: {
      propDefinition: [
        mysql,
        "whereCondition",
      ],
    },
    values: {
      propDefinition: [
        mysql,
        "whereValues",
      ],
    },
  },
  methods: {
    ...common.methods,
    async listResults() {
      const {
        table,
        condition,
        values,
      } = this;

      const numberOfQuestionMarks = condition?.match(/\?/g)?.length;

      if (!numberOfQuestionMarks) {
        throw new Error("No valid condition provided. At least one question mark character ? must be provided.");
      }

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

      if (values.length !== numberOfQuestionMarks) {
        throw new Error("The number of values provided does not match the number of question marks ? in the condition.");
      }

      const rows = await this.mysql.findRows({
        table,
        condition,
        values,
      });
      this.iterateAndEmitEvents(rows);
    },
    generateMeta(row) {
      const id = this.column
        ? row[this.column]
        : uuidv4();
      return {
        id,
        summary: `New Row ${id}`,
        ts: Date.now(),
      };
    },
  },
};

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
MySQL	`mysql`	`app`	This component uses the MySQL app.
	`timer`	`$.interface.timer`
Table	`table`	`string`	Select a value from the drop down menu.
De-duplication Key	`column`	`string`	Select a value from the drop down menu.
Where condition	`condition`	`string`	In this expression you can write your own conditions (eg. `column1 = ? or column2 = ?`). Depending on the number of `?` symbols likewise you need to add the same number of values.
Values	`values`	`string[]`	This is the list of values that will match every `?` symbol in the where expression. If you want to build yourself the values (eg. `{{["string1", "string2"]}}`)

Trigger Authentication#

MySQL uses API keys for authentication. When you connect your MySQL account, Pipedream securely stores the keys so you can easily authenticate to MySQL 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 MySQL 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 MySQL#

MySQL is an open-source relational database management system.

Action#

Create Internet Service on Splynx

Description:Creates a new internet service with specified details. [See the documentation](https://splynx.docs.apiary.io/#reference/services/internet-services-collection/create-service)

Version:0.0.1

Key:splynx-create-internet-service

View on GitHub

Splynx Overview#

The Splynx API provides a gateway to manage and automate Internet Service Provider (ISP) tasks such as billing, networking, and customer management. By tapping into this API via Pipedream, you can create robust integrations and workflows that streamline operations, enhance customer service, and drive data-driven decisions. Pipedream's platform enables the connection of Splynx's features with hundreds of other apps without the need for extensive coding, facilitating task automation and data synchronization in real-time.

Action Code#

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

export default {
  key: "splynx-create-internet-service",
  name: "Create Internet Service",
  description: "Creates a new internet service with specified details. [See the documentation](https://splynx.docs.apiary.io/#reference/services/internet-services-collection/create-service)",
  version: "0.0.1",
  type: "action",
  props: {
    splynx,
    customerId: {
      propDefinition: [
        splynx,
        "customerId",
      ],
    },
    tariffId: {
      propDefinition: [
        splynx,
        "tariffId",
      ],
    },
    status: {
      type: "string",
      label: "Status",
      description: "Status of the service",
      options: [
        "active",
        "disabled",
        "hidden",
        "pending",
      ],
    },
    description: {
      type: "string",
      label: "Description",
      description: "Description of the service",
    },
    quantity: {
      type: "integer",
      label: "Quantity",
      description: "Quantity",
    },
    startDate: {
      type: "string",
      label: "Start Date",
      description: "Start date. Format: `YYYY-MM-DD`",
    },
    endDate: {
      type: "string",
      label: "End Date",
      description: "End date. Format: `YYYY-MM-DD`",
    },
    login: {
      type: "string",
      label: "Login",
      description: "Service login. Recommended to use customer login as prefix",
    },
    takingIpv4: {
      type: "integer",
      label: "Taking IPv4",
      description: "Taking IPv4",
      options: [
        {
          label: "None (Router will assign IP)",
          value: 0,
        },
        {
          label: "Permanent IP (from Static IPs)",
          value: 1,
        },
        {
          label: "Dynamic IP (from IP Pools)",
          value: 2,
        },
      ],
    },
    additionalOptions: {
      type: "object",
      label: "Additional Options",
      description: "Additional parameters to be passed in this request. [See the documentation](https://splynx.docs.apiary.io/#reference/services/internet-services-collection/create-service) for available parameters",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.splynx.createInternetService({
      $,
      customerId: this.customerId,
      data: {
        tariff_id: this.tariffId,
        status: this.status,
        description: this.description,
        quantity: this.quantity,
        start_date: this.startDate,
        end_date: this.endDate,
        login: this.login,
        taking_ipv4: this.takingIpv4,
        ...this.additionalOptions,
      },
    });

    $.export("$summary", `Successfully created a new internet service (ID: ${response.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
Splynx	`splynx`	`app`	This component uses the Splynx app.
Customer ID	`customerId`	`string`	Select a value from the drop down menu.
Tariff ID	`tariffId`	`string`	Select a value from the drop down menu.
Status	`status`	`string`	Select a value from the drop down menu:`activedisabledhiddenpending`
Description	`description`	`string`	Description of the service
Quantity	`quantity`	`integer`	Quantity
Start Date	`startDate`	`string`	Start date. Format: `YYYY-MM-DD`
End Date	`endDate`	`string`	End date. Format: `YYYY-MM-DD`
Login	`login`	`string`	Service login. Recommended to use customer login as prefix
Taking IPv4	`takingIpv4`	`integer`	Select a value from the drop down menu:`{ "label": "None (Router will assign IP)", "value": 0 }{ "label": "Permanent IP (from Static IPs)", "value": 1 }{ "label": "Dynamic IP (from IP Pools)", "value": 2 }`
Additional Options	`additionalOptions`	`object`	Additional parameters to be passed in this request. See the documentation for available parameters

Action Authentication#

Splynx uses OAuth authentication. When you connect your Splynx account, Pipedream will open a popup window where you can sign into Splynx and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Splynx API.

Pipedream requests the following authorization scopes when you connect your account: