Skip to main content
Customer.io logo

​
Overview

Add Customer.io to any ModuleX agent or workflow. Customer profile sync, event tracking, and manual-segment membership management against the Customer.io Track API v1.
Categories: Marketing & Advertising · Marketing & Email · Social Media · Customer Support · Auth: API Key · Actions: 3

​
Authentication

​
API Key Authentication

Authenticate using your Customer.io Site ID and API Key

​
Required Credentials

FieldDescriptionRequiredFormat
Site IDYour Customer.io Site ID (Settings > Workspace Settings > API Credentials)Noxxxxxxxx-xxxx-xxxx
API KeyYour Customer.io Tracking API Key (Settings > Workspace Settings > API Credentials)Yesxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
RegionCustomer.io data region: ‘US’ (default, track.customer.io) or ‘EU’ (track-eu.customer.io). Must match the workspace’s region.NoUS

​
Available Actions

​
Parameters

​
customer_id
string
required
The unique identifier for the customer
​
email
string
required
The customer’s email address
​
created_at
integer
UNIX timestamp from when the user was created in your system
​
attributes
object
Custom attributes (name, plan, company, etc.)

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Message"
    },
    "customer_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Customer Id"
    },
    "email": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Email"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateOrUpdateCustomerOutput",
  "type": "object"
}

​
Parameters

​
customer_id
string
required
The unique identifier for the customer
​
event_name
string
required
The name of the event to track
​
event_type
string
Event type modifier (set to ‘page’ for page views)
​
data
object
Custom data to include with the event

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Message"
    },
    "customer_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Customer Id"
    },
    "event_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Event Name"
    }
  },
  "required": [
    "success"
  ],
  "title": "SendEventOutput",
  "type": "object"
}

​
Parameters

​
segment_id
string
required
The segment ID
​
customer_ids
array
required
List of customer IDs (max 1000)
​
id_type
string
The type of IDs: ‘id’, ‘email’, or ‘cio_id’ (Default: id)

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Message"
    },
    "segment_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Segment Id"
    },
    "customer_count": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Customer Count"
    },
    "id_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id Type"
    }
  },
  "required": [
    "success"
  ],
  "title": "AddCustomersToSegmentOutput",
  "type": "object"
}

​
Limits & Quotas

  • Manual segment add: max 1000 customer IDs per call (enforced client-side; the tool returns success=False if the cap is exceeded).
  • All actions are idempotent on the Customer.io side.

Klaviyo

Mailchimp

Pinterest