OpenAI Installation Instructions
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 (/v1/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.
With the API Key, you can create your subscription.
Installation Instructions for Integration Setup
Go to Subscriptions and 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.
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
Range: 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
Using the iPaaS.com Webhook API
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
The URL:
https://.ipaas.com/hookapi/v2/dynamic/OpenAI/Product?The Token after the ? in the URL.
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.
Post-Installation Verification
After completing the installation, perform these tests to verify the installation.
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.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or to search our documentation.
Documentation: Search our documentation at the top of this article
Support Portal: Click the Help and Support button at the lower-right of this window.
Contact Information: Contact iPaaS.com.