Create Or Update Contact with Textline API on New Run State Changed from OpenAI (ChatGPT) API

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

Trigger workflow on

New Run State Changed from the OpenAI (ChatGPT) API

Next, do this

Create Or Update Contact with the Textline 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 Textline action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Run State Changed trigger
1. Connect your OpenAI (ChatGPT) account
2. Configure timer
3. Configure Thread ID
Configure the Create Or Update Contact action
1. Connect your Textline account
2. Select a Phone Number
3. Optional- Configure Email
4. Optional- Configure Name
5. Optional- Configure Notes
6. Optional- Configure Tags
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 Run State Changed on OpenAI (ChatGPT)

Description:Emit new event every time a run changes its status. [See the documentation](https://platform.openai.com/docs/api-reference/runs/listRuns)

Version:0.0.11

Key:openai-new-run-state-changed

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-run-state-changed",
  name: "New Run State Changed",
  description: "Emit new event every time a run changes its status. [See the documentation](https://platform.openai.com/docs/api-reference/runs/listRuns)",
  version: "0.0.11",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    threadId: {
      propDefinition: [
        common.props.openai,
        "threadId",
      ],
    },
  },
  methods: {
    ...common.methods,
    getStatusItems() {
      return this.db.get("statusItems");
    },
    setStatusItems(value) {
      this.db.set("statusItems", value);
    },
    async getData() {
      const {
        openai,
        threadId,
      } = this;

      const { data } = await openai.listRuns({
        threadId,
      });

      return data;
    },
    getMeta(item) {
      const ts = Date.now();
      return {
        id: `${item.id}-${ts}`,
        summary: `Run State Changed: ${item.id}`,
        ts,
      };
    },
    statusByItemId(itemId, statusItems) {
      const { [itemId]: status } = statusItems || {};
      return status;
    },
    buildStatusItems(data) {
      return data?.reduce((acc, item) => ({
        ...acc,
        [item.id]: item.status,
      }), {});
    },
    async getAndProcessItems(maxEvents) {
      const {
        getData,
        getStatusItems,
        setStatusItems,
        statusByItemId,
        buildStatusItems,
        getMeta,
        $emit: emit,
      } = this;

      const data = await getData();
      const statusItems = getStatusItems();

      Array.from(data)
        .reverse()
        .forEach((item, index) => {
          const statusChanged = statusByItemId(item.id, statusItems) !== item.status;
          if ((!maxEvents || index < maxEvents) && statusChanged) {
            emit(item, getMeta(item));
          }
        });

      setStatusItems(buildStatusItems(data));
    },
  },
  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`
Thread ID	`threadId`	`string`	The unique identifier for the thread. Example: `thread_abc123`. To locate the thread ID, make sure your OpenAI Threads setting (Settings -> Organization/Personal -> General -> Features and capabilities -> Threads) is set to "Visible to organization owners" or "Visible to everyone". You can then access the list of threads and click on individual threads to reveal their IDs

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 Or Update Contact on Textline

Description:Create or update a contact in the Textline address book. [See the documentation](https://textline.docs.apiary.io/#reference/customers/customers/create-a-customer).

Version:0.0.2

Key:textline-create-update-contact

View on GitHub

Action Code#

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

export default {
  key: "textline-create-update-contact",
  name: "Create Or Update Contact",
  description: "Create or update a contact in the Textline address book. [See the documentation](https://textline.docs.apiary.io/#reference/customers/customers/create-a-customer).",
  version: "0.0.2",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    app,
    phoneNumber: {
      propDefinition: [
        app,
        "phoneNumber",
      ],
    },
    email: {
      type: "string",
      label: "Email",
      description: "The email of the contact.",
      optional: true,
    },
    name: {
      type: "string",
      label: "Name",
      description: "The name of the contact.",
      optional: true,
    },
    notes: {
      type: "string",
      label: "Notes",
      description: "Notes about the contact.",
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "Tags associated with the contact.",
      optional: true,
    },
  },
  methods: {
    updateCustomer({
      uuid, ...args
    } = {}) {
      return this.app.put({
        path: `/customer/${uuid}`,
        ...args,
      });
    },
    createCustomer(args = {}) {
      return this.app.post({
        path: "/customers",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      app,
      updateCustomer,
      createCustomer,
      phoneNumber,
      email,
      name,
      notes,
      tags,
    } = this;

    let response;
    let uuid;

    try {
      response = await createCustomer({
        $,
        data: {
          customer: {
            phone_number: phoneNumber,
            email,
            name,
            notes,
            tags,
          },
        },
      });
    } catch (error) {
      if (error.response.status === 400 && error.response.data?.errors?.phone_number[0] === "Already in use") {

        ({ customer: { uuid } } = await app.getCustomerByPhoneNumber({
          $,
          params: {
            phone_number: phoneNumber,
          },
        }));

      } else {
        throw error;
      }
    }

    if (!uuid) {
      $.export("$summary", `Successfully created the contact with uuid \`${response.customer.uuid}\`.`);
      return response;
    }

    response = await updateCustomer({
      $,
      uuid,
      data: {
        customer: {
          email,
          name,
          notes,
          tags,
        },
      },
    });

    $.export("$summary", `Successfully updated the contact with uuid \`${uuid}\`.`);
    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
Textline	`app`	`app`	This component uses the Textline app.
Phone Number	`phoneNumber`	`string`	Select a value from the drop down menu.
Email	`email`	`string`	The email of the contact.
Name	`name`	`string`	The name of the contact.
Notes	`notes`	`string`	Notes about the contact.
Tags	`tags`	`string[]`	Tags associated with the contact.