Return HTTP Response with HTTP / Webhook API on New Analysis Completed (Instant) from SonarCloud API

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

Trigger workflow on

New Analysis Completed (Instant) from the SonarCloud API

Next, do this

Return HTTP Response 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 SonarCloud 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 Analysis Completed (Instant) trigger
1. Connect your SonarCloud account
2. Configure Name
3. Select a Organization
4. Optional- Select a Project
Configure the Return HTTP Response action
1. Connect your HTTP / Webhook account
2. Configure Response Status Code
3. Optional- Configure Response Headers
4. Optional- Configure Response Body
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 Analysis Completed (Instant) on SonarCloud

Description:Emit new event when a new analisys is completed.

Version:0.0.1

Key:sonarcloud-new-analysis-completed-instant

View on GitHub

SonarCloud Overview#

The SonarCloud API facilitates automated code quality checks and security vulnerability assessments. By integrating with Pipedream, developers can harness this power within serverless workflows, triggering actions based on code analysis results, monitoring project metrics, and automating project management tasks. The API allows for enhanced productivity by connecting code quality data with other services and tools, streamlining the development process.

Trigger Code#

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

export default {
  key: "sonarcloud-new-analysis-completed-instant",
  name: "New Analysis Completed (Instant)",
  description: "Emit new event when a new analisys is completed.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    sonarcloud,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    name: {
      type: "string",
      label: "Name",
      description: "Name displayed in the administration console of webhooks.",
    },
    organization: {
      propDefinition: [
        sonarcloud,
        "organization",
      ],
    },
    project: {
      propDefinition: [
        sonarcloud,
        "project",
        ({ organization }) => ({
          organization,
        }),
      ],
      optional: true,
    },
  },
  hooks: {
    async activate() {
      const { webhook } = await this.sonarcloud.createWebhook({
        params: {
          name: this.name,
          organization: this.organization,
          project: this.project,
          url: this.http.endpoint,
        },
      });
      this.db.set("hookId", webhook.key);
    },
    async deactivate() {
      await this.sonarcloud.deleteWebhook({
        params: {
          webhook: this.db.get("hookId"),
        },
      });
    },
  },
  async run(event) {
    this.http.respond({
      status: 200,
    });

    const { body } = event;

    this.$emit(body, {
      id: body.revision,
      summary: `New analisys completed with revision key: ${body.revision}`,
      ts: Date.parse(body.changedAt),
    });
  },
};

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
SonarCloud	`sonarcloud`	`app`	This component uses the SonarCloud app.
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Name	`name`	`string`	Name displayed in the administration console of webhooks.
Organization	`organization`	`string`	Select a value from the drop down menu.
Project	`project`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

About SonarCloud#

SonarCloud is the leading online service for Code Quality & Security. Free analysis for open-source projects covering 24 languages.

Action#

Return HTTP Response on HTTP / Webhook

Description:Use with an HTTP trigger that uses "Return a custom response from your workflow" as its `HTTP Response`

Version:0.0.3

Key:http-return-http-response

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-return-http-response",
  name: "Return HTTP Response",
  description:
    "Use with an HTTP trigger that uses \"Return a custom response from your workflow\" as its `HTTP Response`",
  type: "action",
  version: "0.0.3",
  props: {
    http,
    resStatusCode: {
      type: "integer",
      label: "Response Status Code",
      description:
        "The [status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) to return in the HTTP response.",
      default: 200,
      min: 100,
      max: 599,
    },
    resHeaders: {
      type: "object",
      label: "Response Headers",
      description: "The headers to return in the HTTP response.",
      optional: true,
    },
    resBody: {
      type: "any",
      label: "Response Body",
      description: "The body to return in the HTTP response.",
      optional: true,
      default: "{ \"success\": true }",
    },
  },
  async run({ $ }) {
    const status = this.resStatusCode;
    await $.respond({
      status,
      headers: this.resHeaders,
      body: this.resBody,
    });
    $.export("$summary", `Responded successfully with status ${status}`);
  },
};

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.
Response Status Code	`resStatusCode`	`integer`	The status code to return in the HTTP response.
Response Headers	`resHeaders`	`object`	The headers to return in the HTTP response.
Response Body	`resBody`	`any`	The body to return in the HTTP response.

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 + SonarCloud#

Other Popular Integrations#

Send any HTTP Request with HTTP / Webhook API on New Analysis Completed (Instant) from SonarCloud API

SonarCloud + HTTP / Webhook

Try it

Send GET Request with HTTP / Webhook API on New Analysis Completed (Instant) from SonarCloud API

SonarCloud + HTTP / Webhook

Try it

Send POST Request with HTTP / Webhook API on New Analysis Completed (Instant) from SonarCloud API

SonarCloud + HTTP / Webhook

Try it

Send PUT Request with HTTP / Webhook API on New Analysis Completed (Instant) from SonarCloud API

SonarCloud + HTTP / Webhook

Try it

Validate Webhook Auth with HTTP / Webhook API on New Analysis Completed (Instant) from SonarCloud API

SonarCloud + HTTP / Webhook

Try it

Popular Triggers#

New Analysis Completed (Instant) from the SonarCloud API

Emit new event when a new analisys is completed.

Try it

New Requests from the HTTP / Webhook API

Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Try it

New Requests (Payload Only) from the HTTP / Webhook API

Get a URL and emit the HTTP body as an event on every request

Try it

New event when the content of the URL changes. from the HTTP / Webhook API

Emit new event when the content of the URL changes.

Try it