See what the OpenAI integration can do →
Before You Begin
Before installing the OpenAI subscription, you need to generate an API Key so that OpenAI and iPaaS.com can send and receive data to and from each other.
Log in to your OpenAI account at https://platform.openai.com
Click the Settings gear icon in the upper-right of the console.
In the left navigation bar, click API Keys.
Click Create a new secret key. Only the account owner can create the key.
In the Create new secret key dialog, enter a descriptive Name and select a Project.
Select Restricted permissions.
Under Model capabilities, select the desired permissions. At a minimum, select Write permission for Responses. You can select other permission levels if needed.
Click Create secret key.
In the Save your key dialog, click Copy and save your secret key in a secure file. If you lose it, you must recreate it.
Click Done.
Note: the permission granted here matters beyond setup. iPaaS.com confirms the connection using a lightweight call that needs fewer permissions than enrichment does, so a key restricted below Write on Responses validates successfully and then fails when the first transfer runs.
With the API Key, you can create your subscription.
Installation Instructions for Integration Setup
Go to Subscriptions, click Search Certified Integration Marketplace, and Subscribe.
Click the OpenAI integration tile.
Click the Subscribe button.
Enter the name of the subscription and select a version. It can be set to any relevant and unique subscription name within the company where this subscription is created.
Format: [Product Name] - [Environment/Purpose]
Example: OpenAI - Release
Select Create Default Mappings (recommended). If you don't want to create default mappings and want to create all mappings by yourself, then un-check this box.
Provide the API Url endpoint for your OpenAI subscription. For example:
Production: https://api.openai.com/v1/
Enter the OpenAI API Key you created in Before You Begin.
Enter the OpenAI Model for this subscription, such as gpt-5-nano. This determines both the character and the cost of the generated output.
Enter the API Throttle Limit. This setting prevents any single integration or user from overwhelming the system with too many requests. It protects system performance by controlling the number of API requests that can run simultaneously, ensuring fair usage.
Recommended Values
Initial Setup: 5
Ongoing Operations: 500
High Volume: 500
Enter the API Throttle Seconds. This defines the time window during which the API Throttle Limit is measured. If an integration makes too many requests within this time window, additional requests are rejected until the window resets.
Default Value: 60 seconds
Enter the number of Concurrent Connections. This specifies the maximum number of simultaneous API connections that the subscription can process for a user or integration. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Enter the number of Concurrent Batch Executions. This specifies the maximum number of simultaneous batch executions that can process for an integration at one time. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Click Apply to save the settings.
Refresh the page. You should see a Webhook API Key on the page:
Click the Copy icon. You will use the webhook in your OpenAI account.
Authentication Configuration
OpenAI authenticates with a secret API key rather than an interactive sign-in, so there is no consent screen and no token to refresh.
API Key
Location: OpenAI console → Settings → API Keys → Create a new secret key.
Description: authenticates every request iPaaS.com makes to OpenAI. Must carry at least Write permission on the Responses capability.
Required: Yes.
API Url
Location: supplied by the subscription, pre-filled with OpenAI's production address.
Description: the OpenAI API address the integration calls.
Required: Yes.
Webhook API Key
Location: generated by iPaaS.com and shown on the subscription settings page after clicking Apply and refreshing.
Description: authenticates OpenAI's calls back into iPaaS.com when an enrichment completes. It is embedded in the webhook address you build in the next section.
Required: Yes, for enrichment results to be returned.
Important Notes
The OpenAI secret key is displayed once, at creation. If it is lost it cannot be recovered and a new key must be created.
Only the OpenAI account owner can create a key.
Treat the completed webhook address as a secret — anyone holding it can post to your subscription.
To rotate the API Key, create the new key in the OpenAI console, paste it into API Key, and click Apply. Revoke the old key only after the new one has validated, so no enrichment in flight is interrupted.
Using the iPaaS.com Webhook API
OpenAI returns each enrichment result by calling iPaaS.com. That webhook is created in the OpenAI console — iPaaS.com does not register it for you — so this step is required before any enriched data comes back.
Before OpenAI can use the webhook, you need to encode the URL. One online tool you can use is at https://urlencoder.org
To create the webhook in OpenAI:
Return to your OpenAI console.
In the left column, click Webhooks, and then click Create.
Type a descriptive name and paste the webhook URL, constructed from two parts. First the URL, https://api.ipaas.com/hookapi/v2/dynamic/OpenAI? followed by the token after the ? For example: https://api.ipaas.com/hookapi/v2/dynamic/OpenAI?AuthToken=54w645q635446fafg6aer46q3854
Paste the fully constructed URL in the URL box.
Under Event types, select response.completed.
In the Save your signing secret dialog, copy the signing secret and keep it secure.
Click Create, and then click Done.
Note: the response.completed event is the only one the integration needs. Every enrichment result — Customer and Product alike — arrives through it and is routed on the iPaaS.com side.
Operational Configuration
Automatic transfers do not activate on their own. To have Customers or Products submitted for enrichment without a manual step, open the subscription configuration's Outbound Data Flows section and subscribe the relevant triggers to the corresponding mapping collection:
customer/created and customer/updated for Customer enrichment.
product/created and product/updated for Product enrichment.
Until those subscriptions are enabled, enrichment runs only through Manual Sync.
Each collection also ships with an example instruction in its PromptText mapping. These are demonstrations, not business rules, and should be replaced before go-live. See the OpenAI Known Limitations article for the full list of values to review.
Post-Installation Verification
After completing the installation, perform these tests to verify the installation.
Connection Test
Confirm the subscription saved without a connection error after clicking Apply.
Confirm a Webhook API Key is present on the subscription settings page.
Data Sync Test
Initiate a sample data pull (To iPaaS.com).
Initiate a sample data push (From iPaaS.com).
Functionality Test
Run an end-to-end business process.
Validate key features like field mappings, workflow triggers, and logging.
Review integration logs in iPaaS.com.
Note: enrichment completes in the background, so the enriched values do not appear the moment the outbound transfer finishes. Allow time for OpenAI to complete and call back before treating a transfer as failed.
Error Messages
Errors appear under Dashboard / Integration Monitoring / Error Logs. The full catalog, with the cause and resolution for each message, is in the OpenAI Error Messages article.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or to search our documentation.
Support Portal: https://support.ipaas.com/en/
Contact Information: https://ipaas.com/contact-us/
For OpenAI account, billing, or API availability issues, use OpenAI's own support channels from https://platform.openai.com.