Skip to main content

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.

Customer.io 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.

InputNotesExample
Input
API Key
string
/ Required
Notes
Provide the API key from the developer console.
Example
example-a131bf1767a7
Input
Site Id
string
/ Required
Notes
Provide the Site Id obtained from the developer console.
Example
example-a131bf1767a7

Actions#

Destroy#

Delete a customer by unique ID | key: destroy

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
ID
string
/ Required
Notes
A customer Id is a unique identifier that lets you target a specific individual.
Example
exampleCustomerId
Input
Region
string
/ Required
Notes
Provide the region in which your account is configured on.
Example
 

Identify#

Create or update a customer | key: identify

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Customer Data
string
/ Required
Key Value List
Notes
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.
Example
 
Input
ID
string
/ Required
Notes
A customer Id is a unique identifier that lets you target a specific individual.
Example
exampleCustomerId
Input
Region
string
/ Required
Notes
Provide the region in which your account is configured on.
Example
 

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.


Track#

Track customer events | key: track

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

Track Page View#

Track customer history | key: trackPageView

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

Output Example Payload#

{  "data": {}}