Appearance
Customer.io Pipelines API
Send customer data to Customer.io via the Segment-compatible Pipelines (CDP) API: identify people, track events, record pageviews and screen views, associate users with groups, merge profiles, and batch multiple calls.
| Detail | Value |
|---|---|
| Category | Analytics |
| Base URL | https://cdp.customer.io/v1 |
| Authentication | Basic Auth |
| Endpoints | 7 |
| Connector key | customer-io-pipelines-api |
Using Customer.io Pipelines API in a workflow
- Go to Connections and click New Connection.
- Pick Customer.io Pipelines API from the marketplace.
- Enter your credentials (see Authentication above for what's expected).
- In a workflow, drop an API Call node and select this connection.
- Pick the operation you need from the Operation dropdown. The full list is below.
Available endpoints
| Endpoint | Summary |
|---|---|
POST /identify | Add and Update People |
POST /track | Track events |
POST /page | Track pageviews |
POST /screen | Track mobile screenviews |
POST /group | Create objects and relationships |
POST /alias | Merge profiles |
POST /batch | Batch requests |
Each endpoint is documented in full below. Use the outline on the right to jump to one.
POST /identify
Add and Update People
| Detail | Value |
|---|---|
| Operation ID | identify |
| Method | POST |
| Path | /identify |
Parameters
No parameters.
Request Body
| Field | Type |
|---|---|
userId | string |
anonymousId | string |
traits | object |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Customer.io Pipelines API connection from the Connection dropdown.
- In the Operation dropdown, select
identify. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
Required fields are marked: fill them or the call will fail at runtime.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Customer.io Pipelines API API reference.
POST /track
Track events
| Detail | Value |
|---|---|
| Operation ID | track |
| Method | POST |
| Path | /track |
Parameters
No parameters.
Request Body
| Field | Type |
|---|---|
userId | string |
event | string |
properties | object |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Customer.io Pipelines API connection from the Connection dropdown.
- In the Operation dropdown, select
track. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
Required fields are marked: fill them or the call will fail at runtime.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Customer.io Pipelines API API reference.
POST /page
Track pageviews
| Detail | Value |
|---|---|
| Operation ID | page |
| Method | POST |
| Path | /page |
Parameters
No parameters.
Request Body
| Field | Type |
|---|---|
userId | string |
name | string |
properties | object |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Customer.io Pipelines API connection from the Connection dropdown.
- In the Operation dropdown, select
page. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
Required fields are marked: fill them or the call will fail at runtime.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Customer.io Pipelines API API reference.
POST /screen
Track mobile screenviews
| Detail | Value |
|---|---|
| Operation ID | screen |
| Method | POST |
| Path | /screen |
Parameters
No parameters.
Request Body
| Field | Type |
|---|---|
userId | string |
name | string |
properties | object |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Customer.io Pipelines API connection from the Connection dropdown.
- In the Operation dropdown, select
screen. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
Required fields are marked: fill them or the call will fail at runtime.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Customer.io Pipelines API API reference.
POST /group
Create objects and relationships
| Detail | Value |
|---|---|
| Operation ID | group |
| Method | POST |
| Path | /group |
Parameters
No parameters.
Request Body
| Field | Type |
|---|---|
userId | string |
groupId | string |
traits | object |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Customer.io Pipelines API connection from the Connection dropdown.
- In the Operation dropdown, select
group. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
Required fields are marked: fill them or the call will fail at runtime.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Customer.io Pipelines API API reference.
POST /alias
Merge profiles
| Detail | Value |
|---|---|
| Operation ID | alias |
| Method | POST |
| Path | /alias |
Parameters
No parameters.
Request Body
| Field | Type |
|---|---|
userId | string |
previousId | string |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Customer.io Pipelines API connection from the Connection dropdown.
- In the Operation dropdown, select
alias. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
Required fields are marked: fill them or the call will fail at runtime.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Customer.io Pipelines API API reference.
POST /batch
Batch requests
| Detail | Value |
|---|---|
| Operation ID | batch |
| Method | POST |
| Path | /batch |
Parameters
No parameters.
Request Body
| Field | Type |
|---|---|
batch | array |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Customer.io Pipelines API connection from the Connection dropdown.
- In the Operation dropdown, select
batch. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
Required fields are marked: fill them or the call will fail at runtime.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Customer.io Pipelines API API reference.