See what the Pimcore integration can do →
This guide walks through connecting Pimcore to iPaaS.com. The setup has three parts: configure the Pimcore Datahub GraphQL API, configure a Datahub webhook that notifies iPaaS.com of changes, and create and configure the iPaaS.com Pimcore subscription. Complete them in order.
Before You Begin
NOTE: The Pimcore-side steps require administrative access to your Pimcore instance and its Datahub configuration. Contact your Pimcore administrator or IT department if you do not have the required permissions. |
You will need:
A Pimcore instance with the Datahub (GraphQL) bundle installed, and permission to create and edit Datahub configurations. Refer to the Pimcore documentation for installing and enabling the Datahub bundle if it is not already available.
An iPaaS.com account with permission to create a subscription.
Part 1: Configure the Pimcore Datahub GraphQL API
The integration reads product data from a Pimcore Datahub GraphQL configuration. Create or locate a suitable configuration and expose the classes you intend to transfer.
In Pimcore, open Datahub and create or locate a GraphQL configuration. Note its name — you will enter it in iPaaS.com later as the Datahub Config.
2. On the Schema Definition tab, add the query schema for the top-level classes you will integrate — your product and product category classes (for example, Car as the product and Category as the product category). Only top-level entities need to be added here.
3. For each class, open its field settings and add every field the integration will use. Ensure the system fields
IDandclassnameare included for each class — the integration requires them to build the external ids that link records together.4. On the Security Definition tab, create or note an API key, and add the object paths for the data objects you will use under Workspaces / Objects. If you will use the image URL or image id functions, also grant read permission to the asset paths in use.
5. Keep introspection enabled during setup. Introspection is used to discover field names and paths while you configure the integration; it is not required by the integration once configuration is complete, and it is not recommended to check Disable Introspection during implementation.
Part 2: Configure the Datahub Webhook
The webhook lets Pimcore notify iPaaS.com automatically when a record changes.
Copy your iPaaS.com subscription webhook key from the subscription settings page in iPaaS.com. (Create the subscription first — see Part 3 — if you have not already.)
2. In Pimcore, create or identify a Datahub webhook configuration. Refer to the Pimcore documentation for how to create a webhook configuration if needed.
3. On the Events tab, add the events pimcore.dataobject.postAdd and pimcore.dataobject.postUpdate. 4. Under Schema Definition → Data Objects, include the classes you will receive notifications for.
5. On the Subscribers tab, build the subscriber URL by combining the iPaaS.com webhook endpoint with your webhook key in a key query-string parameter. Use the endpoint for your iPaaS.com environment: - Staging: https://stagingapi.ipaas.com/hookapi/v2/dynamic/Pimcore.v2?key=YOUR_WEBHOOK_KEY - Production: https://api.ipaas.com/hookapi/v2/dynamic/Pimcore.v2?key=YOUR_WEBHOOK_KEY 6. Enter the resulting URL in the Subscribers list and press enter.
Check the Active checkbox to enable the webhook, then save the configuration.
Part 3: Create and Configure the iPaaS.com Subscription
In iPaaS.com, go to Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the Pimcore integration tile.
Click Subscribe.
Enter a Name for the subscription and select a Version. Use a name that is unique and meaningful within your company.
Format: [Product Name] - [Environment/Purpose]
Example: Pimcore - Production
Leave Create Default Mappings checked (recommended) to install the example mapping collections that demonstrate the integration. Uncheck it only if you intend to build every mapping yourself.
6. Enter the subscription settings. The connection fields (API URL, API Key, Datahub Config) and the class-name settings are described in detail, with examples, in the Pimcore Connections and Settings article. Enter the values from the Datahub configuration you set up in Part 1.
7. Review the throttling settings, which come pre-populated with recommended defaults: - API Throttle Limit — the number of requests allowed within the throttle window. Recommended values: 5 for initial setup, 500 for ongoing operations. - API Throttle Seconds — the throttle window, in seconds. Default: 60. - Concurrent Connections and Concurrent Batch Executions — control how many requests run at once; leave the pre-populated defaults unless you have a reason to change them. See the Subscription Configuration – Edit article for details. 8. Click Apply to save the settings.
Authentication Configuration
The integration uses two keys, both created during the steps above:
Datahub API Key — iPaaS.com uses this to query your Pimcore Datahub GraphQL endpoint.
Location: Pimcore Datahub → your GraphQL configuration → Security Definition tab.
Entered in iPaaS.com as the API Key subscription setting.
iPaaS.com Subscription Webhook Key — Pimcore uses this to send change notifications to iPaaS.com.
Location: the iPaaS.com Pimcore subscription settings page.
Placed in the Pimcore Datahub webhook subscriber URL as the key query-string parameter (Part 2).
NOTE: No login or token exchange is required. The Datahub API key is sent as a query-string parameter when iPaaS.com queries Pimcore, and the webhook key authenticates Pimcore's notifications to iPaaS.com. Keep both keys scoped to only the data the integration needs. |
Post-Installation Verification
After completing the setup, verify the integration:
Data Sync Test: From the iPaaS.com Manual Sync page, transfer a sample product by entering its Pimcore record id, and confirm the product is created in iPaaS.com with its expected fields, variants, and category assignments.
Webhook Test: Update a product in Pimcore and confirm the change transfers to iPaaS.com automatically.
Review logs: Open Dashboard → Integration Monitoring → Error Logs in iPaaS.com to confirm there are no errors from the test transfers.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or search the documentation.
Support Portal: https://support.ipaas.com/en/
Contact: https://ipaas.com/contact-us/














