[Data] Parse JSON with Formatting API on New Job Completed (Instant) from CircleCI API

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

Trigger workflow on

New Job Completed (Instant) from the CircleCI API

Next, do this

[Data] Parse JSON with the Formatting 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 Formatting 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 [Data] Parse JSON action
1. Connect your Formatting account
2. Configure Input
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#

[Data] Parse JSON on Formatting

Description:Parse a JSON string

Version:0.0.5

Key:formatting-parse-json

View on GitHub

Action Code#

import { defineAction } from "@pipedream/types";
import app from "../../app/formatting.app.mjs";
export default defineAction({
    name: "[Data] Parse JSON",
    description: "Parse a JSON string",
    key: "formatting-parse-json",
    version: "0.0.5",
    type: "action",
    props: {
        app,
        input: {
            label: "Input",
            description: "A valid JSON format string to be parsed.",
            type: "string",
        },
    },
    async run({ $ }) {
        try {
            const result = JSON.parse(this.input);
            $.export("$summary", "Successfully parsed JSON string");
            return result;
        }
        catch (err) {
            throw new Error("Error parsing input as JSON: " + err.toString());
        }
    },
});