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.

Authorization Notes#

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.

Actions#

Destroy#

Delete a customer by unique ID | key: destroy

InputKeyNotesExample

ID

string
/ Required
idA customer Id is a unique identifier that lets you target a specific individual.exampleCustomerId

Region

string
/ Required
regionProvide the region in which your account is configured on.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Key / Secretapi_key_secretAPI Key / Secret Combination

API Key |  api_key

API Secret |  api_secret


Identify#

Create or update a customer | key: identify

InputKeyNotesExample

Customer Data

string
/ Required
customerDataProvide 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
idA customer Id is a unique identifier that lets you target a specific individual.exampleCustomerId

Region

string
/ Required
regionProvide 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.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Key / Secretapi_key_secretAPI Key / Secret Combination

API Key |  api_key

API Secret |  api_secret


Track#

Track customer events | key: track

InputKeyNotesExample

Event Data

string
eventDataProvide key and value pairs that describe the event that your customer performed.

Event Name

string
/ Required
eventNameProvide a string value for the name of the new event.myCustomerEvent

ID

string
/ Required
idA customer Id is a unique identifier that lets you target a specific individual.exampleCustomerId

Region

string
/ Required
regionProvide the region in which your account is configured on.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Key / Secretapi_key_secretAPI Key / Secret Combination

API Key |  api_key

API Secret |  api_secret


Track Page View#

Track customer history | key: trackPageView

InputKeyNotesExample

ID

string
/ Required
idA customer Id is a unique identifier that lets you target a specific individual.exampleCustomerId

Region

string
/ Required
regionProvide the region in which your account is configured on.

URL

string
/ Required
urlTo track a specific page, enter the full path. To track any page, use the asterisk '*'www.example.com

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Key / Secretapi_key_secretAPI Key / Secret Combination

API Key |  api_key

API Secret |  api_secret

Output Example Payload#

{  "data": {}}