Find Product by Name with SwagUp API on New Batch Completed from OpenAI (ChatGPT) API

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

Trigger workflow on

New Batch Completed from the OpenAI (ChatGPT) API

Next, do this

Find Product by Name with the SwagUp 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 SwagUp action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Batch Completed trigger
1. Connect your OpenAI (ChatGPT) account
2. Configure timer
Configure the Find Product by Name action
1. Connect your SwagUp account
2. Configure Query
3. Optional- Select a Product Category
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 Batch Completed on OpenAI (ChatGPT)

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

Version:0.0.5

Key:openai-new-batch-completed

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 sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "openai-new-batch-completed",
  name: "New Batch Completed",
  description: "Emit new event when a new batch is completed in OpenAI. [See the documentation](https://platform.openai.com/docs/api-reference/batch/list)",
  version: "0.0.5",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    _getLastCompleted() {
      return this.db.get("lastCompleted") || 0;
    },
    _setLastCompleted(lastCompleted) {
      this.db.set("lastCompleted", lastCompleted);
    },
    getMeta(batch) {
      return {
        id: batch.id,
        summary: `Batch Completed with ID ${batch.id}`,
        ts: batch.completed_at * 1000,
      };
    },
    async getAndProcessItems(max) {
      const lastCompleted = this._getLastCompleted();
      let maxCompleted = lastCompleted;
      const results = this.openai.paginate({
        resourceFn: this.openai.listBatches,
        max,
      });
      const batches = [];
      for await (const batch of results) {
        if (batch.completed_at && batch.completed_at > lastCompleted) {
          batches.push(batch);
          maxCompleted = Math.max(batch.completed_at, maxCompleted);
        }
      }
      this._setLastCompleted(maxCompleted);
      batches.reverse().forEach((item) => this.$emit(item, this.getMeta(item)));
    },
  },
  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`

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#

Find Product by Name on SwagUp

Description:Search for a product by its name. [See docs here](https://support.swagup.com/en/articles/6757044-swagup-api-how-to-get-products-and-prices-from-swagup-catalog).

Version:0.0.1

Key:swagup-find-product-by-name

View on GitHub

SwagUp Overview#

The SwagUp API allows you to automate the creation and distribution of swag packs. You can programmatically design swag items, assemble them into packs, and manage orders and inventory. Integrating SwagUp with Pipedream opens up endless possibilities for sending personalized swag to customers, employees, or event attendees efficiently, aligning this delightful process with various triggers from other apps and services.

Action Code#

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

export default {
  key: "swagup-find-product-by-name",
  name: "Find Product by Name",
  description: "Search for a product by its name. [See docs here](https://support.swagup.com/en/articles/6757044-swagup-api-how-to-get-products-and-prices-from-swagup-catalog).",
  version: "0.0.1",
  type: "action",
  props: {
    swagup,
    query: {
      type: "string",
      label: "Query",
      description: "The query to filter on the product name",
    },
    category: {
      propDefinition: [
        swagup,
        "category",
      ],
      description: "A product category to filter on",
      optional: true,
    },
  },
  async run({ $ }) {
    const { results } = await this.swagup.listProducts({
      category: this.category,
    });
    const query = this.query.toLowerCase();
    const items = results.filter((product) => product.name.toLowerCase().includes(query));
    $.export("$summary", `Successfully found ${items.length} products`);
    return items;
  },
};

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
SwagUp	`swagup`	`app`	This component uses the SwagUp app.
Query	`query`	`string`	The query to filter on the product name
Product Category	`category`	`string`	Select a value from the drop down menu.

Action Authentication#

SwagUp uses OAuth authentication. When you connect your SwagUp account, Pipedream will open a popup window where you can sign into SwagUp and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any SwagUp API.

Pipedream requests the following authorization scopes when you connect your account:

openid