Create Employee with Axonaut API on New Batch Completed from OpenAI (ChatGPT) API

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

Trigger workflow on

New Batch Completed from the OpenAI (ChatGPT) API

Next, do this

Create Employee with the Axonaut 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 Axonaut 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 Employee action
1. Connect your Axonaut account
2. Select a Company ID
3. Configure First Name
4. Configure Last Name
5. Configure Email
6. Optional- Configure Phone Number
7. Optional- Configure Custom Fields
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 Employee on Axonaut

Description:Creates a employee. [See documentation (Go to `POST /api/v2/employees`)](https://axonaut.com/api/v2/doc)

Version:0.0.1

Key:axonaut-create-employee

View on GitHub

Axonaut Overview#

The Axonaut API enables interaction with Axonaut's CRM and ERP features, allowing you to manage customers, invoices, quotes, and more. By building workflows on Pipedream with the Axonaut API, you can automate repetitive tasks, sync data between different systems, and create custom, scalable solutions for your business needs. Connect Axonaut to numerous other services via Pipedream to streamline your sales, accounting, and operational processes.

Action Code#

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

export default {
  name: "Create Employee",
  version: "0.0.1",
  key: "axonaut-create-employee",
  description: "Creates a employee. [See documentation (Go to `POST /api/v2/employees`)](https://axonaut.com/api/v2/doc)",
  type: "action",
  props: {
    app,
    companyId: {
      propDefinition: [
        app,
        "companyId",
      ],
    },
    firstName: {
      label: "First Name",
      description: "The first name of the employee",
      type: "string",
    },
    lastName: {
      label: "Last Name",
      description: "The last name of the employee",
      type: "string",
    },
    email: {
      label: "Email",
      description: "The email of the employee",
      type: "string",
    },
    phoneNumber: {
      label: "Phone Number",
      description: "The phone number of the employee",
      type: "string",
      optional: true,
    },
    customFields: {
      label: "Custom Fields",
      description: "The custom fields of the employee. E.g `{ \"myCustomField\": \"myCustomValue\" }`",
      type: "string",
      optional: true,
    },
  },
  async run({ $ }) {
    const customFields = typeof this.customFields === "string"
      ? JSON.parse(this.customFields)
      : this.customFields;

    const response = await this.app.createEmployee({
      $,
      data: {
        company_id: this.companyId,
        firstname: this.firstName,
        lastname: this.lastName,
        email: this.email,
        phone_number: this.phoneNumber,
        custom_fields: customFields,
      },
    });

    if (response) {
      $.export("$summary", `Successfully created employee with ID ${response.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
Axonaut	`app`	`app`	This component uses the Axonaut app.
Company ID	`companyId`	`string`	Select a value from the drop down menu.
First Name	`firstName`	`string`	The first name of the employee
Last Name	`lastName`	`string`	The last name of the employee
Email	`email`	`string`	The email of the employee
Phone Number	`phoneNumber`	`string`	The phone number of the employee
Custom Fields	`customFields`	`string`	The custom fields of the employee. E.g `{ "myCustomField": "myCustomValue" }`

Action Authentication#

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

To retrieve your API key,