Create Code Review with Beanstalk API on New File Created from OpenAI (ChatGPT) API

Pipedream makes it easy to connect APIs for Beanstalk, OpenAI (ChatGPT) and 2,900+ other apps remarkably fast.

Trigger workflow on

New File Created from the OpenAI (ChatGPT) API

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#

This integration creates a workflow with a OpenAI (ChatGPT) trigger and Beanstalk action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New File Created trigger
1. Connect your OpenAI (ChatGPT) account
2. Configure timer
3. Optional- Select a Purpose
4. Optional- Configure Include Link
5. Optional- Configure dir
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
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 File Created on OpenAI (ChatGPT)

Description:Emit new event when a new file is created in OpenAI. [See the documentation](https://platform.openai.com/docs/api-reference/files/list)

Version:0.1.0

Key:openai-new-file-created

View on GitHub

OpenAI (ChatGPT) Overview#

OpenAI provides a suite of powerful AI models through its API, enabling developers to integrate advanced natural language processing and generative capabilities into their applications. Here’s an overview of the services offered by OpenAI's API:

Use Python or Node.js code to make fully authenticated API requests with your OpenAI account:

Trigger Code#

import common from "../common/common.mjs";
import { Readable } from "stream";
import { fileTypeFromBuffer } from "file-type";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "openai-new-file-created",
  name: "New File Created",
  description: "Emit new event when a new file is created in OpenAI. [See the documentation](https://platform.openai.com/docs/api-reference/files/list)",
  version: "0.1.0",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    purpose: {
      propDefinition: [
        common.props.openai,
        "purpose",
      ],
      description: "If specified, events will only be emitted for files with the specified purpose.",
      optional: true,
    },
    includeLink: {
      label: "Include Link",
      type: "boolean",
      description: "Upload file to your File Stash and emit temporary download link to the file. See [the docs](https://pipedream.com/docs/connect/components/files) to learn more about working with files in Pipedream.",
      default: false,
      optional: true,
    },
    dir: {
      type: "dir",
      accessMode: "write",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getData() {
      return this.openai.listFiles({
        purpose: this.purpose,
      });
    },
    getMeta(item) {
      return {
        id: item.id,
        summary: `New File: ${item.filename}`,
        ts: item.created_at * 1000,
      };
    },
    async stashFile(item) {
      const response = await this.openai.retrieveFileContent({
        file_id: item.id,
        responseType: "arraybuffer",
      });
      const buffer = Buffer.from(response);
      const filepath = `${item.id}/${item.filename}`;
      const type = await fileTypeFromBuffer(buffer);
      const file = await this.dir.open(filepath).fromReadableStream(
        Readable.from(buffer),
        type?.mime,
        buffer.length,
      );
      return await file.withoutPutUrl().withGetUrl();
    },
    async getAndProcessItems(maxEvents) {
      const lastCreated = this._getLastCreated();
      const { data } = await this.getData();
      if (!data?.length) {
        return;
      }
      this._setLastCreated(data[0].created_at);
      const items = data?.filter(({ created_at }) => created_at >= lastCreated).reverse();
      let count = 0;
      for (const item of items) {
        if (!maxEvents || count < maxEvents) {
          if (this.includeLink) {
            try {
              item.file = await this.stashFile(item);
            } catch (error) {
              item.file = `Could not upload file ${item.filename } to File Stash`;
            }
          }
          this.$emit(item, this.getMeta(item));
          count++;
        }
      }
    },
  },
  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
OpenAI (ChatGPT)	`openai`	`app`	This component uses the OpenAI (ChatGPT) app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Purpose	`purpose`	`string`	Select a value from the drop down menu:`fine-tuneassistantsvisionbatch`
Include Link	`includeLink`	`boolean`	Upload file to your File Stash and emit temporary download link to the file. See the docs to learn more about working with files in Pipedream.
	`dir`	`dir`

Trigger Authentication#

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

About OpenAI (ChatGPT)#

OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.

Action#

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

Key:beanstalkapp-create-code-review

View on GitHub

Beanstalk Overview#

The Beanstalk API allows for streamlined version control and release management within your development workflow. By leveraging the API with Pipedream, you can automate interactions with your repositories, changesets, and deployment environments. You can create workflows that react to code commits, manage deploy environments, and integrate with other services for a more cohesive development lifecycle.

Action 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.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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;
  },
};

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

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

Create Code Review with Beanstalk API on New File Created from OpenAI (ChatGPT) API

Pipedream makes it easy to connect APIs for Beanstalk, OpenAI (ChatGPT) and 2,900+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,900+apps by most popular

1
-
24
of
2,900+
apps by most popular