Create User Invitation with Clerk API on New File Created from OpenAI (ChatGPT) API

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

Trigger workflow on

New File Created from the OpenAI (ChatGPT) API

Next, do this

Create User Invitation with the Clerk API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a OpenAI (ChatGPT) trigger and Clerk 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
Configure the Create User Invitation action
1. Connect your Clerk account
2. Configure Email Address
3. Optional- Configure Public Metadata
4. Optional- Configure Redirect URL
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.0.6

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 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.0.6",
  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,
    },
  },
  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,
      };
    },
  },
  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`

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 User Invitation on Clerk

Description:Creates a new invitation for the given email address and sends the invitation email. Keep in mind that you cannot create an invitation if there is already one for the given email address. Also, trying to create an invitation for an email address that already exists in your application will result to an error. [See the documentation](https://clerk.com/docs/reference/backend-api/tag/Invitations#operation/CreateInvitation)

Version:0.0.1

Key:clerk-create-user-invitation

View on GitHub

Clerk Overview#

The Clerk API lets you manage user authentication and create secure, delightful user experiences in your apps. Within Pipedream's serverless platform, you can harness this API to automate workflows that trigger on user events, sync user data across apps, and maintain robust user management without the heavy lifting of building authentication infrastructure from scratch.

Action Code#

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

export default {
  key: "clerk-create-user-invitation",
  name: "Create User Invitation",
  version: "0.0.1",
  description: "Creates a new invitation for the given email address and sends the invitation email. Keep in mind that you cannot create an invitation if there is already one for the given email address. Also, trying to create an invitation for an email address that already exists in your application will result to an error. [See the documentation](https://clerk.com/docs/reference/backend-api/tag/Invitations#operation/CreateInvitation)",
  type: "action",
  props: {
    clerk,
    emailAddress: {
      type: "string",
      label: "Email Address",
      description: "The email address the invitation will be sent to.",
    },
    publicMetadata: {
      propDefinition: [
        clerk,
        "publicMetadata",
      ],
      description: "Metadata that will be attached to the newly created invitation. The value of this property should be a well-formed JSON object. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.",
      optional: true,
    },
    redirectUrl: {
      type: "string",
      label: "Redirect URL",
      description: "Optional URL which specifies where to redirect the user once they click the invitation link. This is only required if you have implemented a [custom flow](https://clerk.com/docs/custom-flows/invitations#custom-flow) and you're not using Clerk Hosted Pages or Clerk Components.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.clerk.createUserInvitation({
      $,
      data: {
        email_address: this.emailAddress,
        public_metadata: parseObject(this.publicMetadata),
        redirect_url: this.redirectUrl,
      },
    });

    $.export("$summary", `A new invitation with Id: ${response.id} was successfully created!`);
    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
Clerk	`clerk`	`app`	This component uses the Clerk app.
Email Address	`emailAddress`	`string`	The email address the invitation will be sent to.
Public Metadata	`publicMetadata`	`object`	Metadata that will be attached to the newly created invitation. The value of this property should be a well-formed JSON object. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.
Redirect URL	`redirectUrl`	`string`	Optional URL which specifies where to redirect the user once they click the invitation link. This is only required if you have implemented a custom flow and you're not using Clerk Hosted Pages or Clerk Components.