Chat with Assistant with OpenAI (ChatGPT) API on Return Status Updated (Instant) from Loop Returns API

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

Trigger workflow on

Return Status Updated (Instant) from the Loop Returns API

Next, do this

Chat with Assistant with the OpenAI (ChatGPT) 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 Loop Returns trigger and OpenAI (ChatGPT) action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Return Status Updated (Instant) trigger
1. Connect your Loop Returns account
Configure the Chat with Assistant action
1. Connect your OpenAI (ChatGPT) account
2. Configure alert
3. Configure Message
4. Optional- Select a Assistant
5. Optional- Configure Name
6. Optional- Configure Instructions
7. Optional- Select a Model
8. Optional- Configure Thread ID
9. Optional- Select one or more Tool Types
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#

Return Status Updated (Instant) on Loop Returns

Description:Emit new event when the status of a return has been updated. [See the documentation](https://docs.loopreturns.com/reference/return-webhook)

Version:0.0.1

Key:loop_returns-return-status-updated-instant

View on GitHub

Loop Returns Overview#

The Loop Returns API enables merchants to automate and streamline their returns and exchanges process. It offers endpoints that allow you to initiate returns, update return states, and manage return-related data, all programmable to fit into your existing e-commerce and customer service workflows. With Pipedream, you can trigger workflows based on events in Loop, or use actions to call the Loop API directly, automating tasks like syncing return data with customer service platforms, updating inventory management systems, or even issuing refunds.

Trigger Code#

import common from "../common/webhook.mjs";
import events from "../common/events.mjs";

export default {
  ...common,
  key: "loop_returns-return-status-updated-instant",
  name: "Return Status Updated (Instant)",
  description: "Emit new event when the status of a return has been updated. [See the documentation](https://docs.loopreturns.com/reference/return-webhook)",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  methods: {
    ...common.methods,
    setReturnState(resource) {
      this.db.set(resource.id, resource.state);
    },
    getReturnState(returnId) {
      return this.db.get(returnId);
    },
    isResourceRelevant(resource) {
      const previousState = this.getReturnState(resource.id);

      if (!previousState) {
        return true;
      }

      return resource.state !== previousState;
    },
    processResource(resource) {
      if (this.isResourceRelevant(resource)) {
        this.setReturnState(resource);
        return this.$emit(resource, this.generateMeta(resource));
      }
      console.log("Skipping irrelevant resource", resource);
    },
    getResourcesFn() {
      return this.app.listReturns;
    },
    getEventData() {
      return {
        url: this.http.endpoint,
        topic: events.TOPIC.RETURN,
        trigger: events.TRIGGER.RETURN_UPDATED,
      };
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.updated_at);
      return {
        id: `${resource.id}-${ts}`,
        summary: `Return Status Updated: ${resource.order_name}`,
        ts,
      };
    },
  },
};

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
Loop Returns	`app`	`app`	This component uses the Loop Returns 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.

Trigger Authentication#

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

About Loop Returns#

The best return experience, for your customers and for your team.

Action#

Chat with Assistant on OpenAI (ChatGPT)

Description:Sends a message and generates a response, storing the message history for a continuous conversation. [See the documentation](https://platform.openai.com/docs/api-reference/runs/createThreadAndRun)

Version:0.0.11

Key:openai-chat-with-assistant

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:

Action Code#

import openai from "../../openai.app.mjs";
import common from "../common/common-assistants.mjs";

export default {
  ...common,
  key: "openai-chat-with-assistant",
  name: "Chat with Assistant",
  description: "Sends a message and generates a response, storing the message history for a continuous conversation. [See the documentation](https://platform.openai.com/docs/api-reference/runs/createThreadAndRun)",
  version: "0.0.11",
  type: "action",
  props: {
    openai,
    alert: {
      type: "alert",
      alertType: "info",
      content: "Looking to chat with your tools? Check out our individual actions: [Chat using Web Search](https://pipedream.com/apps/openai/actions/chat-using-web-search), [Chat using File Search](https://pipedream.com/apps/openai/actions/chat-using-file-search), and [Chat using Functions](https://pipedream.com/apps/openai/actions/chat-using-functions).",
    },
    message: {
      type: "string",
      label: "Message",
      description: "The message to send",
    },
    assistantId: {
      propDefinition: [
        openai,
        "assistant",
      ],
      description: "The assistant to use. Leave blank to create a new assistant",
      optional: true,
    },
    name: {
      propDefinition: [
        openai,
        "name",
      ],
    },
    instructions: {
      propDefinition: [
        openai,
        "instructions",
      ],
    },
    model: {
      propDefinition: [
        openai,
        "assistantModel",
      ],
      optional: true,
      default: "gpt-3.5-turbo",
    },
    threadId: {
      propDefinition: [
        openai,
        "threadId",
      ],
      description: "The unique identifier for the thread. Example: `thread_abc123`. Leave blank to create a new thread. To locate the thread ID, make sure your OpenAI Threads setting (Settings -> Organization/Personal -> General -> Features and capabilities -> Threads) is set to \"Visible to organization owners\" or \"Visible to everyone\". You can then access the list of threads and click on individual threads to reveal their IDs",
      optional: true,
    },
    ...common.props,
  },
  async run({ $ }) {
    // create assistant if not provided
    let assistantId = this.assistantId;
    if (!assistantId) {
      const { id: newAssistantId } = await this.openai.createAssistant({
        $,
        data: {
          model: this.model,
          name: this.name,
          instructions: this.instructions,
          tools: this.buildTools(),
          tool_resources: this.buildToolResources(),
        },
      });
      assistantId = newAssistantId;
    }

    // create and run thread if no thread is provided
    let threadId = this.threadId;
    let run;
    if (!threadId) {
      run = await this.openai.createThreadAndRun({
        $,
        data: {
          assistant_id: assistantId,
          thread: {
            messages: [
              {
                role: "user",
                content: this.message,
              },
            ],
          },
          model: this.model,
          instructions: this.instructions,
          tools: this.buildTools(),
          tool_resources: this.buildToolResources(),
        },
      });
      threadId = run.thread_id;
    } else {
      // create run for thread if threadId is provided
      run = await this.openai.createRun({
        $,
        threadId: this.threadId,
        data: {
          assistant_id: assistantId,
          model: this.model,
          instructions: this.instructions,
          tools: this.buildTools(),
          tool_resources: this.buildToolResources(),
          additional_messages: [
            {
              role: "user",
              content: this.message,
            },
          ],
        },
      });
    }
    const runId = run.id;

    run = await this.pollRunUntilCompleted(run, threadId, runId, $);

    // get response;
    const { data: messages } = await this.openai.listMessages({
      $,
      threadId,
      params: {
        order: "desc",
      },
    });
    const response = messages[0].content[0].text.value;
    return {
      response,
      messages,
      run,
    };
  },
};

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
OpenAI (ChatGPT)	`openai`	`app`	This component uses the OpenAI (ChatGPT) app.
Message	`message`	`string`	The message to send
Assistant	`assistantId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	The name of the assistant.
Instructions	`instructions`	`string`	The system instructions that the assistant uses.
Model	`model`	`string`	Select a value from the drop down menu.
Thread ID	`threadId`	`string`	The unique identifier for the thread. Example: `thread_abc123`. Leave blank to create a new thread. To locate the thread ID, make sure your OpenAI Threads setting (Settings -> Organization/Personal -> General -> Features and capabilities -> Threads) is set to "Visible to organization owners" or "Visible to everyone". You can then access the list of threads and click on individual threads to reveal their IDs
Tool Types	`toolTypes`	`string[]`	Select a value from the drop down menu:`code_interpreterfile_searchfunction`

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

More Ways to Connect OpenAI (ChatGPT) + Loop Returns#

Other Popular Integrations#

Flag Return with Loop Returns API on New File Created from OpenAI (ChatGPT) API

OpenAI (ChatGPT) + Loop Returns

Chat with Assistant with OpenAI (ChatGPT) API on Return Status Updated (Instant) from Loop Returns API

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

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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