Skip to main content

ShipHawk Connections and Settings

How to connect iPaaS.com to ShipHawk: prerequisites, credential fields, subscription settings, authentication, and throttling.

Integrate iPaaS.com with ShipHawk to enable data synchronization for orders and shipment tracking.

How to Connect

Prerequisites

Before configuring the integration in iPaaS.com, set up the following in ShipHawk:

  • A ShipHawk account with access to the Developer API.

  • A ShipHawk API Key. Generate one in the ShipHawk portal under Settings > Developer API.

Configuration Details

Two values are needed to connect iPaaS.com to ShipHawk:

  • API Url: the ShipHawk API URL for your account. ShipHawk provides a tenant-specific URL in the form https://<tenant>.tms.myshiphawk.com (for example, a sandbox URL such as https://sandbox-example.tms.myshiphawk.com). Use your account's production URL for a live account, or your sandbox URL for testing.

  • API Key: the key that authorizes iPaaS.com to call the ShipHawk API on your behalf. Copy it from Settings > Developer API in the ShipHawk portal.

Configure Subscription Settings

Enter the connection values on the ShipHawk subscription settings page in iPaaS.com.

ShipHawk Subscription Settings page in iPaaS.com showing the API Url and API Key fields

Field

Description

Required

Example

API Url

Your ShipHawk API URL, provided by ShipHawk for your account (form: https://[tenant].tms.myshiphawk.com).

Yes

API Key

The ShipHawk API Key that authorizes API access, copied from Settings > Developer API in ShipHawk.

Yes

(your ShipHawk API Key)

Authentication Methods

ShipHawk uses API Key authentication. iPaaS.com authenticates every ShipHawk API request using the API Key entered on the subscription settings page — no separate sign-in or token exchange is required. To rotate the credential, generate a new API Key in the ShipHawk portal under Settings > Developer API and update the API Key field on the ShipHawk subscription settings page in iPaaS.com.

Initialization Support

Currently, initialization is not supported for ShipHawk in iPaaS.com. All data synchronization and mappings must be configured during the integration setup. To load a large set of existing records, use the bulk sync using Postman approach.

Throttling

The subscription's throttle and concurrency fields control how quickly iPaaS.com sends requests to ShipHawk. They are pre-populated with the integration's values:

  • API Throttle Limit: 500

  • API Throttle Seconds: 60

  • Concurrent Connections: 2

  • Concurrent Batch Executions: 10

Matching throttle fields are provided for the TO iPaaS.com direction. As the settings page notes, reduce these values if you encounter rate limit errors. For details on these fields, see the Subscription Configuration – Edit Help Center article.

Related Documents

Did this answer your question?