Create Code Review with Beanstalk API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Code Review with the Beanstalk 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#

Create a workflow to Create Code Review with the Beanstalk API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Code Review action
1. Connect your Beanstalk account
2. Select a Repository ID
3. Optional- Configure Description
4. Select a Target Branch
5. Select a Source Branch
6. Optional- Configure Merge
7. Select one or more Assignee IDs
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Code Review with Beanstalk API on New Requests from HTTP / Webhook API

HTTP / Webhook + Beanstalk

Try it

Create Code Review with Beanstalk API on New Submission from Typeform API

Typeform + Beanstalk

Try it

Create Code Review with Beanstalk API on New Submission (Instant) from Jotform API

Jotform + Beanstalk

Try it

Create Code Review with Beanstalk API on New Custom Webhook Events from Stripe API

Stripe + Beanstalk

Try it

Create Code Review with Beanstalk API on New Scheduled Tasks from Pipedream API

Pipedream + Beanstalk

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Create Code Review on Beanstalk

Description:Creates a new code review. This action is essentially the same as clicking the “Request review” button in the app. [See the docs](https://api.beanstalkapp.com/code_review.html).

Version:0.0.1

Key:beanstalkapp-create-code-review

View on GitHub

Code#

import app from "../../beanstalkapp.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "beanstalkapp-create-code-review",
  name: "Create Code Review",
  description: "Creates a new code review. This action is essentially the same as clicking the “Request review” button in the app. [See the docs](https://api.beanstalkapp.com/code_review.html).",
  type: "action",
  version: "0.0.1",
  props: {
    app,
    repositoryId: {
      propDefinition: [
        app,
        "repositoryId",
      ],
    },
    description: {
      type: "string",
      label: "Description",
      description: "Description of the **Target Branch**.",
      optional: true,
    },
    targetBranch: {
      label: "Target Branch",
      description: "Name of the branch that’s being reviewed.",
      propDefinition: [
        app,
        "branch",
        ({ repositoryId }) => ({
          repositoryId,
        }),
      ],
    },
    sourceBranch: {
      label: "Source Branch",
      description: "Name of the branch to which **Target Branch** should be compared to.",
      propDefinition: [
        app,
        "branch",
        ({ repositoryId }) => ({
          repositoryId,
        }),
      ],
    },
    merge: {
      type: "boolean",
      label: "Merge",
      description: "Merge branches when review gets approved. `False` by default.",
      optional: true,
    },
    assigneeIds: {
      type: "string[]",
      label: "Assignee IDs",
      description: "IDs of the users who will be assigned to the code review.",
      propDefinition: [
        app,
        "userId",
      ],
    },
  },
  methods: {
    createCodeReview({
      repositoryId, ...args
    } = {}) {
      return this.app.create({
        path: `/${repositoryId}/code_reviews`,
        ...args,
      });
    },
  },
  async run({ $: step }) {
    const {
      repositoryId,
      description,
      targetBranch,
      sourceBranch,
      merge,
      assigneeIds,
    } = this;

    const response = await this.createCodeReview({
      step,
      repositoryId,
      data: {
        code_review: {
          description,
          target_branch: targetBranch,
          source_branch: sourceBranch,
          merge,
          assignee_ids: utils.parseArray(assigneeIds),
        },
      },
    });

    step.export("$summary", `Successfully created code review with ID ${response.id}`);

    return response;
  },
};

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
Beanstalk	`app`	`app`	This component uses the Beanstalk app.
Repository ID	`repositoryId`	`string`	Select a value from the drop down menu.
Description	`description`	`string`	Description of the Target Branch.
Target Branch	`targetBranch`	`string`	Select a value from the drop down menu.
Source Branch	`sourceBranch`	`string`	Select a value from the drop down menu.
Merge	`merge`	`boolean`	Merge branches when review gets approved. `False` by default.
Assignee IDs	`assigneeIds`	`string[]`	Select a value from the drop down menu.

Authentication#

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

To connect your Beanstalk account with Pipedream,

Retrieve your Access Token by going to Account > Developer API
Retrieve your username by going to your profile with your full name on the top right
Your domain is 12345678 if your Beanstalk URL is https://12345678.beanstalkapp.com/