What partners get
- Stable REST + JSON contract with OpenAPI 3.1 source of truth
- Scoped Partner API keys with server-side rate limiting and separate test and live access controls
- Load sync, tracking visibility, customer and carrier lookups, and webhook subscriptions
- Interactive API reference generated from the same canonical contract
What this portal is for
This portal is designed to help partner engineers, solution architects, and integration agents move from first read to implementation without guessing at payload shape, environment rules, or Trailflow-specific workflow assumptions. Use it to understand the operational model behind the API, not just the endpoint surface. The guides explain how load sync, tracking, customer and carrier lookups, webhook subscriptions, idempotent writes, and go-live coordination fit together in real Trailflow integrations.Start here
- Read the overview.
- Review the API overview and the access and environments guide.
- Review authentication and request rules and errors and limits.
- Implement the load sync flow.
- Configure webhooks if the integration needs push delivery.
- Use the examples and payloads page for representative requests and responses.
- Review versioning and compatibility and SDK and tooling.
- Use the onboarding package for credential exchange and go-live guidance.
- Explore the interactive API reference for endpoint-level details.
Testing model
- Trailflow uses one production host:
https://api.trailflow.ai - New partners should start with
testkeys - Approved partner admins may self-serve additional
testkeys after test access is enabled livekeys remain Trailflow-managed and are reserved for approved production use- Trailflow does not currently provide a separate public sandbox host
Contract shape
Primary resources:loadstrackingcustomerscarrierswebhooks
POST /v1/loads, POST /v1/loads/upsert, POST /v1/loads/{id}/status, and POST /v1/webhooks.
Rate limits are checked before replay lookup, so duplicate requests can still receive 429 rate_limited.
For troubleshooting, include request timestamps and requestId. Never send raw API keys or webhook signing secrets over email or chat.