Create Event with Heartbeat API on New Batch Completed from OpenAI (ChatGPT) API

Pipedream makes it easy to connect APIs for Heartbeat, OpenAI (ChatGPT) and 3,000+ other apps remarkably fast.

Trigger workflow on

New Batch Completed from the OpenAI (ChatGPT) API

Next, do this

Create Event with the Heartbeat 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 Heartbeat 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 Event action
1. Connect your Heartbeat account
2. Configure Name
3. Optional- Configure Description
4. Configure Start Date & Time
5. Configure Duration
6. Select a Location
7. Optional- Select one or more Invited Users
8. Optional- Select one or more Invited Groups
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.10

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.10",
  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 Event on Heartbeat

Description:Create a new Event in a Heartbeat community. [See the documentation](https://heartbeat.readme.io/reference/createevent)

Version:0.0.1

Key:heartbeat-create-event

View on GitHub

Heartbeat Overview#

The Heartbeat API offers a powerful way to connect and automate your community engagement. With this API, you can monitor community signals, manage members, and trigger events based on community interactions. By integrating Heartbeat with Pipedream, you can create dynamic, serverless workflows that act upon these signals and bring efficiency to your community management tasks. Whether it's automating welcome messages, syncing member data with other platforms, or analyzing community health, the possibilities are vast.

Action Code#

import { parseObject } from "../../common/utils.mjs";
import heartbeat from "../../heartbeat.app.mjs";

export default {
  key: "heartbeat-create-event",
  name: "Create Event",
  description: "Create a new Event in a Heartbeat community. [See the documentation](https://heartbeat.readme.io/reference/createevent)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    heartbeat,
    name: {
      type: "string",
      label: "Name",
      description: "The name of the event",
    },
    description: {
      type: "string",
      label: "Description",
      description: "The description of the event",
      optional: true,
    },
    startTime: {
      type: "string",
      label: "Start Date & Time",
      description: "The start date & time of the event. Accepts datetimes in the following formats: `YYYY-MM-DD hh:mm:ss` e.g. 2023-11-28 10:00:00, `YYYY-MM-DD hh:mm` e.g. 2023-11-28 10:00, `YYYY-MM-DD` e.g. 2023-11-28",
    },
    duration: {
      type: "integer",
      label: "Duration",
      description: "The duration of the event in minutes",
    },
    location: {
      type: "string",
      label: "Location",
      description: "Where the event will be held. If the string 'HEARTBEAT' is provided, then the event will take place in a Heartbeat voice channel. If the string 'ZOOM' is provided, then the event will take place in a custom Zoom link (this option can only be chosen if a Zoom account has been integrated with Heartbeat). Otherwise, the provided string will be passed directly to the Custom location field",
      options: [
        "HEARTBEAT",
        "ZOOM",
      ],
    },
    invitedUsers: {
      propDefinition: [
        heartbeat,
        "emails",
      ],
      type: "string[]",
      label: "Invited Users",
      description: "A list of users that should be invited to the event. If the email matches an existing Heartbeat user, the Heartbeat user will be invited. Otherwise, an event invite will be sent directly to the provided email address. If both `Invited Users` & `Invited Groups` are empty, the event will be open to everyone in the community",
      optional: true,
    },
    invitedGroups: {
      propDefinition: [
        heartbeat,
        "groupID",
      ],
      type: "string[]",
      label: "Invited Groups",
      description: "A list of groups that should be invited to the event. If both `Invited Users` and `Invited Groups` are empty, the event will be open to everyone in the community",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.heartbeat.createEvent({
      $,
      data: {
        name: this.name,
        description: this.description,
        startTime: this.startTime,
        duration: this.duration,
        location: this.location,
        invitedUsers: parseObject(this.invitedUsers),
        invitedGroups: parseObject(this.invitedGroups),
      },
    });

    $.export("$summary", `Successfully created event with ID ${response.event.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
Heartbeat	`heartbeat`	`app`	This component uses the Heartbeat app.
Name	`name`	`string`	The name of the event
Description	`description`	`string`	The description of the event
Start Date & Time	`startTime`	`string`	The start date & time of the event. Accepts datetimes in the following formats: `YYYY-MM-DD hh:mm:ss` e.g. 2023-11-28 10:00:00, `YYYY-MM-DD hh:mm` e.g. 2023-11-28 10:00, `YYYY-MM-DD` e.g. 2023-11-28
Duration	`duration`	`integer`	The duration of the event in minutes
Location	`location`	`string`	Select a value from the drop down menu:`HEARTBEATZOOM`
Invited Users	`invitedUsers`	`string[]`	Select a value from the drop down menu.
Invited Groups	`invitedGroups`	`string[]`	Select a value from the drop down menu.

Action Authentication#

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

To retrieve your API credentials,

Navigate to your Heartbeat account and sign in
Go to “Settings” > “API Keys”

Create Event with Heartbeat API on New Batch Completed from OpenAI (ChatGPT) API

Pipedream makes it easy to connect APIs for Heartbeat, OpenAI (ChatGPT) and 3,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular