Customer.io Component
Manage customers on the Customer.io platform
Component key: customer-io
Description
Customer.io is an automated messaging platform for marketing departments. This component allows you to create, delete and track customers on the Customer.io platform through the Track API.
Connections
API Key
An API key and SiteID are both required to interact with Customer.io. The Customer.io API Key serves as the API Key, and the Site ID serves as the API Secret. Read more about authentication in the Customer.io docs.
| 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 | ||
| ID | A customer Id is a unique identifier that lets you target a specific individual. | exampleCustomerId |
| Region | Provide the region in which your account is configured on. |
Identify
Create or update a customer | key: identify
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Customer Data | Provide key and value pairs that make up a customer record. The key must be a string, and the value can either be a string, number, array, or an object. | |
| ID | A customer Id is a unique identifier that lets you target a specific individual. | exampleCustomerId |
| Region | Provide the region in which your account is configured on. |
When creating a customer it is important to keep in mind the required fields, as well as their correct datatypes that Customer.io will expect you to provide.
When updating a customer you must provide the id of the customer, as well as any additional fields you would like 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.
Raw Request - Track API
Send raw HTTP request to Customer.io | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| 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. | 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 | Provide the region in which your account is configured on. | |
| 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. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | Input the path only (/v1/accounts/region), The base URL is already included (https://track.customer.io/api). For example, to connect to https://track.customer.io/api/v1/accounts/region, only /v1/accounts/region is entered in this field. | /v1/accounts/region |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. | false |
Track
Track customer events | key: track
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Event Data | Provide key and value pairs that describe the event that your customer performed. | |
| Event Name | Provide a string value for the name of the new event. | myCustomerEvent |
| ID | A customer Id is a unique identifier that lets you target a specific individual. | exampleCustomerId |
| Region | Provide the region in which your account is configured on. |
Track Page View
Track customer history | key: trackPageView
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| ID | A customer Id is a unique identifier that lets you target a specific individual. | exampleCustomerId |
| Region | Provide the region in which your account is configured on. | |
| URL | To track a specific page, enter the full path. To track any page, use the asterisk '*' | www.example.com |
{
"data": {}
}