Chat with OpenAI (ChatGPT) API on New Lead from Visitor Queue API

Pipedream makes it easy to connect APIs for OpenAI (ChatGPT), Visitor Queue and 1400+ other apps remarkably fast.

Trigger workflow on

New Lead from the Visitor Queue API

Next, do this

Chat with the OpenAI (ChatGPT) API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Visitor Queue trigger and OpenAI (ChatGPT) action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Lead trigger
1. Connect your Visitor Queue account
2. Configure Polling interval
3. Select a Data Views
Configure the Chat action
1. Connect your OpenAI (ChatGPT) account
2. Select a Model
3. Configure User Message
4. Optional- Configure System Instructions
5. Optional- Configure Prior Message History
6. Optional- Configure Max Tokens
7. Optional- Configure Temperature
8. Optional- Configure Top P
9. Optional- Configure N
10. Optional- Configure Stop
11. Optional- Configure Presence Penalty
12. Optional- Configure Frequency Penalty
13. Optional- Configure User
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 Lead on Visitor Queue

Description:Emit new event when a new Waiver sign is received. [See docs here](https://docs.visitorqueue.com/#4f021159-baae-e19d-bb7f-91a915e5b4ea)

Version:0.0.3

Key:visitor_queue-new-lead

View on GitHub

Visitor Queue Overview#

The Visitor Queue API is an application programming interface that simplifies
website visitor data capture, lead collection, and automation. With this API,
website owners can design, develop, and deploy more successful online
applications and experiences.

Using the Visitor Queue API, website owners can take full advantage of their
website visitor data to improve customer acquisition, sales, and more.

Examples of things you can achieve with the Visitor Queue API:

Something as simple as captures form information and send a tailored message
to the customer.
Generate leads with an interactive web form.
Track visitor behavior on a website and send user-specific alerts.
Create and populate visitor profiles to measure user engagement.
Automatically invite visitors to join a mailing list, schedule personalized
messages, or integrate with APIs and databases.
Trigger custom, automated sales campaigns from visitor behavior.
Detect, identify, and flag malicious website activity.
Gather usage data in order to optimize the website experience for visitors.
Create bespoke data visualizations and analytics to analyze the performance
and effectiveness of campaigns.

Trigger Code#

import moment from "moment";
import visitor_queue from "../../visitor_queue.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "visitor_queue-new-lead",
  name: "New Lead",
  description: "Emit new event when a new Waiver sign is received. [See docs here](https://docs.visitorqueue.com/#4f021159-baae-e19d-bb7f-91a915e5b4ea)",
  version: "0.0.3",
  dedupe: "unique",
  type: "source",
  props: {
    visitor_queue,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the Visitor Queue API on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    dataViews: {
      propDefinition: [
        visitor_queue,
        "dataViews",
      ],
    },
  },
  methods: {
    _getLastTime() {
      return this.db.get("lastTime");
    },
    _setLastTime(lastTime) {
      this.db.set("lastTime", lastTime);
    },
    getDataToEmit({
      id, name, last_visited_at,
    }) {
      return {
        id,
        summary: `New lead (${name})`,
        ts: new Date(last_visited_at).getTime(),
      };
    },
    async processEvent({
      params, lastTime,
    }) {
      const records = this.visitor_queue.paginate({
        fn: this.visitor_queue.listLeads,
        params,
      });

      for await (const record of records) {
        if (moment(record.last_visited_at).isAfter(lastTime))
          this._setLastTime(record.last_visited_at);

        this.$emit(record, this.getDataToEmit(record));
      }
    },
  },
  hooks: {
    async activate() {
      const lastTime = this._getLastTime();
      const leads = await this.visitor_queue.listLeads({
        params: {
          ga_view_id: this.dataViews,
          min_date: lastTime,
          per_page: 20,
        },
      });

      for (const lead of leads) {
        if (!lastTime || moment(lastTime).isAfter(lead.last_visited_at)) {
          this._setLastTime(lead.last_visited_at);
        }
        this.$emit(lead, this.getDataToEmit(lead));
      }
    },
  },
  async run() {
    const lastTime = this._getLastTime();
    const params = {
      ga_view_id: this.dataViews,
      min_date: lastTime,
    };

    return this.processEvent({
      params,
      lastTime,
    });
  },
};

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
Visitor Queue	`visitor_queue`	`app`	This component uses the Visitor Queue app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the Visitor Queue API on this schedule
Data Views	`dataViews`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

To get your API Key, go to the integrations page and in the "Utilize the Visitor Queue API" card, click "Generate API Key".

About Visitor Queue#

Visitor Queue is an advanced B2B lead generation software that identifies the name, contact details & user data of the businesses that visit your website.

Action#

Chat on OpenAI (ChatGPT)

Description:The Chat API, using the `gpt-3.5-turbo` or `gpt-4` model. [See docs here](https://platform.openai.com/docs/api-reference/chat)

Version:0.1.2

Key:openai-chat

View on GitHub

OpenAI (ChatGPT) Overview#

The OpenAI API is a powerful tool that provides access to a range of
high-powered machine learning models. With the OpenAI API, developers can
create products, services, and tools that enable humanizing AI experiences, and
build applications that extend the power of human language.

Using the OpenAI API, developers can create language-driven applications such
as:

Natural language understanding and sentiment analysis
Text-based search
Question answering
Dialogue systems and conversation agents
Intelligent text completion
Text summarization
Text classification
Machine translation
Language generation
Multi-factor authentication
Anomaly detection
Text analysis

Action Code#

import openai from "../../app/openai.app.mjs";
import common from "../common/common.mjs";

export default {
  ...common,
  name: "Chat",
  version: "0.1.2",
  key: "openai-chat",
  description: "The Chat API, using the `gpt-3.5-turbo` or `gpt-4` model. [See docs here](https://platform.openai.com/docs/api-reference/chat)",
  type: "action",
  props: {
    openai,
    modelId: {
      propDefinition: [
        openai,
        "chatCompletionModelId",
      ],
    },
    userMessage: {
      label: "User Message",
      type: "string",
      description: "The user messages provide instructions to the assistant. They can be generated by the end users of an application, or set by a developer as an instruction.",
    },
    systemInstructions: {
      label: "System Instructions",
      type: "string",
      description: "The system message helps set the behavior of the assistant. For example: \"You are a helpful assistant.\" [See these docs](https://platform.openai.com/docs/guides/chat/instructing-chat-models) for tips on writing good instructions.",
      optional: true,
    },
    messages: {
      label: "Prior Message History",
      type: "string[]",
      description: "_Advanced_. Because [the models have no memory of past chat requests](https://platform.openai.com/docs/guides/chat/introduction), all relevant information must be supplied via the conversation. You can provide [an array of messages](https://platform.openai.com/docs/guides/chat/introduction) from prior conversations here. If this param is set, the action ignores the values passed to **System Instructions** and **Assistant Response**, appends the new **User Message** to the end of this array, and sends it to the API.",
      optional: true,
    },
    ...common.props,
  },
  async run({ $ }) {
    const args = this._getChatArgs();
    const response = await this.openai.createChatCompletion({
      $,
      args,
    });

    if (response) {
      $.export("$summary", `Successfully sent chat with id ${response.id}`);
    }

    const { messages } = args;
    return {
      original_messages: messages,
      original_messages_with_assistant_response: messages.concat(response.choices[0]?.message),
      ...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
OpenAI (ChatGPT)	`openai`	`app`	This component uses the OpenAI (ChatGPT) app.
Model	`modelId`	`string`	Select a value from the drop down menu.
User Message	`userMessage`	`string`	The user messages provide instructions to the assistant. They can be generated by the end users of an application, or set by a developer as an instruction.
System Instructions	`systemInstructions`	`string`	The system message helps set the behavior of the assistant. For example: "You are a helpful assistant." See these docs for tips on writing good instructions.
Prior Message History	`messages`	`string[]`	Advanced. Because the models have no memory of past chat requests, all relevant information must be supplied via the conversation. You can provide an array of messages from prior conversations here. If this param is set, the action ignores the values passed to System Instructions and Assistant Response, appends the new User Message to the end of this array, and sends it to the API.
Max Tokens	`maxTokens`	`integer`	The maximum number of tokens to generate in the completion.
Temperature	`temperature`	`string`	Optional. What sampling temperature to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer.
Top P	`topP`	`string`	An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both.
N	`n`	`integer`	How many completions to generate for each prompt
Stop	`stop`	`string[]`	Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.
Presence Penalty	`presencePenalty`	`string`	Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.
Frequency Penalty	`frequencyPenalty`	`string`	Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
User	`user`	`string`	A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more here.