Find Row With Custom Query with PostgreSQL API on New Job Completed (Instant) from CircleCI API

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

Trigger workflow on

New Job Completed (Instant) from the CircleCI API

Next, do this

Find Row With Custom Query with the PostgreSQL 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 CircleCI trigger and PostgreSQL action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Job Completed (Instant) trigger
1. Connect your CircleCI account
2. Configure Webhook Name
3. Configure Project ID
Configure the Find Row With Custom Query action
1. Connect your PostgreSQL account
2. Configure SQL Query
3. Optional- Configure Values
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 Job Completed (Instant) on CircleCI

Description:Emit new event when a job is completed in CircleCI.

Version:0.0.1

Key:circleci-new-job-completed-instant

View on GitHub

CircleCI Overview#

The CircleCI API allows for seamless integration and automation of your CI/CD pipeline. By leveraging the API through Pipedream, you can trigger builds, monitor the status of pipelines, fetch build artifacts, and interact with various aspects of your CircleCI projects. This facilitates the creation of dynamic workflows that can streamline development practices, enhance deployment strategies, and ensure continuous integration processes are more efficient and less error-prone.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "circleci-new-job-completed-instant",
  name: "New Job Completed (Instant)",
  description: "Emit new event when a job is completed in CircleCI.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEvents() {
      return [
        "job-completed",
      ];
    },
    getSummary(event) {
      return `Job Completed: ${event.job.name}`;
    },
  },
  sampleEmit,
};

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
CircleCI	`circleci`	`app`	This component uses the CircleCI app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Webhook Name	`name`	`string`	Name of the webhook
Project ID	`projectId`	`string`	The identifier of a project. Can be found in Project Settings -> Overview

Trigger Authentication#

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

An API token can be created using the account dashboard. More info via API Overview.

About CircleCI#

Continuous integration and delivery platform

Action#

Find Row With Custom Query on PostgreSQL

Description:Finds a row in a table via a custom query. [See the documentation](https://node-postgres.com/features/queries)

Version:2.0.6

Key:postgresql-find-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.

Action Code#

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

export default {
  name: "Find Row With Custom Query",
  key: "postgresql-find-row-custom-query",
  description: "Finds a row in a table via a custom query. [See the documentation](https://node-postgres.com/features/queries)",
  version: "2.0.6",
  type: "action",
  props: {
    postgresql,
    query: {
      propDefinition: [
        postgresql,
        "query",
      ],
    },
    values: {
      propDefinition: [
        postgresql,
        "values",
      ],
    },
  },
  async run({ $ }) {
    const {
      query,
      values = [],
    } = this;

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

    if (this.values) {
      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.");
      }
    }

    if (!query.toLowerCase().includes("select")) {
      throw new Error("Need be a `SELECT` statement query. Read more about [SELECT queries here](https://www.w3schools.com/sql/sql_select.asp)");
    }

    try {
      const res = await this.postgresql.executeQuery({
        text: query,
        values,
      });
      $.export("$summary", "Successfully executed query");
      return res;
    } catch (error) {
      let errorMsg = "Query not executed due to an error. ";
      errorMsg += `${error}`.includes("SSL verification failed")
        ? "This could be because SSL verification failed. To resolve this, reconnect your account and set SSL Verification Mode: Skip Verification, and try again."
        : `${error}`;
      throw new Error(errorMsg);
    }
  },
};

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
PostgreSQL	`postgresql`	`app`	This component uses the PostgreSQL app.
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

Action 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.