Chat with OpenAI (ChatGPT) API on Link Clicked from Mailchimp API

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

Trigger workflow on

Link Clicked from the Mailchimp API

Next, do this

Chat with the OpenAI (ChatGPT) 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 Mailchimp 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 Link Clicked trigger
1. Connect your Mailchimp account
2. Configure timer
3. Select a Campaign ID
4. Select a Campaign Link
5. Configure Unique Clicks Only?
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 Images
7. Optional- Select a Response Format
8. Optional- Configure Max Tokens
9. Optional- Configure Temperature
10. Optional- Configure Top P
11. Optional- Configure N
12. Optional- Configure Stop
13. Optional- Configure Presence Penalty
14. Optional- Configure Frequency Penalty
15. 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#

Link Clicked on Mailchimp

Description:Emit new event when a recipient clicks a pre-specified link in an specific campaign.

Version:0.0.2

Key:mailchimp-link-clicked

View on GitHub

Mailchimp Overview#

The Mailchimp API taps into the heart of your email marketing efforts, allowing you to manage subscribers, campaigns, and reports. With the API, you can automate tasks like syncing subscriber lists, segmenting contacts based on behavior, and personalizing email content to match user profiles. It's a powerful tool for marketers looking to fine-tune their email strategy and maximize engagement.

Trigger Code#

import common from "../common/timer-based.mjs";

export default {
  ...common,
  key: "mailchimp-link-clicked",
  name: "Link Clicked",
  description: "Emit new event when a recipient clicks a pre-specified link in an specific campaign.",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    campaignId: {
      propDefinition: [
        common.props.mailchimp,
        "campaignId",
      ],
      description: "The unique ID of the campaign you'd like to watch for new clicks on links",
    },
    linkId: {
      propDefinition: [
        common.props.mailchimp,
        "linkId",
        (c) => ({
          campaignId: c.campaignId,
        }),
      ],
    },
    uniqueClicksOnly: {
      type: "boolean",
      label: "Unique Clicks Only?",
      description: "Whether to count every link click or only count clicks coming from each user only once",
      default: false,
    },
  },
  hooks: {
    async deploy() {
      // Emits sample events on the first run during deploy.
      return this.emitReportSampleEvents(this.campaignId, this.linkId, (Date.now()));
    },
  },
  methods: {
    ...common.methods,
    getEventTypes() {
      return [
        "clicks",
      ];
    },
    generateMeta({
      eventPayload,
      diff: clickDiff,
      timestamp: ts,
    }) {
      const { id: linkId } = eventPayload;
      return {
        id: `${linkId}-${ts}`,
        summary: `${clickDiff} new clicks`,
        ts,
      };
    },
    getCachedCampaignDetails() {
      return this.getDbServiceVariable("recipientClicks");
    },
    async getCampaignDetails() {
      return this.mailchimp.getCampaignClickDetailsForLink(
        this.campaignId,
        this.linkId,
      );
    },
    getNodataErrorMessage() {
      return "No data found for specified campaign and link.";
    },
    getCurrentCampaignDetails(report) {
      return this.uniqueClicksOnly
        ? report.unique_clicks
        : report.total_clicks;
    },
    getDetailsDiff(currentRecipientClicks, recipientClicks) {
      return currentRecipientClicks - recipientClicks;
    },
    cacheCampaignDetails(currentRecipientClicks) {
      if (isNaN(currentRecipientClicks)) {
        if (this.uniqueClicksOnly) {
          this.setDbServiceVariable("recipientClicks", currentRecipientClicks.unique_clicks);
        } else {
          this.setDbServiceVariable("recipientClicks", currentRecipientClicks.total_clicks);
        }
      } else {
        this.setDbServiceVariable("recipientClicks", currentRecipientClicks);
      }
    },
    clearCampaignDetailsCache() {
      this.setDbServiceVariable("recipientClicks", 0);
    },
  },
  async run() {
    return this.emitReportEvents();
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Mailchimp	`mailchimp`	`app`	This component uses the Mailchimp app.
	`timer`	`$.interface.timer`
Campaign ID	`campaignId`	`string`	Select a value from the drop down menu.
Campaign Link	`linkId`	`string`	Select a value from the drop down menu.
Unique Clicks Only?	`uniqueClicksOnly`	`boolean`	Whether to count every link click or only count clicks coming from each user only once

Trigger Authentication#

Mailchimp uses OAuth authentication. When you connect your Mailchimp account, Pipedream will open a popup window where you can sign into Mailchimp and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Mailchimp API.

Pipedream requests the following authorization scopes when you connect your account:

About Mailchimp#

Mailchimp is a marketing automation and email marketing platform.

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.9

Key:openai-chat

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:

Action Code#

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

export default {
  ...common,
  name: "Chat",
  version: "0.1.9",
  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,
    },
    images: {
      label: "Images",
      type: "string[]",
      description: "Provide one or more images to [OpenAI's vision model](https://platform.openai.com/docs/guides/vision). Accepts URLs or base64 encoded strings. Compatible with the `gpt4-vision-preview model`",
      optional: true,
    },
    responseFormat: {
      type: "string",
      label: "Response Format",
      description: "Specify the format that the model must output. [Setting to `json_object` guarantees the message the model generates is valid JSON](https://platform.openai.com/docs/api-reference/chat/create#chat-create-response_format). Defaults to `text`",
      options: [
        "text",
        "json_object",
      ],
      optional: true,
      default: "text",
    },
    ...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.
Images	`images`	`string[]`	Provide one or more images to OpenAI's vision model. Accepts URLs or base64 encoded strings. Compatible with the `gpt4-vision-preview model`
Response Format	`responseFormat`	`string`	Select a value from the drop down menu:`textjson_object`
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.

Chat with OpenAI (ChatGPT) API on Link Clicked from Mailchimp API

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

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

Developers ♥ Pipedream

1-24of2,000+apps by most popular

1
-
24
of
2,000+
apps by most popular