Integrate iPaaS.com with OpenAI to enrich Customer and Product records with generated content during orchestration.
How to Connect
Prerequisites
Before configuring the subscription, complete the following in your OpenAI account. Full step-by-step instructions, including screenshots, are in the OpenAI Installation Instructions.
An OpenAI account with API access. Sign in at https://platform.openai.com.
An API key. Only the account owner can create one. When creating the key, choose Restricted permissions and grant at least Write on the Responses capability — the integration cannot submit or retrieve an enrichment without it.
A safe copy of the key. OpenAI displays the secret once, at creation. If it is lost it cannot be recovered and a new key must be created.
A webhook pointed at your subscription. OpenAI returns enrichment results by calling iPaaS.com, and the subscriber creates that webhook in the OpenAI console. It cannot be created from iPaaS.com. The address is built from the subscription's Webhook API Key, which only appears after the subscription settings have been saved — so this step comes last.
Configuration Details
Three values are needed to connect a subscription:
API Url: the OpenAI API address the integration calls. The subscription ships with the standard production address already filled in, so in most cases this needs no change. Example: https://api.openai.com/v1/
API Key: the secret key created above, used to authenticate every request. Example: sk-proj-XXXXXXXXXXXXXXXXXXXXXXXX
OpenAI Model: the model that processes enrichment requests. This determines both the character and the cost of the generated output. Example: gpt-5-nano
Configure Subscription Settings
Open the subscription and complete the fields below, then click Apply.
Field | Description | Required | Example |
API Url | The OpenAI API address the integration calls. Pre-filled with the production address. | Yes | |
API Key | The secret key created in the OpenAI console. Authenticates every request. | Yes | sk-proj-XXXXXXXXXXXXXXXXXXXXXXXX |
OpenAI Model | The model used to process enrichment requests. Governs the character and cost of the output. | Yes | gpt-5-nano |
API Throttle Limit | The number of API requests the subscription may issue within the throttle window. | Yes | 5 for initial setup; 500 for ongoing and high-volume operation |
API Throttle Seconds | The length of the window over which the throttle limit is measured. | Yes | 60 |
Concurrent Connections | The maximum number of simultaneous API connections the subscription may hold open. Requests beyond the limit are queued until a connection frees up. | Yes | Default 5, up to 10 |
Concurrent Batch Executions | The maximum number of batch executions that may run at once. Requests beyond the limit are queued. | Yes | Default 5, up to 10 |
After clicking Apply, refresh the page. A Webhook API Key appears on the subscription:
Copy this value. It is used to build the webhook address that OpenAI calls when an enrichment completes, and it must be URL-encoded before being pasted into the OpenAI console. The OpenAI Installation Instructions cover the encoding step and the full webhook procedure.
Authentication Methods
OpenAI authenticates with a secret API key rather than an interactive sign-in, so there is no consent screen and no token to refresh.
Enter the API Url and the API Key on the subscription and click Apply.
iPaaS.com immediately validates the credentials by making a lightweight call to OpenAI. If OpenAI rejects the key, the connection is not established and the reason is reported on the subscription.
Once validated, every subsequent request carries the key automatically. No further action is required.
Rotating the key: create a new key in the OpenAI console, paste it into API Key, and click Apply. The new key is validated on save. Revoke the old key in the OpenAI console only after the new one has validated successfully, so no enrichment in flight is interrupted.
Enrichment results travel in the opposite direction and are authenticated differently: OpenAI calls iPaaS.com using the Webhook API Key embedded in the webhook address. Treat that address as a secret — anyone holding it can post to the subscription. OpenAI also issues a signing secret when the webhook is created; keep it safe, though no iPaaS.com setting consumes it at present.
Initialization Support
Currently, initialization is not supported for OpenAI in iPaaS.com. All data synchronization and mappings must be configured manually during the integration process.
To enrich a large existing population of Customers or Products, use bulk sync using Postman, which drives the same transfers the integration uses for individual records. Enrichment consumes OpenAI account usage on every record, so size the run deliberately before starting it.
Throttling
The throttle fields on the subscription are pre-populated by the integration's settings and control how quickly iPaaS.com issues requests to OpenAI. API Throttle Limit and API Throttle Seconds work together as a rate — the number of requests permitted within each window — while Concurrent Connections and Concurrent Batch Executions cap how much work runs at the same moment.
Starting at a low throttle limit during initial setup and raising it for ongoing operation lets configuration problems surface on a handful of records rather than across the whole catalogue.
These limits govern iPaaS.com's side of the exchange. OpenAI applies its own limits independently, and when it reports that its rate has been exceeded the transfer is rescheduled automatically and resumes once the limit window has passed — no subscriber action is required and no data is lost. Account-level usage and billing tiers are managed in the OpenAI account and are outside what these settings control.
For a full description of every subscription configuration field, see the Subscription Configuration - Edit article.