See what the ShipHawk integration can do →
These instructions walk through subscribing to the ShipHawk integration in iPaaS.com and connecting it to your ShipHawk account.
Before You Begin
You need a ShipHawk API Key to connect the integration. Generate one in the ShipHawk portal under Settings > Developer API and keep it handy for the Authentication Configuration step below.
Installation Instructions for Integration Setup
In iPaaS.com, go to Subscriptions and select Search Certified Integration Marketplace.
Locate the ShipHawk tile in the marketplace.
Open the ShipHawk product details and select Subscribe.
Give the subscription a name using the pattern [Product Name] - [Environment/Purpose] — for example, ShipHawk - Production.
Leave Create Default Mappings checked to install the default ShipHawk mapping collections. Uncheck it only if you intend to build the mappings from scratch.
On the Subscription Settings page, enter the connection values:
API Url: your ShipHawk API URL, provided by ShipHawk for your account, in the form https://[tenant].tms.myshiphawk.com (for example, https://sandbox-example.tms.myshiphawk.com for a sandbox).
API Key: the ShipHawk API Key from Settings > Developer API.
Review the throttle and concurrency fields. These are pre-populated with the integration's values — API Throttle Limit 500, API Throttle Seconds 60, Concurrent Connections 2, and Concurrent Batch Executions 10 (with matching TO iPaaS.com fields). Reduce them if you encounter rate limit errors.
Select Apply to save the subscription.
Authentication Configuration
ShipHawk uses API Key authentication.
Sign in to the ShipHawk portal.
Go to Settings > Developer API.
Copy the API Key.
Paste it into the API Key field on the ShipHawk Subscription Settings page in iPaaS.com and select Apply.
To rotate the credential later, generate a new API Key in ShipHawk and update the API Key field on the subscription.
Operational Configuration
The subscription's throttle and concurrency fields control how quickly iPaaS.com sends requests to ShipHawk:
API throttle limit and throttle interval cap how many requests are sent within a time window.
Concurrent connections and concurrent batch executions cap how many requests and batch transfers run at once.
They are pre-populated with the integration's recommended values. For details on adjusting them, see the Subscription Configuration – Edit Help Center article.
Post-Installation Verification
After the subscription is applied:
Confirm the subscription saved without a connection error.
Run a Manual Sync from the subscription for a known record — for example, an order that already exists in iPaaS.com — and confirm the transfer completes. If the API Key or API Url is incorrect, the transfer fails with an authentication error (see Error Messages below).
Error Messages
"X-Api-Key header is missing or invalid": the ShipHawk API Key in the iPaaS.com Subscription Settings is missing, expired, or incorrect. Generate a new API Key in the ShipHawk portal under Settings > Developer API and update the subscription.
Support and Troubleshooting
iPaaS.com API documentation: https://support.ipaas.com/en/articles/10280417-api-introduction
iPaaS.com Support Portal: https://support.ipaas.com/en/
iPaaS.com Contact: https://ipaas.com/contact-us/
For ShipHawk account or API questions, contact ShipHawk support through the ShipHawk portal.