KosmoKrator

productivity

Customer.io MCP, CLI, and Lua Integration for AI Agents

Customer.io integration docs for AI agents: MCP gateway setup, Customer.io CLI commands, Lua API reference, credentials, and function schemas.

Customer.io for agents

Credentials can be configured manually in web or CLI hosts.

Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.

Agent Surfaces

Customer.io CLIHeadless setup, JSON output, direct function calls. Customer.io MCPExpose selected tools to local MCP clients. Customer.io LuaAgent-facing namespace and Lua reference. FeedbackReport missing tools, auth issues, or bad metadata.

Machine-Readable Metadata

integration_slug
customerio
route_slug
customerio
package
customerio
auth_strategy
multi_api_key
cli_setup_supported
true
cli_runtime_supported
true
mcp_gateway_supported
true
lua_supported
true

Function Catalog

FunctionTypeParametersDescription
customerio.customerio_app_add_collection Write write 0 Create a new collection and provide the data that you'll access from the collection or the url that you'll download CSV or JSON data from.
customerio.customerio_app_broadcast_action_links Read read 0 Returns link click metrics for an individual broadcast action.
customerio.customerio_app_broadcast_action_metrics Read read 0 Returns a list of metrics for an individual action both in total and in steps (days, weeks, etc) over a period of time.
customerio.customerio_app_broadcast_actions Read read 0 Returns the actions that occur as a part of a broadcast.
customerio.customerio_app_broadcast_errors Read read 0 If your broadcast produced validation errors, this endpoint can help you better understand what went wrong.
customerio.customerio_app_broadcast_links Read read 0 Returns metrics for link clicks within a broadcast, both in total and in series periods (days, weeks, etc).
customerio.customerio_app_broadcast_messages Read read 0 Returns information about the deliveries (instances of messages sent to individual people) sent from an API-triggered broadcast.
customerio.customerio_app_broadcast_metrics Read read 0 Returns a list of metrics for an individual broadcast in steps (days, weeks, etc).
customerio.customerio_app_broadcast_status Read read 0 After triggering a broadcast you can retrieve the status of that broadcast using a GET of the trigger_id.
customerio.customerio_app_campaign_action_links Read read 0 Returns link click metrics for an individual action.
customerio.customerio_app_campaign_action_metrics Read read 0 Returns a list of metrics for an individual action.
customerio.customerio_app_campaign_journey_metrics Read read 0 Returns a list of Journey Metrics for your campaign.
customerio.customerio_app_campaign_link_metrics Read read 0 Returns metrics for link clicks within a campaign, both in total and in series periods (days, weeks, etc).
customerio.customerio_app_campaign_metrics Read read 0 Returns a list of metrics for an individual campaign.
customerio.customerio_app_create_asset Write write 0 Creates a new file asset.
customerio.customerio_app_create_asset_folder Write write 0 Creates a new folder for organizing file assets.
customerio.customerio_app_create_component Write write 0 Creates a custom component.
customerio.customerio_app_create_email Write write 0 Create an email.
customerio.customerio_app_create_email_translation Write write 0 Creates a new translation for an email.
customerio.customerio_app_create_folder Write write 0 Create a new folder at the root level or under a parent folder.
customerio.customerio_app_create_man_segment Write write 0 Create a manual segment with a name and a description.
customerio.customerio_app_create_newsletter Write write 0 Create a newsletter and optionally schedule it or send it immediately.
customerio.customerio_app_create_newsletter_language_variant Write write 0 Add a language variant to a newsletter.
customerio.customerio_app_create_newsletter_test_group Write write 0 Create a new A/B test group for a newsletter.
customerio.customerio_app_create_newsletter_test_language_variant Write write 0 Add a language variant to a specific A/B test group in a newsletter.
customerio.customerio_app_create_snippet Write write 0 Create a new snippet.
customerio.customerio_app_create_webhook Write write 0 Create a new webhook configuration.
customerio.customerio_app_delete_asset Write write 0 Soft-deletes a file asset by setting its deleted_at timestamp.
customerio.customerio_app_delete_asset_folder Write write 0 Soft-deletes an empty folder.
customerio.customerio_app_delete_collection Write write 0 Remove a collection and associated contents.
customerio.customerio_app_delete_component Write write 0 Delete a component.
customerio.customerio_app_delete_email Write write 0 Delete an email.
customerio.customerio_app_delete_email_translation Write write 0 Delete a specific language translation from an email.
customerio.customerio_app_delete_folder Write write 0 Delete a folder **including subfolders and all file (components, templates, and emails)**.
customerio.customerio_app_delete_man_segment Write write 0 Delete a manual segment.
customerio.customerio_app_delete_newsletter_language_variant Write write 0 Delete a specific language variant of a newsletter.
customerio.customerio_app_delete_newsletter_test_language_variant Write write 0 Delete a specific language variant of a newsletter in an A/B test group.
customerio.customerio_app_delete_newsletters Write write 0 Deletes an individual newsletter, including content, settings, and metrics.
customerio.customerio_app_delete_snippet Write write 0 Remove a snippet.
customerio.customerio_app_delete_suppression Write write 0 Remove an address from the ESP's suppression list.
customerio.customerio_app_delete_webhook Write write 0 Delete a reporting webhook's configuration.
customerio.customerio_app_download_export Read read 0 This endpoint returns a signed link to download an export.
customerio.customerio_app_export_deliveries_data Write write 0 Provide filters for the newsletter, campaign, or action you want to return delivery information from.
customerio.customerio_app_export_people_data Write write 0 Provide filters and attributes describing the customers you want to export.
customerio.customerio_app_get_archived_message Read read 0 Returns the archived copy of a delivery, including the message body, recipient, and metrics.
customerio.customerio_app_get_asset Read read 0 Retrieves a single file asset by its ID.
customerio.customerio_app_get_asset_folder Read read 0 Retrieves a single folder by its ID.
customerio.customerio_app_get_broadcast Read read 0 Returns metadata for an individual broadcast.
customerio.customerio_app_get_broadcast_action Read read 0 Returns information about a specific action within a broadcast.
customerio.customerio_app_get_broadcast_action_language Read read 0 Returns information about a translation of message in a broadcast.
customerio.customerio_app_get_campaign_action Read read 0 Returns information about a specific action in a campaign.
customerio.customerio_app_get_campaign_action_translation Read read 0 Returns a translated version of a message in a campaign.
customerio.customerio_app_get_campaign_messages Read read 0 Returns information about the deliveries (instances of messages sent to individual people) sent from a campaign.
customerio.customerio_app_get_campaigns Read read 0 Returns metadata for an individual campaign.
customerio.customerio_app_get_channels Read read 0 Returns a list of subscription channels available in your workspace.
customerio.customerio_app_get_cio_allowlist Read read 0 Returns a list of IP addresses that you need to allowlist if you're using a firewall or provider's IP access management settings to deny access to unknown IP addresses.
customerio.customerio_app_get_collection Read read 0 Retrieves details about a collection, including the schema and name.
customerio.customerio_app_get_collection_contents Read read 0 Retrieve the contents of a collection (the data from when you created or updated a collection).
customerio.customerio_app_get_collections Read read 0 Returns a list of all of your collections, including the name and schema for each collection.
customerio.customerio_app_get_component Read read 0 Returns a single component with its full content.
customerio.customerio_app_get_domain_suppressions_by_type Read read 0 Find addresses suppressed by the Email Service Provider (ESP) for a particular reason on a specific sending domain.
customerio.customerio_app_get_email Read read 0 Returns a single email including content, envelope details, and transformers.
customerio.customerio_app_get_email_translation Read read 0 Returns a single email translation by language code, including content, envelope, and transformers.
customerio.customerio_app_get_export Read read 0 Return information about a specific export.
customerio.customerio_app_get_folder Read read 0 Get a folder by its UUID.
customerio.customerio_app_get_import Read read 0 This endpoint returns information about an "import"a CSV file containing a group of people or events you uploaded to using v1/imports endpoint.
customerio.customerio_app_get_message Read read 0 Return a information about, and metrics for, a deliverythe instance of a message intended for an individual recipient person.
customerio.customerio_app_get_newsletter_links Read read 0 Returns metrics for link clicks within a newsletter, both in total and in series periods (days, weeks, etc).
customerio.customerio_app_get_newsletter_metrics Read read 0 Returns a list of metrics for an individual newsletter in steps (days, weeks, etc).
customerio.customerio_app_get_newsletter_msg_meta Read read 0 Returns information about the "deliveries" (rendered messages) sent to your recipients for a specific newsletter.
customerio.customerio_app_get_newsletter_test_groups Read read 0 Returns information about each test group in a newsletter, including content ids for each group.
customerio.customerio_app_get_newsletter_variant Read read 0 Returns information about a specific variant of a newsletter, where a variant is either a language in a multi-language newsletter or a part of an A/B test.
customerio.customerio_app_get_newsletter_variant_translation Read read 0 Returns information about a specific language variant of a newsletter.
customerio.customerio_app_get_newsletter_variant_translation_test Read read 0 Returns information about a specific language variant of a newsletter in an A/B test group.
customerio.customerio_app_get_newsletters Read read 0 Returns metadata for an individual newsletter.
customerio.customerio_app_get_object_attributes Read read 0 Get a list of attributes for an object.
customerio.customerio_app_get_object_relationships Read read 0 Get a list of people people related to an object.
customerio.customerio_app_get_object_types Read read 0 Returns a list of object types in your system.
customerio.customerio_app_get_objects_filter Write write 0 Use a set of filter conditions to find objects in your workspace.
customerio.customerio_app_get_people_by_id Write write 0 Return attributes and devices for up to 100 customers by ID.
customerio.customerio_app_get_people_email Read read 0 Return a list of people in your workspace matching an email address.
customerio.customerio_app_get_people_filter Write write 0 Provide a filter to search for people in your workspace.
customerio.customerio_app_get_person_activities Read read 0 Return a list of activities performed by, or for, a customer.
customerio.customerio_app_get_person_attributes Read read 0 Return a list of attributes for a customer profile.
customerio.customerio_app_get_person_messages Read read 0 Returns information about the deliveries sent to a person.
customerio.customerio_app_get_person_relationships Read read 0 Return a list of objects that a person is related to.
customerio.customerio_app_get_person_segments Read read 0 Returns a list of segments that a customer profile belongs to.
customerio.customerio_app_get_person_subscription_preferences Read read 0 Returns a list of subscription preferences for a person, including the custom header of the subscription preferences page, topic names, and topic descriptions.
customerio.customerio_app_get_segment Read read 0 Return information about a segment.
customerio.customerio_app_get_segment_count Read read 0 Returns the membership count for a segment.
customerio.customerio_app_get_segment_dependencies Read read 0 Use this endpoint to find out which campaigns and newsletters use a segment.
customerio.customerio_app_get_segment_membership Read read 0 Returns customers in a segment.
customerio.customerio_app_get_sender Read read 0 Returns information about a specific sender.
customerio.customerio_app_get_sender_usage Read read 0 Returns lists of the campaigns and newsletters that use a sender.
customerio.customerio_app_get_subscription_center_token Read read 0 Generates a signed token and URL for a person's standalone subscription center page.
customerio.customerio_app_get_suppression Read read 0 Look up an email address to learn if, and why, it was suppressed by the email service provider (ESP).
customerio.customerio_app_get_suppression_by_type Read read 0 Find addresses suppressed by the Email Service Provider (ESP) for a particular reasonbounces, blocks, spam reports, or invalid email addresses.
customerio.customerio_app_get_topics Read read 0 Returns a list of subscription topics in your workspace.
customerio.customerio_app_get_transactional Read read 0 Returns information about an individual transactional message.
customerio.customerio_app_get_transactional_variant Read read 0 Returns information about a translation of an individual transactional message, including the message content.
customerio.customerio_app_get_variant_links Read read 0 Returns link click metrics for an individual newsletter variantan individual language in a multi-language newsletter or a message in an A/B test.
customerio.customerio_app_get_variant_metrics Read read 0 Returns a metrics for an individual newsletter varianteither an individual language in a multi-language newsletter or a message in an A/B test.
customerio.customerio_app_get_webhook Read read 0 Returns information about a specific reporting webhook.
customerio.customerio_app_import Write write 0 This endpoint lets you upload a CSV file containing people, events, objects, or relationships.
customerio.customerio_app_list_activities Read read 0 This endpoint returns a list of "activities" for people, similar to your workspace's Activity Logs.
customerio.customerio_app_list_asset_folders Read read 0 Returns a paginated list of asset folders.
customerio.customerio_app_list_assets Read read 0 Returns a paginated list of file assets.
customerio.customerio_app_list_broadcast_triggers Read read 0 Returns a list of the triggers for a broadcast.
customerio.customerio_app_list_broadcasts Read read 0 Returns a list of your API-triggered broadcasts and associated metadata.
customerio.customerio_app_list_campaign_actions Read read 0 Returns the operations in a campaign workflow.
customerio.customerio_app_list_campaigns Read read 0 Returns a list of your campaigns and associated metadata.
customerio.customerio_app_list_components Read read 0 Returns a paginated list of components and any folders in the result set.
customerio.customerio_app_list_email_translations Read read 0 Returns all translations for an email.
customerio.customerio_app_list_emails Read read 0 Returns a paginated list of emails and a separate array of folders that the emails belong to.
customerio.customerio_app_list_exports Read read 0 Return a list of your exports.
customerio.customerio_app_list_folders Read read 0 Returns a paginated list of folders.
customerio.customerio_app_list_messages Read read 0 Return a list of deliveries, including metrics for each delivery, for messages in your workspace.
customerio.customerio_app_list_newsletter_variants Read read 0 Returns a newsletter's content variantsthese are either different languages in a multi-language newsletter or A/B tests.
customerio.customerio_app_list_newsletters Read read 0 Returns a list of your newsletters and associated metadata.
customerio.customerio_app_list_segments Read read 0 Retrieve a list of all of your segments.
customerio.customerio_app_list_senders Read read 0 Returns a list of senders in your workspace.
customerio.customerio_app_list_snippets Read read 0 Returns a list of snippets in your workspace.
customerio.customerio_app_list_transactional Read read 0 Returns a list of your transactional messagesthe transactional IDs that you use to trigger an individual transactional delivery.
customerio.customerio_app_list_transactional_variants Read read 0 Returns the content variants of a transactional message, where each variant represents a different language.
customerio.customerio_app_list_webhooks Read read 0 Return a list of all of your reporting webhooks.
customerio.customerio_app_list_workspaces Read read 0 Returns a list of workspaces in your account.
customerio.customerio_app_post_suppression Write write 0 Suppress an email address at the email service provider (ESP).
customerio.customerio_app_schedule_newsletter Write write 0 Schedule a newsletter to send at a specific time.
customerio.customerio_app_send_email Write write 0 Send a transactional email.
customerio.customerio_app_send_inbox_message Write write 0 Send a transactional inbox message.
customerio.customerio_app_send_newsletter Write write 0 Send a newsletter immediately.
customerio.customerio_app_send_push Write write 0 Send a transactional push.
customerio.customerio_app_send_sms Write write 0 Send a transactional SMS message.
customerio.customerio_app_transactional_links Read read 0 Returns metrics for clicked links from a transactional message, both in total and in series periods (days, weeks, etc).
customerio.customerio_app_transactional_messages Read read 0 Returns information about the deliveries (instances of messages sent to individual people) from a transactional message.
customerio.customerio_app_transactional_metrics Read read 0 Returns a list of metrics for a transactional message in steps (days, weeks, etc).
customerio.customerio_app_trigger_broadcast Write write 0 Trigger a broadcast (not a newsletter) and optionally provide data to populate liquid placeholders in the message.
customerio.customerio_app_update_asset Write write 0 Updates the name and/or parent folder of a file asset.
customerio.customerio_app_update_asset_folder Write write 0 Updates the name and/or parent folder of an existing folder.
customerio.customerio_app_update_attribute_metadata Write write 0 Attributes are customer data like their name and email.
customerio.customerio_app_update_broadcast_action Write write 0 Update the contents of a broadcast action, including the body of messages or HTTP requests.
customerio.customerio_app_update_broadcast_action_language Write write 0 Update a translation of a specific broadcast action, including the body of messages or HTTP requests.
customerio.customerio_app_update_campaign_action Write write 0 Update the contents of a campaign action, including the body of messages and HTTP requests.
customerio.customerio_app_update_campaign_action_translation Write write 0 Update the contents of a language variant of a campaign action, including the body of the messages and HTTP requests.
customerio.customerio_app_update_collection Write write 0 Update the name or replace the contents of a collection.
customerio.customerio_app_update_collection_contents Write write 0 Replace the contents of a collection (the data from when you created or updated a collection).
customerio.customerio_app_update_component Write write 0 Update part of a component: its name, tag, folder, or content.
customerio.customerio_app_update_email Write write 0 Update part of an email: an email's name, template status, folder, content, envelope, or transformers.
customerio.customerio_app_update_email_translation Write write 0 Update part of an email translation: the content, envelope, or transformers for a specific email translation.
customerio.customerio_app_update_event_metadata Write write 0 Events are actions your customers have performed.
customerio.customerio_app_update_folder Write write 0 Update part of a folder: the name and/or the folder it belongs to.
customerio.customerio_app_update_newsletter_test_translation Write write 0 Update the translation of a newsletter variant in an A/B test.
customerio.customerio_app_update_newsletter_variant Write write 0 Update the content of a newsletter: the default message, a test variant in an A/B test group, or a translation.
customerio.customerio_app_update_newsletter_variant_translation Write write 0 Update the translation of a newsletter variant.
customerio.customerio_app_update_snippets Write write 0 In your payload, you'll pass a name and value.
customerio.customerio_app_update_transactional Write write 0 Update the body of a transactional email.
customerio.customerio_app_update_transactional_variant Write write 0 Update the body and other data of a specific language variant for a transactional message.
customerio.customerio_app_update_webhook Write write 0 Update the configuration of a reporting webhook.
customerio.customerio_pipelines_alias Write write 0 *You **only** need to use this method to support a few select destinations like Mixpanel.* The alias method reconciles identifiers in systems that don't automatically handle identity changeslike when a person graduates f.
customerio.customerio_pipelines_batch Write write 0 The batch method helps you send an array of identify, group, track, page and/or screen requests in a single call, so you don't have to send multiple requests.
customerio.customerio_pipelines_group Write write 0 Group calls add people to a group.
customerio.customerio_pipelines_identify Write write 0 Identifies a person and assigns traits to them.
customerio.customerio_pipelines_page Write write 0 Sends a page view event.
customerio.customerio_pipelines_screen Write write 0 Sends a screen view event for mobile devices.
customerio.customerio_pipelines_track Write write 0 Send an event associated with a person.
customerio.customerio_track_add_device Write write 0 Customers can have more than one device.
customerio.customerio_track_add_to_segment Write write 0 Add people to a manual segment by ID.
customerio.customerio_track_batch Write write 0 This endpoint lets you batch requests for different people and objects in a single request.
customerio.customerio_track_delete Write write 0 Deleting a customer removes them, and all of their information, from Customer.io.
customerio.customerio_track_delete_device Write write 0 Remove a device from a customer profile.
customerio.customerio_track_entity Write write 0 This endpoint lets you create, update, or delete a single person or objectincluding managing relationships between objects and people.
customerio.customerio_track_get_region Read read 0 This endpoint returns the appropriate region and URL for your Track API credentials.
customerio.customerio_track_identify Write write 0 Adds or updates a person.
customerio.customerio_track_merge Write write 0 Merge two customer profiles together.
customerio.customerio_track_metrics Write write 0 This endpoint helps you report metrics from channels that aren't native to Customer.io or don't rely on our SDKs.
customerio.customerio_track_push_metrics Write write 0 While this endpoint still works, you should take advantage of our .
customerio.customerio_track_remove_from_segment Write write 0 You can remove users from a manual segment by ID.
customerio.customerio_track_submit_form Write write 0 Submit a form response.
customerio.customerio_track_suppress Write write 0 Delete a customer profile and prevent the person's identifier(s) from being re-added to your workspace.
customerio.customerio_track_track Write write 0 Send an event associated with a person, referenced by the identifier in the path.
customerio.customerio_track_track_anonymous Write write 0 An anonymous event represents a person you haven't identified yet.
customerio.customerio_track_unsubscribe Write write 0 This endpoint lets you set a global unsubscribed status outside of the subscription pathways native to Customer.io.
customerio.customerio_track_unsuppress Write write 0 Unsuppressing a profile allows you to add the customer back to Customer.io.