Chat using Web Search with OpenAI (ChatGPT) API on New Customer Created from ProAbono API

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

Trigger workflow on

New Customer Created from the ProAbono API

Next, do this

Chat using Web Search with the OpenAI (ChatGPT) 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 ProAbono 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 Customer Created trigger
1. Connect your ProAbono account
2. Configure timer
Configure the Chat using Web Search action
1. Connect your OpenAI (ChatGPT) account
2. Select a Model
3. Configure Chat Input
4. Optional- Configure Instructions
5. Optional- Configure Previous Response ID
6. Optional- Select a Truncation
7. Optional- Select one or more User Location
8. Optional- Select a Search Context Size
9. Optional- Select a Response Format
10. Optional- Configure Skip This Step
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 Customer Created on ProAbono

Description:Emit new event when a new customer is created. [See the documentation](https://docs.proabono.com/api/#list-customers)

Version:0.0.1

Key:proabono-new-customer-created

View on GitHub

ProAbono Overview#

ProAbono is a service built to manage subscription billing with fine-grained control over pricing, features, customers, and usage. With the ProAbono API, Pipedream can be your automation partner to streamline subscription operations. Use cases include synchronizing customer data, updating subscription details, and managing billing events. Pipedream's serverless platform allows you to trigger workflows on schedule, by webhook, or via other app events, making it ideal for integrating with ProAbono to handle complex subscription logic.

Trigger Code#

import common from "../common/base-polling.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "proabono-new-customer-created",
  name: "New Customer Created",
  description: "Emit new event when a new customer is created. [See the documentation](https://docs.proabono.com/api/#list-customers)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourceFn() {
      return this.proabono.listCustomers;
    },
    generateMeta(customer) {
      return {
        id: customer.Id,
        summary: `New Customer ${customer.Name || customer.Id}`,
        ts: Date.now(),
      };
    },
  },
  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
ProAbono	`proabono`	`app`	This component uses the ProAbono app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

To retrieve your API details,

Navigate to your ProAbono account and sign in
Go to “Integration” > “API”

When entering credentials to use the API Backoffice (under "API - extra"), for API Endpoint enter https://via.proabono.com if shown value is https://via.proabono.com?idBusiness=1234; for ID Business enter 1234.

About ProAbono#

ProAbono is the smart subscription management software that automates your daily routine.

Action#

Chat using Web Search on OpenAI (ChatGPT)

Description:Chat using the web search tool. [See the documentation](https://platform.openai.com/docs/guides/tools-web-search)

Version:0.0.3

Key:openai-chat-using-web-search

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";
import constants from "../../common/constants.mjs";

export default {
  ...common,
  name: "Chat using Web Search",
  version: "0.0.3",
  key: "openai-chat-using-web-search",
  description: "Chat using the web search tool. [See the documentation](https://platform.openai.com/docs/guides/tools-web-search)",
  type: "action",
  props: {
    openai,
    modelId: {
      type: "string",
      label: "Model",
      description: "Model used to generate the response",
      default: "gpt-4o",
      options: [
        "gpt-4o",
        "gpt-4o-mini",
      ],
    },
    input: {
      type: "string",
      label: "Chat Input",
      description: "Text inputs to the model used to generate a response",
    },
    instructions: {
      type: "string",
      label: "Instructions",
      description: "Inserts a system (or developer) message as the first item in the model's context",
      optional: true,
    },
    previousResponseId: {
      type: "string",
      label: "Previous Response ID",
      description: "The unique ID of the previous response to the model. Use this to create multi-turn conversations",
      optional: true,
    },
    truncation: {
      type: "string",
      label: "Truncation",
      description: "Specifies the truncation mode for the response if it's larger than the context window size",
      optional: true,
      default: "auto",
      options: [
        "auto",
        "disabled",
      ],
    },
    userLocation: {
      type: "string[]",
      label: "User Location",
      description: "Additional configuration for approximate location parameters for the search",
      optional: true,
      options: [
        "City",
        "Region",
        "Country",
        "Timezone",
      ],
    },
    searchContextSize: {
      type: "string",
      label: "Search Context Size",
      description: "Determines the amount of context to use during the web search",
      optional: true,
      default: "medium",
      options: [
        "low",
        "medium",
        "high",
      ],
    },
    responseFormat: {
      type: "string",
      label: "Response Format",
      description: "- **Text**: Returns unstructured text output.\n- **JSON Schema**: Enables you to define a [specific structure for the model's output using a JSON schema](https://platform.openai.com/docs/guides/structured-outputs?api-mode=responses).",
      options: [
        "text",
        "json_schema",
      ],
      default: "text",
      optional: true,
      reloadProps: true,
    },
    skipThisStep: {
      type: "boolean",
      label: "Skip This Step",
      description: "Pass in a boolean custom expression to skip this step's execution at runtime",
      optional: true,
      default: false,
    },
  },
  additionalProps() {
    const {
      responseFormat,
      userLocation,
    } = this;
    const props = {};

    if (userLocation?.includes("City")) {
      props.city = {
        type: "string",
        label: "City",
        description: "Free text input for the city of the user, e.g. `San Francisco`",
      };
    }

    if (userLocation?.includes("Region")) {
      props.region = {
        type: "string",
        label: "Region",
        description: "Free text input for the region of the user, e.g. `California`",
      };
    }

    if (userLocation?.includes("Country")) {
      props.country = {
        type: "string",
        label: "Country",
        description: "The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`",
      };
    }

    if (userLocation?.includes("Timezone")) {
      props.timezone = {
        type: "string",
        label: "Timezone",
        description: "The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`",
      };
    }

    if (responseFormat === constants.CHAT_RESPONSE_FORMAT.JSON_SCHEMA.value) {
      props.jsonSchema = {
        type: "string",
        label: "JSON Schema",
        description: "Define the schema that the model's output must adhere to. [Generate one here](https://platform.openai.com/docs/guides/structured-outputs/supported-schemas).",
      };
    }

    return props;
  },
  methods: {
    ...common.methods,
  },
  async run({ $ }) {
    if (this.skipThisStep) {
      $.export("$summary", "Step execution skipped");
      return;
    }

    const data = {
      model: this.modelId,
      input: this.input,
      instructions: this.instructions,
      previous_response_id: this.previousResponseId,
      truncation: this.truncation,
      tools: [
        {
          type: "web_search_preview",
          user_location: {
            type: "approximate",
            city: this.city,
            country: this.country,
            region: this.region,
            timezone: this.timezone,
          },
          search_context_size: this.searchContextSize,
        },
      ],
    };

    if (this.responseFormat === constants.CHAT_RESPONSE_FORMAT.JSON_SCHEMA.value) {
      try {
        data.text = {
          format: {
            type: this.responseFormat,
            ...JSON.parse(this.jsonSchema),
          },
        };
      } catch (error) {
        throw new Error("Invalid JSON format in the provided JSON Schema");
      }
    }

    const response = await this.openai.responses({
      $,
      data,
    });

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

    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
OpenAI (ChatGPT)	`openai`	`app`	This component uses the OpenAI (ChatGPT) app.
Model	`modelId`	`string`	Select a value from the drop down menu:`gpt-4ogpt-4o-mini`
Chat Input	`input`	`string`	Text inputs to the model used to generate a response
Instructions	`instructions`	`string`	Inserts a system (or developer) message as the first item in the model's context
Previous Response ID	`previousResponseId`	`string`	The unique ID of the previous response to the model. Use this to create multi-turn conversations
Truncation	`truncation`	`string`	Select a value from the drop down menu:`autodisabled`
User Location	`userLocation`	`string[]`	Select a value from the drop down menu:`CityRegionCountryTimezone`
Search Context Size	`searchContextSize`	`string`	Select a value from the drop down menu:`lowmediumhigh`
Response Format	`responseFormat`	`string`	Select a value from the drop down menu:`textjson_schema`
Skip This Step	`skipThisStep`	`boolean`	Pass in a boolean custom expression to skip this step's execution at runtime

Chat using Web Search with OpenAI (ChatGPT) API on New Customer Created from ProAbono API

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

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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