Send a Document with UltraMsg API on New File Created from OpenAI (ChatGPT) API

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

Trigger workflow on

New File Created from the OpenAI (ChatGPT) API

Next, do this

Send a Document with the UltraMsg 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 UltraMsg 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 Send a Document action
1. Connect your UltraMsg account
2. Select a To
3. Configure Document
4. Configure Filename
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#

Send a Document on UltraMsg

Description:Send a document to a specified number. [See the docs here](https://docs.ultramsg.com/api/post/messages/document)

Version:0.0.2

Key:ultramsg-send-document

View on GitHub

UltraMsg Overview#

UltraMsg API offers a suite of messaging capabilities that let you automate WhatsApp messaging. With it, you can send and receive messages, create WhatsApp chatbots, and manage media, enabling a wide range of automated interactions with users. Pipedream acts as a powerful accelerator here, letting you connect UltraMsg to hundreds of other apps to craft custom workflows.

Action Code#

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

export default {
  name: "Send a Document",
  description: "Send a document to a specified number. [See the docs here](https://docs.ultramsg.com/api/post/messages/document)",
  key: "ultramsg-send-document",
  version: "0.0.2",
  type: "action",
  props: {
    ultramsg,
    to: {
      propDefinition: [
        ultramsg,
        "to",
      ],
    },
    document: {
      type: "string",
      label: "Document",
      description: "Public URL of your document",
    },
    filename: {
      type: "string",
      label: "Filename",
      description: "The name of your file",
    },
  },
  async run({ $ }) {
    const {
      to,
      document,
      filename,
    } = this;

    const data = {
      to,
      document,
      filename,
    };
    const res = await this.ultramsg.sendDocument(data, $);
    $.export("$summary", `Document successfully sent to "${to}"`);

    return res;
  },
};

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
UltraMsg	`ultramsg`	`app`	This component uses the UltraMsg app.
To	`to`	`string`	Select a value from the drop down menu.
Document	`document`	`string`	Public URL of your document
Filename	`filename`	`string`	The name of your file