Skip to main content
Customer.io logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 24
  • Triggers: 0
  • Slug: CUSTOMERIO
  • Version: 20261101_00

Tools

Slug: CUSTOMERIO_ADD_PERSON_TO_GROUPAdd a person to a Customer.io group to establish a relationship with an object such as a company, account, or project. Supply the person and group IDs and optionally provide group traits.

Input Parameters

object
Key-value pairs representing attributes of the group. Examples: name, type, created_at, industry, etc.
string
required
A unique identifier for the person to add to the group. This is the person’s ID in your system.
string
required
A unique identifier for the group (object). This could represent a company, account, project, or any organizational entity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_CREATE_ALIASCreate an alias to merge Customer.io profiles for a person with multiple identifiers. The previous ID identifies the source profile and the user ID identifies the destination profile.

Input Parameters

string
required
The profile to merge into (destination). This is the canonical user identifier that will retain all data.
string
required
The profile to merge from (source). All data from this profile will be moved to the user_id profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_CUSTOMER_IO_SUPPRESS_PERSONSuppress a customer profile to permanently delete it and prevent re-adding with the same identifier. IMPORTANT: This action requires Track API credentials (Basic Auth with siteId:apiKey), not App API credentials. Suppression also deletes the customer profile - you don’t need to call a separate delete endpoint. Use this for GDPR/CCPA compliance requests. The operation is irreversible and prevents any future attempts to re-add a person with the same identifier (email or ID).

Input Parameters

string
required
The unique identifier for the person to suppress. Can be a customer ID (numeric), email address, or Customer.io ID (prefixed with ‘cio_’). The person will be permanently deleted and cannot be re-added with this identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_GET_INTEGRATIONSRetrieve a list of integrations in your workspace to discover configured integrations. An HTTP 404 response is returned as an empty list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_GET_MESSAGESTool to retrieve a list of messages sent from your workspace. Use when you need paginated delivery metrics for messages, e.g., list email messages delivered between two timestamps.

Input Parameters

string ("email" | "webhook" | "twilio" | "slack" | "push" | "in_app")
Type of message to return metrics for. If omitted, returns all types.
integer
Maximum number of results per page (1–1000). Default is 50.
string
Pagination token for the page of results to return. Use the ‘next’ value from a previous response as this parameter.
boolean
If true, returns draft messages instead of active/sent ones.
integer
End of time window (Unix timestamp).
string
Metric to include in response, e.g., ‘attempted’, ‘sent’, ‘delivered’, ‘opened’, ‘clicked’, ‘converted’.
integer
Start of time window (Unix timestamp).
integer
Filter results by a specific action ID.
integer
Filter results by a specific campaign ID.
integer
Filter results by a specific newsletter ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_GET_NEWSLETTER_METRICSRetrieve aggregate engagement metrics for a Customer.io one-time send.

Input Parameters

string ("email" | "webhook" | "twilio" | "push" | "in_app" | "inbox")
Channel type to report. Omit to return metrics for all channel types.
integer
Number of periods to return. Maximums are 24 hours, 45 days, 12 weeks, and 121 months.
string ("hours" | "days" | "weeks" | "months")
Unit of time for the report. The provider defaults to days.
integer
required
Identifier of the one-time send.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_GET_SEGMENT_DETAILSTool to retrieve details of a specific segment. Use after identifying the segment ID from list segments.

Input Parameters

integer
required
The unique identifier of the segment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_GET_SEGMENT_MEMBERSHIPTool to retrieve people in a specific segment. Use when you need to page through segment membership after identifying segment ID.

Input Parameters

string ("asc" | "desc")
Order of results: ‘asc’ for oldest first, ‘desc’ for newest first.
integer
Maximum number of results per page (1 ≤ limit ≤ 30000). Default is 1000.
string
Pagination token for the page of results to return.
integer
required
The segment’s unique identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_GET_SEGMENTSTool to retrieve a list of segments in your workspace. Use when you need to fetch all segments after configuring segment rules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_GET_TRANSACTIONAL_METRICSReturn aggregate engagement metrics for a transactional message template.

Input Parameters

integer
Number of reporting periods to return. Maximums are 24 hours, 45 days, 12 weeks, or 121 months.
string ("hours" | "days" | "weeks" | "months")
Unit of time represented by each metric-series entry.
integer
required
ID of the transactional message template to report on.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_GET_TRIGGERRetrieves details about a specific API-triggered broadcast, including trigger ID, campaign ID, creation timestamp, recipient filter criteria, and personalization data. Use this after triggering a broadcast to verify its configuration and check the data used for message personalization.

Input Parameters

string
required
The unique identifier of the trigger to retrieve (e.g., ‘5-37’ or just ‘456’).
integer
required
The unique identifier of the campaign/broadcast (campaign_id).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_GET_TRIGGERSRetrieve all API trigger instances for a specific broadcast/campaign. Returns trigger metadata including IDs, creation timestamps, and processing status. Use after triggering a broadcast to list all its trigger executions.

Input Parameters

integer
required
The broadcast/campaign unique identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_GET_WEBHOOKSRetrieves all reporting webhook configurations from the Customer.io workspace. Reporting webhooks send event notifications (message sent, opened, clicked, etc.) to your specified endpoints. Use this to list all configured webhooks and their settings including subscribed events, endpoints, and status. Returns an empty list if no webhooks are configured.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_IDENTIFY_PERSONIdentify a person in Customer.io and assign traits, creating a profile or updating an existing one. Provide a user ID or anonymous ID to identify the person, and optionally specify when the identification occurred.

Input Parameters

object
Key-value pairs representing attributes to assign to the person. Common traits include email, name, firstName, lastName, phone, company, etc.
string
A unique identifier for the person. Either user_id or anonymous_id must be provided. Use this for identified users.
string
ISO 8601 timestamp indicating when the identification occurred. If omitted, Customer.io uses the current time.
string
An anonymous identifier for the person if user_id is not available. Either user_id or anonymous_id must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_LIST_ACTIVITIESReturn recent workspace activity-log entries with optional filters.

Input Parameters

string
Event, attribute, or consent-action name to return.
string
Activity type to return. Object types use _o:<object_type_id>:<activity> and relationship types use _r:<object_type_id>:<activity>.
integer
Maximum number of activities to return per page (1-100).
string
Pagination token from the previous response’s next field.
boolean
Whether to include activities for deleted people.
string ("id" | "email" | "phone" | "cio_id")
Identifier type used by customer_id. The provider defaults to id.
string
Person identifier to filter by, interpreted according to id_type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_LIST_COLLECTIONSTool to list all Collections metadata. Use when you need to retrieve current details of each Collection in your workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_LIST_IP_ADDRESSESTool to retrieve the list of IP addresses used by Customer.io for sending messages. Use when you need to allowlist or configure firewall rules for Customer.io’s sending infrastructure.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_LIST_NEWSLETTERSTool to list all newsletters. Use when paginating through newsletter metadata.

Input Parameters

string ("asc" | "desc")
Sort order: ‘asc’ for chronological, ‘desc’ for reverse chronological
integer
Maximum number of newsletters to retrieve per page
string
Pagination cursor. Use ‘next’ value from previous response to get next page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_LIST_SNIPPETSTool to list all snippets in your workspace. Use when you need to retrieve all reusable content snippets for templating or dynamic content insertion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_LIST_TRANSACTIONAL_MESSAGESLists all transactional message templates in your Customer.io workspace. Returns the ID and name (trigger name) for each template. Use this when you need to discover available transactional message templates or retrieve their IDs for sending messages via the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_REPORT_PUSH_EVENTSTool to report push notification events to Customer.io. Use when you need to track device-side push events (opened, converted, delivered). IMPORTANT: This endpoint is deprecated. Use the metrics endpoint instead for reporting push events. This action requires Track API credentials (Basic Auth with siteId:apiKey), not App API credentials.

Input Parameters

string ("opened" | "converted" | "delivered")
required
The type of device-side event you want to report back to Customer.io.
string
required
The CIO-Delivery-Token representing the device that received the original notification.
integer
required
The unix timestamp when the event occurred.
string
required
The CIO-Delivery-ID from the notification that you want to associate the event with.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_SEND_BATCHSend multiple CDP calls (identify, track, page, screen, group, alias) in a single batch request. Use this to efficiently send multiple events or profile updates in one API call. The batch endpoint supports up to 500KB total with 32KB per individual call. Each call in the batch can be a different type (identify, track, page, screen, group, or alias). Requirements by call type: - identify/track/page/screen: Require userId or anonymousId - group: Requires groupId (and userId or anonymousId) - track: Requires event name - alias: Requires userId and previousId Note: This action uses the CDP API base URL (https://cdp.customer.io/v1) which differs from the Track API base URL used by some other Customer.io actions.

Input Parameters

array
required
Array of CDP calls to process. Can include identify, track, page, screen, group, or alias calls. Maximum 500KB total size, 32KB per call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_TRACK_EVENTTool to send an event associated with a person in Customer.io. Records actions users take, along with properties that describe the action. Use when you need to track user behavior, conversions, or custom events for segmentation and campaigns.

Input Parameters

string
required
The name of the event to track. This is required and describes the action that occurred.
string
A unique identifier for a person. At least one of userId or anonymousId must be provided.
string
ISO 8601 timestamp for when the event occurred. If not provided, Customer.io will use the current time.
object
Key-value pairs representing event data and metadata. Use this to add custom attributes to the event.
string
An anonymous ID for the person. At least one of userId or anonymousId must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_TRACK_PAGETrack page views for website visitors through the Customer.io CDP API, providing a user ID or anonymous ID and optional page properties. The Pipelines API uses basic authorization; this action forwards the connection’s authorization headers.

Input Parameters

string
The name of the page being viewed. Helps categorize and filter page views.
string
A unique identifier for the person viewing the page. Either user_id or anonymous_id must be provided.
object
Additional properties about the page view such as url, title, path, referrer, or custom metadata.
string
An anonymous identifier for the person if user_id is not available. Either user_id or anonymous_id must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_TRACK_SCREENTrack mobile screen views in Customer.io for analytics and user journey tracking. Records when a user views a screen in your mobile app. Use this when you need to: - Track user navigation patterns in mobile apps - Record screen views for engagement analytics - Trigger workflows based on specific screen visits - Build user journey maps based on screen flow Requirements: - Provide either userId (for known users) or anonymousId (for anonymous users) - Screen name is required to identify which screen was viewed - Optionally include properties for additional context (platform, category, etc.) Note: This endpoint uses the CDP API (cdp.customer.io), not the standard App API.

Input Parameters

string
required
Name of the screen that was viewed (e.g., ‘home_screen’, ‘feed’, ‘settings’).
string
Event type identifier. Should always be ‘screen’ for screen view events.
string
ISO 8601 timestamp of when the event was sent from the client. Used for clock skew correction.
string
Unique identifier for a known user. Use this to track screen views for identified users. Mutually exclusive with anonymousId - provide one or the other.
object
Optional contextual information about the event (e.g., device info, IP address, app version).
number
Version number of the tracking spec being used.
string
Unique identifier for this message/event. If not provided, one will be generated automatically.
string
ISO 8601 timestamp of when the screen view occurred. If not provided, the current time will be used. Format: YYYY-MM-DDTHH:mm:ss.sssZ
object
Optional key-value pairs containing additional context about the screen view (e.g., screen_category, platform, referrer).
string
ISO 8601 timestamp of when the event was received by the server. Typically set automatically.
string
Unique identifier for an anonymous user who hasn’t been identified yet. Mutually exclusive with userId - provide one or the other.
boolean
When True, enables strict validation that returns proper HTTP error codes (400/401) for validation failures. When False (default), the API operates in permissive mode, logging errors but returning HTTP 200.
object
Control which downstream integrations receive this event. Use {‘All’: true} to send to all integrations, or specify individual integrations like {‘Salesforce’: false}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_TRIGGER_BROADCASTManually trigger a Customer.io broadcast/campaign to send messages to a defined audience. Use this when you need to: - Send a pre-configured broadcast to specific recipients (by ID or email) - Override the broadcast’s default UI-defined audience with custom filtering - Provide personalization data for Liquid template variables - Send individualized content using per_user_data Requirements: - broadcast_id: Must be a valid broadcast ID from Customer.io (find in broadcast’s Triggering Details) - Audience: Provide exactly ONE of: recipients, ids, emails, per_user_data, or data_file_url Rate Limits: This endpoint allows one request every 10 seconds per broadcast.

Input Parameters

array
List of customer IDs to target (mutually exclusive with other audience options).
object
Global key-value data for Liquid templating personalization across all recipients.
array
List of email addresses to target (mutually exclusive with other audience options).
object
Override the broadcast’s UI audience with complex filtering logic. Use logical operators (and/or/not) with segment or attribute filters.
integer
required
The ID of the broadcast to trigger.
string
HTTP(S) URL to a file with JSON data (one map per line with id/email and data). Mutually exclusive with other audience options.
array
Array of user-specific data with id/email and personalization (mutually exclusive with other audience options).
boolean
Skip people without customer IDs. Default: false.
boolean
Allow duplicate email recipients. Default: false.
boolean
Skip people without email addresses. Default: false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMERIO_UNSUBSCRIBE_DELIVERYTool to handle custom unsubscribe requests for email deliveries in Customer.io. Use when you need to unsubscribe a person from emails and attribute the action to a specific delivery. IMPORTANT: This action requires Track API credentials (Basic Auth with siteId:apiKey), not App API credentials. The unsubscribe action sets the person’s unsubscribed attribute to true.

Input Parameters

string
required
The delivery ID resulting in a request to unsubscribe. This is the unique identifier for a message delivery (e.g., ‘dgOq6QWq6QUBAAF4_CGoeVX7mFkDbRFu7ek=’). You can obtain this from message delivery events or the Get Messages endpoint.
boolean
If true, the person’s ‘unsubscribed’ attribute is set to true and the unsubscription is attributed to this delivery. Set to false to revert an unsubscribe action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not