Send any HTTP Request with HTTP / Webhook API on New Workflow Completed (Instant) from CircleCI API

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

Trigger workflow on

New Workflow Completed (Instant) from the CircleCI API

Next, do this

Send any HTTP Request with the HTTP / Webhook 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 HTTP / Webhook action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Workflow Completed (Instant) trigger
1. Connect your CircleCI account
2. Configure Webhook Name
3. Configure Project ID
Configure the Send any HTTP Request action
1. Connect your HTTP / Webhook account
2. Configure HTTP Request Configuration
3. Optional- Configure Include Response Headers
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 Workflow Completed (Instant) on CircleCI

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

Version:0.0.1

Key:circleci-new-workflow-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-workflow-completed-instant",
  name: "New Workflow Completed (Instant)",
  description: "Emit new event when a workflow is completed in CircleCI.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEvents() {
      return [
        "workflow-completed",
      ];
    },
    getSummary(event) {
      return `Workflow Completed: ${event.workflow.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#

Send any HTTP Request on HTTP / Webhook

Description:Send an HTTP request using any method and URL. Optionally configure query string parameters, headers, and basic auth.

Version:1.1.1

Key:http-custom-request

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Action Code#

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

export default {
  key: "http-custom-request",
  name: "Send any HTTP Request",
  description: "Send an HTTP request using any method and URL. Optionally configure query string parameters, headers, and basic auth.",
  type: "action",
  version: "1.1.1",
  props: {
    http,
    httpRequest: {
      propDefinition: [
        http,
        "httpRequest",
      ],
    },
    includeHeaders: {
      type: "boolean",
      label: "Include Response Headers",
      description: "Optionally export the full response headers",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.httpRequest.execute();

    if (this.includeHeaders) {
      $.export("headers", response.headers);
    }

    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
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.
HTTP Request Configuration	`httpRequest`	`http_request`
Include Response Headers	`includeHeaders`	`boolean`	Optionally export the full response headers

Action Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

More Ways to Connect HTTP / Webhook + CircleCI#

Other Popular Integrations#

Send any HTTP Request with HTTP / Webhook API on New Job Completed (Instant) from CircleCI API

CircleCI + HTTP / Webhook