Overview
OpenAI processes and updates the customer data based on the PromptText instructions. The response is then transformed back into the iPaaS customer model using the TO iPaaS.com mappings.
This integration ensures that essential customer fields such as CustomerNumber, FirstName, LastName, and EmailAddress are accurately transferred, maintaining data consistency across both platforms.
Before You Begin
Ensure the following prerequisites are in place before configuring this integration.
OpenAI Requirements
Valid API Secret Key with read permissions for Customer data.
Customer records must exist in OpenAI before sync.
API rate limits may apply based on OpenAI subscription tier.
iPaaS.com Requirements
Access token with create/update permissions for Customer API.
Customer must have a valid EmailAddress for successful creation.
Create custom fields for Last Response Date, Known to Film, and Last Prompt Text. If default mappings reference these fields, the system creates them automatically.
ID Format
The customer identifier (Id) is returned as part of a conversation response. To manually sync a customer, enter this identifier into the iPaaS.com input field on the manual sync page.
Mapping Collection Status
Mapping Status: Enabled
Trigger Events: Manual, Customer Create, Update. Manual Sync TO works only if a Customer has been sent.
Conflicting Mappings
This mapping applies only to OpenAI Customer data. Ensure no other mappings target the same iPaaS.com Customer entity to prevent data from being overwritten.
Supported Child Collections
This integration does not support any child collections.
Authentication and Security
OpenAI API Key: Used to authenticate requests to the OpenAI API for retrieving Customer data.
Integration Flow
The integration processes OpenAI customer records as follows:
The integration is triggered manually from the iPaaS sync page.
iPaaS authenticates with the OpenAI API using the configured API Key.
OpenAI returns customer data that was originally passed to it during the conversation. This data is only available if customer information was included in the initial request. .
Field mappings are applied between OpenAI and iPaaS.com.
The Customer record is updated in iPaaS.com.
Custom field values (Last Response Date, Last Prompt Text) are populated.
Sync results are logged for troubleshooting and are available for use by other processes.
Mappings
OpenAI Add/Update Customer TO iPaaS
Description
This mapping collection updates customer data from OpenAI to iPaaS.com Customer records. The flow maps identity fields, contact information, and OpenAI-specific metadata to custom fields.
Mapping Type | Source (OpenAI) | Destination (iPaaS) | Description |
Dynamic Formula |
| OpenAI Last Response Date (custom field) | Returns the current date and time when the sync occurs. |
Field | OpenAI Last Response ID | OpenAI Last Response ID | Maps the OpenAI Last Response ID to the iPaaS OpenAI Last Response ID. |
Field | Known to Film | Known to Film (custom field) | Maps the OpenAI Known to Film flag to the iPaaS custom field. |
Field | PromptText | OpenAI Last Prompt Text (custom field) | Maps the OpenAI PromptText to the iPaaS OpenAI Last Prompt Text. |
Field | CustomerNumber | CustomerNumber | Maps the OpenAI CustomerNumber to the iPaaS CustomerNumber. |
Field | FirstName | FirstName | Maps the OpenAI FirstName to the iPaaS FirstName. |
Field | LastName | LastName | Maps the OpenAI LastName to the iPaaS LastName. |
Field | EmailAddress | EmailAddress | Maps the OpenAI EmailAddress to the iPaaS EmailAddress. |
Field | Comment | Comment | Maps the OpenAI Comment to the iPaaS Comment. |
Error Handling
Missing Required Field
Required field is missing.
Description: iPaaS rejected a Customer create or update request due to missing required fields.
Resolution: Ensure CustomerNumber, FirstName, LastName, and EmailAddress are populated.
Authentication Failure
OpenAI API authentication failed.
Description: The API Secret Key was rejected by OpenAI.
Resolution: Verify the API Secret Key is valid and has appropriate permissions.
Invalid Email Format
EmailAddress validation failed.
Description: The EmailAddress field contains an invalid email format.
Resolution: Ensure the EmailAddress is properly formatted before syncing.
Validation and Testing
Before deploying this integration, verify the following configuration items and run the test scenarios to confirm proper operation.
Validation Checklist
CustomerNumber is present.
FirstName and LastName are present.
EmailAddress is valid and properly formatted.
OpenAI API credentials are valid.
Custom fields exist in iPaaS for OpenAI-specific data.
Test Scenarios
Scenario 1: Update Existing Customer
Update an existing Customer in OpenAI and sync to iPaaS. Verify changes are reflected without creating duplicate records.
Scenario 2: Missing Email (Failure Case)
Attempt to sync a Customer without an EmailAddress. Verify the system returns an appropriate error and logs the failure.
Scenario 3: Missing Required Fields (Failure Case)
Attempt to sync a Customer without CustomerNumber, FirstName, or LastName. Verify the integration returns an error and does not create an incomplete record.
Scenario 4: Custom Field Transfer
Sync a Customer with OpenAI-specific fields (Last Response ID, PromptText, Known to Film). Verify all custom field values transfer correctly to iPaaS.
Scenario 4: Authentication Failure (Failure Case)
Attempt to sync with invalid OpenAI API credentials. Verify the system returns an authentication error and logs the failure.
Additional Notes
Ensure dynamic formulas return valid references for all dependent entities.
Custom fields must be created in iPaaS.com before syncing OpenAI-specific data.
The OpenAI Last Response Date field captures the timestamp of each sync operation.
API rate limits may vary based on OpenAI subscription tier.
This integration supports manual sync only; polling events are not available.