Journeys Track API
Download OpenAPI specification:Download
Our Track API provides ways to send real-time customer data to your Customer.io workspace.
These APIs are for the United States (US) region
If your account is based in the European Union (EU) data center, you should switch to the EU region's API documentation. While we redirect traffic from US track API endpoints to EU-based accounts, this traffic still passes through US servers and data may be logged in the US. Our App APIs are not redirected this way, and will fail (401) if you send your request to the wrong regional endpoint.
These APIs are for the European Union (EU) region
If your account is based in the United States (US) data center, requests to EU endpoints will fail. Switch to the US region's API documentation.
Customer.io hosts services in the United States (US) and European Union (EU, host subdomains are suffixed with
-eu). Select the appropriate region for server addresses that apply to your region.
|Use the Track API to report customer attributes and track customer events/activity. You cannot retrieve data using this API. Track endpoints support minimal validation to ensure as close to real-time processing as possible.|
We've generated a Postman collection with all of our APIs—not just the ones on this page—with a starter environment (called "CIO Env") containing variables for authorization and path parameters.
If you fork this collection, you might want to disable the Watch original collection option. We automatically update our Postman collection whenever we release changes to our documentation, even if we don't change our APIs—which happens daily! Rather than being flooded with Postman notifications, you can check out our Release Notes for updates to our APIs.
NOTE: Postman endpoints default to our US APIs. If you're in our European (EU) region, you'll need to add
-eu server variables (track_api_url and app_api_url).
You can find all of your API authentication information in your Account Settings. Our Tracking API uses HTTP basic authorization. The App API uses bearer authorization, and you can generate tokens supporting different scopes. Each operation in this document references the authorization header it requires.
The Track API uses a basic authentication scheme. Your credentials are your Site ID and your API key, Base-64 encoded in the format
You can find your Site ID and API key on the Track API Keys page.
|Security Scheme Type||HTTP|
|HTTP Authorization Scheme||basic|
This new version of our edge API has only two endpoints, but supports the majority of our traditional v1 track operations and then some based on the
action keys that you set in your request.
You can use the
/batch call to send multiple requests at the same time. Unlike the v1 API, you can also make requests affecting objects and deliveries. Objects are a grouping mechanism for people—like an account people belong to or an online course that they enroll in. Deliveries are events based on messages sent from Customer.io.
The chart below lists the type of
action you can perform for each
type. Our requests below are broken out by
type; use the
action dropdown to see the specific payload structure for each action.