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.

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

Actions

Destroy

Delete a customer by unique ID | key: destroy

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

---

Identify

Create or update a customer | key: identify

Input	Notes	Example
Input Connection connection / Required cioConnection	Notes	Example
Input Customer Data string / Required Key Value List customerData	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 id	Notes A customer Id is a unique identifier that lets you target a specific individual.	Example exampleCustomerId
Input Region string / Required region	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.

---

Raw Request - Track API

Send a raw request to Customer.io | key: rawRequest

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

---

Track

Track customer events | key: track

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

---

Track Page View

Track customer history | key: trackPageView

Input	Notes	Example
Input Connection connection / Required cioConnection	Notes	Example
Input ID string / Required id	Notes A customer Id is a unique identifier that lets you target a specific individual.	Example exampleCustomerId
Input Region string / Required region	Notes Provide the region in which your account is configured on.	Example
Input URL string / Required url	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": {}}

---