Skip to Content

Customer.io Pipelines API

Customer.io Pipelines API icon
Arcade Starter

Tools that enable LLMs to interact directly with the Customer.io Track API

Author:Arcade
Version:1.0.0
Auth:No authentication required
7tools
7require secrets
PyPI VersionPython VersionsWheel StatusDownloadsLicense

CustomerioPipelinesApi enables seamless interaction with the Customer.io Track API, allowing LLMs to manage user data efficiently. This toolkit excels in automating user grouping, event tracking, and identity reconciliation, all essential for effective marketing and analytics.

Capabilities:

  • Automate user grouping based on specified criteria.
  • Reconcile anonymous and identified user IDs for accurate tracking.
  • Identify users and assign traits for personalized experiences.
  • Send batch requests for improved performance and reduced overhead.
  • Track user interactions through page and screen view events.

OAuth: No OAuth configuration is required; however, API keys are needed for accessing the toolkit's functionality.

Secrets: API key type secrets are used; for example, CUSTOMERIO_TRACK_API_KEY is required for authentication.

Available tools(7)

7 of 7
Tool nameDescriptionSecrets
Add a person to a specified group. This tool adds a person to a specified group, such as companies or classes, using their user ID and group ID. It automates user grouping for Customer.io destinations. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Reconcile anonymous and identified user IDs for select destinations. The tool is used to reconcile identifiers in systems that don't automatically handle identity changes, such as when transitioning from an anonymous to an identified user. It is typically used before identifying a user with a `userId`, particularly for destinations like Mixpanel that don't automatically associate data between anonymous and identified states. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Identify a person and assign traits using Customerio. Use this tool to identify a person by user ID, anonymous ID, or email (for Customer.io destinations), and assign traits to them. This is useful for tracking and personalizing user data. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Send multiple requests in a single batch call. Use this tool to efficiently send arrays of `identify`, `group`, `track`, `page`, and/or `screen` requests in one API call. This increases performance by handling up to 500KB of data in a single submission, benefiting from a unified context and integration settings for all requests. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Sends a page view event for tracking user interactions. Use this tool to send page view events for tracking when users view a page. Typically used in single-page apps where route changes need explicit tracking. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Send a screen view event for app usage analytics. This tool sends a screen view event to help understand app usage by tracking which screens users navigate to. It should be called whenever a user views a page in the app. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Record user events with properties for analysis. Use this tool to send and record events associated with user actions on your website or app. Provide an event name and properties like item details when someone performs an action, such as adding a product to their cart. This helps in understanding and analyzing user behavior. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1

Selected tools

No tools selected.

Click "Show all tools" to add tools.

Requirements

Select tools to see requirements

#

CustomerioPipelinesApi.AddToGroup

Add a person to a specified group. This tool adds a person to a specified group, such as companies or classes, using their user ID and group ID. It automates user grouping for Customer.io destinations. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
enable_strict_validationstringOptionalSet to '1' to enable strict validation, returning HTTP error codes for validation failures. Otherwise, the API operates in permissive mode. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:CUSTOMERIO_TRACK_API_KEY

Output

Type:jsonResponse from the API endpoint 'group'.
#

CustomerioPipelinesApi.AliasUserIdentity

Reconcile anonymous and identified user IDs for select destinations. The tool is used to reconcile identifiers in systems that don't automatically handle identity changes, such as when transitioning from an anonymous to an identified user. It is typically used before identifying a user with a `userId`, particularly for destinations like Mixpanel that don't automatically associate data between anonymous and identified states. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
enable_strict_validationstringOptionalSet to 'True' to enable strict validation, returning HTTP error codes (400/401) for validation failures. Defaults to permissive mode if not set. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:CUSTOMERIO_TRACK_API_KEY

Output

Type:jsonResponse from the API endpoint 'alias'.
#

CustomerioPipelinesApi.IdentifyPersonAndAssignTraits

Identify a person and assign traits using Customerio. Use this tool to identify a person by user ID, anonymous ID, or email (for Customer.io destinations), and assign traits to them. This is useful for tracking and personalizing user data. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
enable_strict_validationstringOptionalSet to `True` to enable strict HTTP error validation (400/401) for validation failures. Defaults to permissive mode when `False`. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:CUSTOMERIO_TRACK_API_KEY

Output

Type:jsonResponse from the API endpoint 'identify'.
#

CustomerioPipelinesApi.SendBatchRequests

Send multiple requests in a single batch call. Use this tool to efficiently send arrays of `identify`, `group`, `track`, `page`, and/or `screen` requests in one API call. This increases performance by handling up to 500KB of data in a single submission, benefiting from a unified context and integration settings for all requests. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
enable_strict_modestringOptionalSet to `True` to enable strict validation, returning HTTP error codes (400/401) for validation failures instead of HTTP 200. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:CUSTOMERIO_TRACK_API_KEY

Output

Type:jsonResponse from the API endpoint 'batch'.
#

CustomerioPipelinesApi.SendPageViewEvent

Sends a page view event for tracking user interactions. Use this tool to send page view events for tracking when users view a page. Typically used in single-page apps where route changes need explicit tracking. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
enable_strict_modestringOptionalSet to '1' to enable strict validation, returning 400/401 for errors. Any other value uses permissive mode logging. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:CUSTOMERIO_TRACK_API_KEY

Output

Type:jsonResponse from the API endpoint 'page'.
#

CustomerioPipelinesApi.SendScreenViewEvent

Send a screen view event for app usage analytics. This tool sends a screen view event to help understand app usage by tracking which screens users navigate to. It should be called whenever a user views a page in the app. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
enable_strict_validationstringOptionalEnable strict validation for returning proper HTTP error codes (400/401) for failures. Set to `1` to enable. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:CUSTOMERIO_TRACK_API_KEY

Output

Type:jsonResponse from the API endpoint 'screen'.
#

CustomerioPipelinesApi.TrackUserEvent

Record user events with properties for analysis. Use this tool to send and record events associated with user actions on your website or app. Provide an event name and properties like item details when someone performs an action, such as adding a product to their cart. This helps in understanding and analyzing user behavior. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
enable_strict_validationstringOptionalSet to `True` to enable strict validation and return error codes (400/401) for validation failures. `False` for permissive mode. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:CUSTOMERIO_TRACK_API_KEY

Output

Type:jsonResponse from the API endpoint 'track'.
Last updated on