> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Customer.io

> How to set up the Customer.io connector, plus the actions and events that are available.

![Customer.io](https://stackone-logos.com/api/customerio/filled/svg)

v2.3.1[See changelog](https://docs.stackone.com/connectors/customerio/changelog.md)

[61 actions](#actions) · [72 events](#events) · 2 auth methods

Marketing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [App API — API Key · Connector Profile](https://docs.stackone.com/connectors/customerio/guides/connector-profile/app-api-api-key.md)
>
> Connect to the Customer.io App API using an App API Key (bearer token). Provides access to campaigns, broadcasts, segmen...

> [card] [Track API — API Key · Connector Profile](https://docs.stackone.com/connectors/customerio/guides/connector-profile/track-api-api-key.md)
>
> Connect to the Customer.io Track API using a Site ID and Track API Key (HTTP Basic auth). Use this to send behavioral da...

Optionally, configure receiving Events for Customer.io into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/customerio/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [App API — API Key · Link Account](https://docs.stackone.com/connectors/customerio/guides/link-account/app-api-api-key.md)

> [card] [Track API — API Key · Link Account](https://docs.stackone.com/connectors/customerio/guides/link-account/track-api-api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

App API — API Key

Track API — API Key

No auth methods found

61 actions

ActionDescription

List Activities`customerio_list_activities`

List all activities in the workspace

List Broadcasts`customerio_list_broadcasts`

List all broadcasts in the workspace

Get Broadcast`customerio_get_broadcast`

Retrieve a specific broadcast by ID

Get Broadcast Metrics`customerio_get_broadcast_metrics`

Get metrics for a broadcast

List Broadcast Actions`customerio_list_broadcast_actions`

List all actions in a broadcast

Get Broadcast Triggers`customerio_get_broadcast_triggers`

Get trigger history for a broadcast

Trigger A Broadcast`customerio_trigger_broadcast`

Send an API-triggered broadcast

List Campaigns`customerio_list_campaigns`

List all campaigns in the workspace

Get Campaign`customerio_get_campaign`

Retrieve a specific campaign by ID

Get Campaign Metrics`customerio_get_campaign_metrics`

Get metrics for a campaign

List Campaign Actions`customerio_list_campaign_actions`

List all actions in a campaign

List Collections`customerio_list_collections`

List all collections

Get Customers By Email`customerio_get_customers_by_email`

Get customers by email address

Search For Customers`customerio_search_for_customers`

Search for customers using advanced filters

Lookup A Customer's Attributes`customerio_lookup_customer_attributes`

Get attributes for a specific customer

Lookup A Customer's Segments`customerio_lookup_customer_segments`

Get segments a customer belongs to

Lookup Messages Sent To A Customer`customerio_lookup_messages_sent_to_customer`

Get messages sent to a customer

Lookup A Customer's Activities`customerio_lookup_customer_activities`

Get activities for a customer

Lookup A Customer's Relationships`customerio_lookup_customer_relationships`

Get relationships for a specific customer

List Customers, Attributes, And Devices`customerio_list_customers_attributes_devices`

List customers with their attributes and devices

List Exports`customerio_list_exports`

List all exports

List Messages`customerio_list_messages`

List all messages in the workspace

Get Message`customerio_get_message`

Retrieve a specific message by ID

List Newsletters`customerio_list_newsletters`

List all newsletters in the workspace

Create And Send A Newsletter`customerio_create_newsletter`

Create a newsletter

Send A Newsletter`customerio_send_newsletter`

Send a draft newsletter immediately

Schedule A Newsletter`customerio_schedule_newsletter`

Schedule or reschedule a draft newsletter

Get Newsletter`customerio_get_newsletter`

Retrieve a specific newsletter by ID

Get Newsletter Metrics`customerio_get_newsletter_metrics`

Get metrics for a newsletter

Delete A Newsletter`customerio_delete_newsletter`

Delete a specific newsletter

Get Newsletter Link Metrics`customerio_get_newsletter_link_metrics`

Get link click metrics for a newsletter

Find Objects`customerio_find_objects`

Find objects using filter conditions

List Object Types`customerio_list_object_types`

List all object types

List Reporting Webhooks`customerio_list_reporting_webhooks`

List all reporting webhooks

List Segments`customerio_list_segments`

List all segments in the workspace

Create A Manual Segment`customerio_create_manual_segment`

Create a manual segment

Get Segment`customerio_get_segment`

Retrieve a specific segment by ID

Delete A Segment`customerio_delete_segment`

Delete a specific segment

Get A Segment Customer Count`customerio_get_segment_customer_count`

Get the total number of customers in a segment

List Customers In A Segment`customerio_list_customers_in_segment`

List all customers in a specific segment

List Sender Identities`customerio_list_sender_identities`

List all sender identities in the workspace

Get Sender Identity`customerio_get_sender_identity`

Retrieve a specific sender identity by ID

List Snippets`customerio_list_snippets`

List all snippets in the workspace

Create Snippet`customerio_create_snippet`

Create a new snippet

Update Snippet`customerio_update_snippet`

Create or update a snippet

Delete Snippet`customerio_delete_snippet`

Delete a snippet

List Subscription Topics`customerio_list_subscription_topics`

List the subscription topics in the workspace

Get Account Region`customerio_get_account_region`

Find your account region

Add Or Update A Customer`customerio_add_or_update_customer`

Add or update a customer

Delete A Customer`customerio_delete_customer`

Delete a customer

Merge Duplicate People`customerio_merge_duplicate_people`

Merge duplicate customers

Add Or Update A Customer Device`customerio_add_or_update_device`

Add or update a customer device

Delete A Customer Device`customerio_delete_device`

Delete a customer device

Track Customer Event`customerio_track_customer_event`

Track an event for a customer

Track Anonymous Event`customerio_track_anonymous_event`

Track an event for an anonymous user

Add Customers To Segment`customerio_add_customers_to_segment`

Add customers to a manual segment

Remove Customers From Segment`customerio_remove_customers_from_segment`

Remove customers from a manual segment

Suppress A Customer Profile`customerio_suppress_customer`

Suppress a customer profile

Unsuppress A Customer Profile`customerio_unsuppress_customer`

Unsuppress a customer profile

List Transactional Messages`customerio_list_transactional`

List all transactional messages

Get A Transactional Message`customerio_get_transactional`

Retrieve a specific transactional message by ID

## Events

Tags

Select all
|
Clear

Emails

In-App Messages

Push Notifications

SMS

Slack Messages

Subscriptions

Webhook Messages

Webhooks

WhatsApp Messages

No tags found

72 events

EventDescriptionTags

Customer Subscribed`customerio_webhook_customer_subscribed`

Fired when a person subscribes to messages (their unsubscribed attribute is set to false), whether from a message or dir...

SubscriptionsWebhooks

Customer Unsubscribed`customerio_webhook_customer_unsubscribed`

Fired when a person unsubscribes from messages (their unsubscribed attribute is set to true), whether from a message or...

SubscriptionsWebhooks

Customer Subscription Preferences Changed`customerio_webhook_customer_subscription_preferences_changed`

Fired when a person changes their subscription preferences in the subscription center, or their cio\_subscription\_prefere...

SubscriptionsWebhooks

Email Drafted`customerio_webhook_email_drafted`

Fired when an email draft is created.

EmailsWebhooks

Email Attempted`customerio_webhook_email_attempted`

Fired when an email could not be handed to the delivery provider and will be retried; failure\_message holds the reason.

EmailsWebhooks

Email Sent`customerio_webhook_email_sent`

Fired when an email is successfully sent.

EmailsWebhooks

Email Delivered`customerio_webhook_email_delivered`

Fired when an email is delivered to the recipient.

EmailsWebhooks

Email Opened`customerio_webhook_email_opened`

Fired when a recipient opens an email.

EmailsWebhooks

Email Clicked`customerio_webhook_email_clicked`

Fired when a recipient clicks a tracked link in an email.

EmailsWebhooks

Email Converted`customerio_webhook_email_converted`

Fired when a person matches conversion criteria attributed to an email.

EmailsWebhooks

Email Bounced`customerio_webhook_email_bounced`

Fired when the delivery provider cannot deliver an email.

EmailsWebhooks

Email Dropped`customerio_webhook_email_dropped`

Fired when Customer.io does not send an email because the recipient is suppressed.

EmailsWebhooks

Email Deferred`customerio_webhook_email_deferred`

Fired when the delivery provider defers delivery of an email.

EmailsWebhooks

Email Spammed`customerio_webhook_email_spammed`

Fired when a recipient marks an email as spam.

EmailsWebhooks

Email Failed`customerio_webhook_email_failed`

Fired when an email could not be handed to the delivery provider.

EmailsWebhooks

Email Unsubscribed`customerio_webhook_email_unsubscribed`

Fired when a recipient unsubscribes through a specific email message.

EmailsWebhooks

Email Undeliverable`customerio_webhook_email_undeliverable`

Fired when an email is undeliverable because it hit a message limit, came from a one-time send that was canceled or dele...

EmailsWebhooks

In-App Drafted`customerio_webhook_in_app_drafted`

Fired when an in-app message draft is created.

In-App MessagesWebhooks

In-App Attempted`customerio_webhook_in_app_attempted`

Fired when an in-app message fails to send and will be retried.

In-App MessagesWebhooks

In-App Sent`customerio_webhook_in_app_sent`

Fired when an in-app message is sent; it is only shown once the person next opens the app, so opens can lag well behind.

In-App MessagesWebhooks

In-App Opened`customerio_webhook_in_app_opened`

Fired when a device displays an in-app message (effectively an impression).

In-App MessagesWebhooks

In-App Clicked`customerio_webhook_in_app_clicked`

Fired when a recipient taps a tracked component in an in-app message; tracked\_response holds the component action name.

In-App MessagesWebhooks

In-App Converted`customerio_webhook_in_app_converted`

Fired when a person matches conversion criteria attributed to an in-app message.

In-App MessagesWebhooks

In-App Failed`customerio_webhook_in_app_failed`

Fired when an in-app message fails to send.

In-App MessagesWebhooks

In-App Undeliverable`customerio_webhook_in_app_undeliverable`

Fired when an in-app message is undeliverable because it hit a message limit, came from a one-time send that was cancele...

In-App MessagesWebhooks

Push Drafted`customerio_webhook_push_drafted`

Fired when a push notification draft is created.

Push NotificationsWebhooks

Push Attempted`customerio_webhook_push_attempted`

Fired when a push notification send is unsuccessful and will be retried.

Push NotificationsWebhooks

Push Sent`customerio_webhook_push_sent`

Fired when a push notification is sent to a recipient.

Push NotificationsWebhooks

Push Delivered`customerio_webhook_push_delivered`

Fired when a push notification is delivered to a recipient device.

Push NotificationsWebhooks

Push Opened`customerio_webhook_push_opened`

Fired when a device opens a push notification.

Push NotificationsWebhooks

Push Clicked`customerio_webhook_push_clicked`

Fired when a recipient taps a link in a push notification.

Push NotificationsWebhooks

Push Converted`customerio_webhook_push_converted`

Fired when a person matches conversion criteria attributed to a push notification.

Push NotificationsWebhooks

Push Bounced`customerio_webhook_push_bounced`

Fired when the delivery provider reports at least one invalid device token.

Push NotificationsWebhooks

Push Dropped`customerio_webhook_push_dropped`

Fired when a push notification is not sent because at least one device token previously bounced.

Push NotificationsWebhooks

Push Failed`customerio_webhook_push_failed`

Fired when a push notification could not be handed to the delivery provider.

Push NotificationsWebhooks

Push Undeliverable`customerio_webhook_push_undeliverable`

Fired when a push notification is undeliverable because it hit a message limit, came from a one-time send that was cance...

Push NotificationsWebhooks

SMS Drafted`customerio_webhook_sms_drafted`

Fired when an SMS draft is created.

SMSWebhooks

SMS Attempted`customerio_webhook_sms_attempted`

Fired when an SMS could not be handed to the delivery provider and will be retried.

SMSWebhooks

SMS Sent`customerio_webhook_sms_sent`

Fired when an SMS is sent.

SMSWebhooks

SMS Delivered`customerio_webhook_sms_delivered`

Fired when an SMS is delivered to the recipient.

SMSWebhooks

SMS Clicked`customerio_webhook_sms_clicked`

Fired when a recipient taps a link in an SMS.

SMSWebhooks

SMS Converted`customerio_webhook_sms_converted`

Fired when a person matches conversion criteria attributed to an SMS.

SMSWebhooks

SMS Bounced`customerio_webhook_sms_bounced`

Fired when the delivery provider cannot deliver an SMS.

SMSWebhooks

SMS Dropped`customerio_webhook_sms_dropped`

Fired when Customer.io does not send an SMS because the recipient opted out or their number cannot receive SMS.

SMSWebhooks

SMS Failed`customerio_webhook_sms_failed`

Fired when an SMS could not be handed to the delivery provider.

SMSWebhooks

SMS Undeliverable`customerio_webhook_sms_undeliverable`

Fired when an SMS is undeliverable because it hit a message limit, came from a one-time send that was canceled or delete...

SMSWebhooks

SMS Replied`customerio_webhook_sms_replied`

Fired when a person replies to an SMS; replies within 72 hours are attributed to the original delivery, later ones arriv...

SMSWebhooks

WhatsApp Drafted`customerio_webhook_whatsapp_drafted`

Fired when a WhatsApp message draft is created.

WhatsApp MessagesWebhooks

WhatsApp Attempted`customerio_webhook_whatsapp_attempted`

Fired when a WhatsApp message could not be handed to the delivery provider and will be retried.

WhatsApp MessagesWebhooks

WhatsApp Sent`customerio_webhook_whatsapp_sent`

Fired when a WhatsApp message is sent.

WhatsApp MessagesWebhooks

WhatsApp Delivered`customerio_webhook_whatsapp_delivered`

Fired when a WhatsApp message is delivered to the recipient.

WhatsApp MessagesWebhooks

WhatsApp Opened`customerio_webhook_whatsapp_opened`

Fired when the recipient reads a WhatsApp message.

WhatsApp MessagesWebhooks

WhatsApp Clicked`customerio_webhook_whatsapp_clicked`

Fired when a recipient taps a link in a WhatsApp message.

WhatsApp MessagesWebhooks

WhatsApp Converted`customerio_webhook_whatsapp_converted`

Fired when a person matches conversion criteria attributed to a WhatsApp message.

WhatsApp MessagesWebhooks

WhatsApp Bounced`customerio_webhook_whatsapp_bounced`

Fired when the delivery provider cannot deliver a WhatsApp message.

WhatsApp MessagesWebhooks

WhatsApp Dropped`customerio_webhook_whatsapp_dropped`

Fired when Customer.io does not send a WhatsApp message because the recipient is suppressed.

WhatsApp MessagesWebhooks

WhatsApp Failed`customerio_webhook_whatsapp_failed`

Fired when a WhatsApp message could not be handed to the delivery provider.

WhatsApp MessagesWebhooks

WhatsApp Undeliverable`customerio_webhook_whatsapp_undeliverable`

Fired when a WhatsApp message is undeliverable because it hit a message limit, came from a one-time send that was cancel...

WhatsApp MessagesWebhooks

WhatsApp Replied`customerio_webhook_whatsapp_replied`

Fired when a person replies to a WhatsApp message within 72 hours of the original delivery; replies outside that window\...

WhatsApp MessagesWebhooks

Slack Drafted`customerio_webhook_slack_drafted`

Fired when a Slack message draft is created.

Slack MessagesWebhooks

Slack Attempted`customerio_webhook_slack_attempted`

Fired when a Slack message fails and will be retried.

Slack MessagesWebhooks

Slack Sent`customerio_webhook_slack_sent`

Fired when a Slack message is sent.

Slack MessagesWebhooks

Slack Clicked`customerio_webhook_slack_clicked`

Fired when a person clicks a tracked link in a Slack message.

Slack MessagesWebhooks

Slack Converted`customerio_webhook_slack_converted`

Fired when a person matches conversion criteria attributed to a Slack message.

Slack MessagesWebhooks

Slack Failed`customerio_webhook_slack_failed`

Fired when a Slack message fails.

Slack MessagesWebhooks

Webhook Drafted`customerio_webhook_webhook_drafted`

Fired when a webhook message draft is created.

Webhook MessagesWebhooks

Webhook Attempted`customerio_webhook_webhook_attempted`

Fired when a webhook message fails to send and will be retried.

Webhook MessagesWebhooks

Webhook Sent`customerio_webhook_webhook_sent`

Fired when a webhook message is sent from Customer.io.

Webhook MessagesWebhooks

Webhook Clicked`customerio_webhook_webhook_clicked`

Fired when the recipient opens a tracked link in a webhook message payload.

Webhook MessagesWebhooks

Webhook Converted`customerio_webhook_webhook_converted`

Fired when a person matches conversion criteria attributed to a webhook message.

Webhook MessagesWebhooks

Webhook Failed`customerio_webhook_webhook_failed`

Fired when a webhook message fails to send.

Webhook MessagesWebhooks

Webhook Undeliverable`customerio_webhook_webhook_undeliverable`

Fired when a webhook message is undeliverable because it hit a message limit, came from a one-time send that was cancele...

Webhook MessagesWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.