Integration setup guide
One place for authentication, endpoints, and payload routes for all supported integrations.
Authentication
Workspace ingestion endpoints use:
X-API-Key: {your API key from Settings → API Integration}Merchant push (create only) uses:
X-Shipper-API-Key: {per-client key from Settings → Merchant portals}Ingestion endpoints
| Integration | Endpoint |
|---|---|
| Shopify (Settings connect) | Settings → API Integration → Shopify |
| Shopify webhook | POST {YOUR_API_HOST}/api/v1/webhooks/shopify |
| Shopify (advanced push) | POST {YOUR_API_HOST}/api/v1/delivery-tasks/push/shopify/orders |
| WooCommerce (Settings connect) | Settings → API Integration → WooCommerce |
| WooCommerce webhook | POST {YOUR_API_HOST}/api/v1/webhooks/woocommerce |
| WooCommerce (advanced push) | POST {YOUR_API_HOST}/api/v1/delivery-tasks/push/woocommerce/orders |
| Zapier | POST {YOUR_API_HOST}/api/v1/delivery-tasks/push/zapier/tasks |
| Google Sheets | POST {YOUR_API_HOST}/api/v1/delivery-tasks/push/google-sheets/rows |
| CSV import | POST {YOUR_API_HOST}/api/v1/delivery-tasks/push/csv/rows |
| Generic API push | POST {YOUR_API_HOST}/api/v1/delivery-tasks/push |
| Cancel or delete one task | POST {YOUR_API_HOST}/api/v1/delivery-tasks/push/cancel-or-delete |
| Reschedule one task | POST {YOUR_API_HOST}/api/v1/delivery-tasks/push/reschedule |
| Export tasks | GET {YOUR_API_HOST}/api/v1/delivery-tasks/push/export |
| Merchant push | POST {YOUR_API_HOST}/api/v1/shipper-clients/push/deliveries |
Shopify and WooCommerce Settings connect register webhooks and import orders automatically. Their push adapters map customer and address fields only (not COD, skills, or time windows). Sheets/CSV map more fields, including COD. Zapier and generic push accept the full task schema.
Webhooks (events out)
Circle Routes sends delivery events to your configured endpoint with:
Content-Type: application/json
X-API-Key: {YOUR_CONFIGURED_KEY}
User-Agent: Circle Routes/1.0Event types: route_started_initial, stops_upcoming, order_en_route, driver_arrived, delivery_completed, delivery_failed. Deliveries with a phone number only. Tracking URL and POD are not on the body.
Developer guide
Need full payload reference?
Share this with your engineering team for the complete integration reference including request/response examples and detailed endpoint behavior.