Create Session with Zoho Assist API on New Batch Completed from OpenAI (ChatGPT) API

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

Trigger workflow on

New Batch Completed from the OpenAI (ChatGPT) API

Next, do this

Create Session with the Zoho Assist 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 Zoho Assist 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 Create Session action
1. Connect your Zoho Assist account
2. Optional- Configure Customer Email
3. Optional- Select a Type
4. Optional- Configure Computer ID
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#

Create Session on Zoho Assist

Description:Create a remote support or screen sharing session. [See the documentation](https://www.zoho.com/assist/api/createasession.html)

Version:0.0.1

Key:zoho_assist-create-session

View on GitHub

Zoho Assist Overview#

The Zoho Assist API provides remote support and access functionalities, enabling automated session management, customer support, and IT operations. By integrating it with Pipedream, you can craft serverless workflows that respond to various triggers and perform actions like creating support sessions, fetching session details, or managing users. The API's versatility in Pipedream allows for streamlined coordination between support requests and responses, facilitating seamless IT support and management tasks.

Action Code#

import { defineAction } from "@pipedream/types";
import app from "../../app/zoho_assist.app.mjs";
import { CREATE_SESSION_TYPE_OPTIONS } from "../../common/constants.mjs";
export default defineAction({
    name: "Create Session",
    description: "Create a remote support or screen sharing session. [See the documentation](https://www.zoho.com/assist/api/createasession.html)",
    key: "zoho_assist-create-session",
    version: "0.0.1",
    type: "action",
    props: {
        app,
        customerEmail: {
            type: "string",
            label: "Customer Email",
            description: "Customer Email to whom the join invitation is to be sent.",
            optional: true,
        },
        type: {
            propDefinition: [
                app,
                "type",
            ],
            description: "Session type, defaulting to Remote Support.",
            optional: true,
            options: CREATE_SESSION_TYPE_OPTIONS,
            default: "rs",
        },
        computerId: {
            type: "string",
            label: "Computer ID",
            description: "URS (unattended remote support) key to initiate an unattended access session.",
            optional: true,
        },
    },
    async run({ $ }) {
        const { customerEmail, type, computerId, } = this;
        const params = {
            $,
            params: {
                customer_email: customerEmail,
                type,
                computer_id: computerId,
            },
        };
        const { representation } = await this.app.createSession(params);
        $.export("$summary", `Successfully created session (ID: ${representation.session_id})`);
        return representation;
    },
});

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
Zoho Assist	`app`	`app`	This component uses the Zoho Assist app.
Customer Email	`customerEmail`	`string`	Customer Email to whom the join invitation is to be sent.
Type	`type`	`string`	Select a value from the drop down menu:`{ "label": "Remote Support", "value": "rs" }{ "label": "Screen Sharing", "value": "dm" }`
Computer ID	`computerId`	`string`	URS (unattended remote support) key to initiate an unattended access session.

Action Authentication#

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

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

ZohoAssist.sessionapi.ALLZohoAssist.userapi.READZohoAssist.reportapi.READ