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 string / Required apiKey	Provide the API key from the developer console.	example-a131bf1767a7
Site Id string / Required siteId	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 connection / Required cioConnection
ID string / Required id	A customer Id is a unique identifier that lets you target a specific individual.	exampleCustomerId
Region string / Required region	Provide the region in which your account is configured on.

---

Identify

Create or update a customer | key: identify

Input	Notes	Example
Connection connection / Required cioConnection
Customer Data string / Required Key Value List customerData	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 string / Required id	A customer Id is a unique identifier that lets you target a specific individual.	exampleCustomerId
Region string / Required 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	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		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 string / Required region		Provide the region in which your account is configured on.
Response Type string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required 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 boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries.

---

Track

Track customer events | key: track

Input	Notes	Example
Connection connection / Required cioConnection
Event Data string Key Value List eventData	Provide key and value pairs that describe the event that your customer performed.
Event Name string / Required eventName	Provide a string value for the name of the new event.	myCustomerEvent
ID string / Required id	A customer Id is a unique identifier that lets you target a specific individual.	exampleCustomerId
Region string / Required region	Provide the region in which your account is configured on.

---

Track Page View

Track customer history | key: trackPageView

Input	Notes	Example
Connection connection / Required cioConnection
ID string / Required id	A customer Id is a unique identifier that lets you target a specific individual.	exampleCustomerId
Region string / Required region	Provide the region in which your account is configured on.
URL string / Required url	To track a specific page, enter the full path. To track any page, use the asterisk '*'	www.example.com

Example Payload for Track Page View

{
  "data": {}
}

---