Customer.io Connector
Description
Customer.io is an automated messaging platform for marketing departments. This component allows creating, deleting, and tracking customers on the Customer.io platform through the Track API.
API Documentation
This component was built using the Customer.io Track API Reference.
Connections
API Key
key: apiKeyTo authenticate with Customer.io, both an API Key and a Site ID are required. The Customer.io API Key serves as the API Key, and the Site ID serves as the API Secret.
Prerequisites
- A Customer.io account with the Manage API credentials permission
Setup Steps
- Sign in to Customer.io and open the Integrations area for the workspace
- Select the Customer.io API settings
- Open the Track API Keys page to view the Site ID and API Key
- Copy the Site ID and API Key values
Refer to the Customer.io Track API Reference for additional details on authentication.
Configure the Connection
- Enter the API Key from the developer console into the API Key field
- Enter the Site Id from the developer console into the Site Id field
| Input | Notes | Example |
|---|---|---|
| API Key | Provide the API key from the developer console. | example-a131bf1767a7 |
| Site Id | Provide the Site Id obtained from the developer console. | example-a131bf1767a7 |
Actions
Destroy
Delete a customer by unique ID. | key: destroy
| Input | Notes | Example |
|---|---|---|
| Connection | The Customer.io connection to use. | |
| ID | The unique identifier that targets a specific customer record. | exampleCustomerId |
| Region | The region in which the account is configured. | US |
Example Payload for Destroy⤓
Identify
Create or update a customer. | key: identify
| Input | Notes | Example |
|---|---|---|
| Connection | The Customer.io connection to use. | |
| Customer Data | The key and value pairs that make up a customer record. The key must be a string, and the value can be a string, number, array, or object. | |
| ID | The unique identifier that targets a specific customer record. | exampleCustomerId |
| Region | The region in which the account is configured. | US |
When creating a customer it is important to keep in mind the required fields, as well as their correct datatypes that Customer.io expects.
When updating a customer, the id of the customer is required, along with any additional fields to update the customer with.
id: String or Number (required)
data: The key for this input must be a string. The value can be a string, number, array, boolean, or an object.
Example Payload for Identify⤓
Raw Request
Send raw HTTP request to Customer.io. | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | The Customer.io connection to use. | |
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| Debug Request | Enabling this flag will log out the current request. | false |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Method | The HTTP method to use. | |
| Query Parameter | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | |
| Region | The region in which the account is configured. | US |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | The path to append to the base URL. Enter the path only (for example, /v1/accounts/region); the base URL (https://track.customer.io/api) is already included. | /v1/accounts/region |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
Track
Track customer events. | key: track
| Input | Notes | Example |
|---|---|---|
| Connection | The Customer.io connection to use. | |
| Event Data | The key and value pairs that describe the event the customer performed. | |
| Event Name | The identifier recorded for the tracked event. | myCustomerEvent |
| ID | The unique identifier that targets a specific customer record. | exampleCustomerId |
| Region | The region in which the account is configured. | US |
Example Payload for Track⤓
Track Page View
Track a customer page view. | key: trackPageView
| Input | Notes | Example |
|---|---|---|
| Connection | The Customer.io connection to use. | |
| ID | The unique identifier that targets a specific customer record. | exampleCustomerId |
| Region | The region in which the account is configured. | US |
| URL | The page path to track. Enter the full path to track a specific page, or use the asterisk '*' to track any page. | www.example.com |
Example Payload for Track Page View⤓
Changelog
2026-06-29
Various modernizations and documentation updates
2026-04-30
Updated spectral version