|
| 1 | +# CustomerioPipelinesApi |
| 2 | + |
| 3 | +import StarterToolInfo from "@/app/_components/starter-tool-info"; |
| 4 | +import ToolInfo from "@/app/_components/tool-info"; |
| 5 | +import Badges from "@/app/_components/badges"; |
| 6 | +import TabbedCodeBlock from "@/app/_components/tabbed-code-block"; |
| 7 | +import TableOfContents from "@/app/_components/table-of-contents"; |
| 8 | +import ToolFooter from "@/app/_components/tool-footer"; |
| 9 | +import { Callout } from "nextra/components"; |
| 10 | + |
| 11 | +<ToolInfo |
| 12 | + description="Tools that enable LLMs to interact directly with the Customer.io Track API" |
| 13 | + author="Arcade" |
| 14 | + authType="API Key" |
| 15 | + versions={["0.1.0"]} |
| 16 | +/> |
| 17 | + |
| 18 | +<Badges repo="arcadeai/arcade_customerio_pipelines_api" /> |
| 19 | + |
| 20 | +<StarterToolInfo toolkitName="CustomerioPipelinesApi" /> |
| 21 | + |
| 22 | +The CustomerioPipelinesApi MCP Server offers a comprehensive set of tools for managing user data and tracking interactions within Customer.io. |
| 23 | + |
| 24 | +## Available Tools |
| 25 | + |
| 26 | +<TableOfContents |
| 27 | + headers={["Tool Name", "Description"]} |
| 28 | + data={[ |
| 29 | + [ |
| 30 | + "CustomerioPipelinesApi.IdentifyPersonAndAssignTraits", |
| 31 | + "Identify a person and assign traits using Customerio.", |
| 32 | + ], |
| 33 | + [ |
| 34 | + "CustomerioPipelinesApi.TrackUserEvent", |
| 35 | + "Record user events with properties for analysis.", |
| 36 | + ], |
| 37 | + [ |
| 38 | + "CustomerioPipelinesApi.SendPageViewEvent", |
| 39 | + "Sends a page view event for tracking user interactions.", |
| 40 | + ], |
| 41 | + [ |
| 42 | + "CustomerioPipelinesApi.SendScreenViewEvent", |
| 43 | + "Send a screen view event for app usage analytics.", |
| 44 | + ], |
| 45 | + ["CustomerioPipelinesApi.AddToGroup", "Add a person to a specified group."], |
| 46 | + [ |
| 47 | + "CustomerioPipelinesApi.AliasUserIdentity", |
| 48 | + "Reconcile anonymous and identified user IDs for select destinations.", |
| 49 | + ], |
| 50 | + [ |
| 51 | + "CustomerioPipelinesApi.SendBatchRequests", |
| 52 | + "Send multiple requests in a single batch call.", |
| 53 | + ], |
| 54 | + ]} |
| 55 | +/> |
| 56 | + |
| 57 | +<Callout> |
| 58 | + If you need to perform an action that's not listed here, you can [get in touch |
| 59 | + with us ](mailto:[email protected]) to request a new tool, or [create your own |
| 60 | + tools](/home/build-tools/create-a-mcp-server). |
| 61 | +</Callout> |
| 62 | + |
| 63 | +## CustomerioPipelinesApi.IdentifyPersonAndAssignTraits |
| 64 | + |
| 65 | +<br /> |
| 66 | +<TabbedCodeBlock |
| 67 | + tabs={[ |
| 68 | + { |
| 69 | + label: "Call the Tool Directly", |
| 70 | + content: { |
| 71 | + Python: [ |
| 72 | + "/examples/integrations/mcp-servers/customerio_pipelines_api/identify_person_and_assign_traits_example_call_tool.py", |
| 73 | + ], |
| 74 | + JavaScript: [ |
| 75 | + "/examples/integrations/mcp-servers/customerio_pipelines_api/identify_person_and_assign_traits_example_call_tool.js", |
| 76 | + ], |
| 77 | + }, |
| 78 | + }, |
| 79 | + ]} |
| 80 | +/> |
| 81 | + |
| 82 | +Identify a person and assign traits using Customerio. |
| 83 | + |
| 84 | +**Parameters** |
| 85 | + |
| 86 | +- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation |
| 87 | +- **enable_strict_validation** (`string`, optional) Set 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'. |
| 88 | +- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
| 89 | + |
| 90 | +**Secrets** |
| 91 | + |
| 92 | +This tool requires the following secrets: `CUSTOMERIO_API_KEY` (learn how to [configure secrets](/home/build-tools/create-a-tool-with-secrets)) |
| 93 | + |
| 94 | +## CustomerioPipelinesApi.TrackUserEvent |
| 95 | + |
| 96 | +<br /> |
| 97 | +<TabbedCodeBlock |
| 98 | + tabs={[ |
| 99 | + { |
| 100 | + label: "Call the Tool Directly", |
| 101 | + content: { |
| 102 | + Python: [ |
| 103 | + "/examples/integrations/mcp-servers/customerio_pipelines_api/track_user_event_example_call_tool.py", |
| 104 | + ], |
| 105 | + JavaScript: [ |
| 106 | + "/examples/integrations/mcp-servers/customerio_pipelines_api/track_user_event_example_call_tool.js", |
| 107 | + ], |
| 108 | + }, |
| 109 | + }, |
| 110 | + ]} |
| 111 | +/> |
| 112 | + |
| 113 | +Record user events with properties for analysis. |
| 114 | + |
| 115 | +**Parameters** |
| 116 | + |
| 117 | +- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation |
| 118 | +- **enable_strict_validation** (`string`, optional) Set 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'. |
| 119 | +- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
| 120 | + |
| 121 | +**Secrets** |
| 122 | + |
| 123 | +This tool requires the following secrets: `CUSTOMERIO_API_KEY` (learn how to [configure secrets](/home/build-tools/create-a-tool-with-secrets)) |
| 124 | + |
| 125 | +## CustomerioPipelinesApi.SendPageViewEvent |
| 126 | + |
| 127 | +<br /> |
| 128 | +<TabbedCodeBlock |
| 129 | + tabs={[ |
| 130 | + { |
| 131 | + label: "Call the Tool Directly", |
| 132 | + content: { |
| 133 | + Python: [ |
| 134 | + "/examples/integrations/mcp-servers/customerio_pipelines_api/send_page_view_event_example_call_tool.py", |
| 135 | + ], |
| 136 | + JavaScript: [ |
| 137 | + "/examples/integrations/mcp-servers/customerio_pipelines_api/send_page_view_event_example_call_tool.js", |
| 138 | + ], |
| 139 | + }, |
| 140 | + }, |
| 141 | + ]} |
| 142 | +/> |
| 143 | + |
| 144 | +Sends a page view event for tracking user interactions. |
| 145 | + |
| 146 | +**Parameters** |
| 147 | + |
| 148 | +- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation |
| 149 | +- **enable_strict_mode** (`string`, optional) Set to '1' to enable strict validation, returning 400/401 for errors. Any other value uses permissive mode logging. Only used when mode is 'execute'. |
| 150 | +- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
| 151 | + |
| 152 | +**Secrets** |
| 153 | + |
| 154 | +This tool requires the following secrets: `CUSTOMERIO_API_KEY` (learn how to [configure secrets](/home/build-tools/create-a-tool-with-secrets)) |
| 155 | + |
| 156 | +## CustomerioPipelinesApi.SendScreenViewEvent |
| 157 | + |
| 158 | +<br /> |
| 159 | +<TabbedCodeBlock |
| 160 | + tabs={[ |
| 161 | + { |
| 162 | + label: "Call the Tool Directly", |
| 163 | + content: { |
| 164 | + Python: [ |
| 165 | + "/examples/integrations/mcp-servers/customerio_pipelines_api/send_screen_view_event_example_call_tool.py", |
| 166 | + ], |
| 167 | + JavaScript: [ |
| 168 | + "/examples/integrations/mcp-servers/customerio_pipelines_api/send_screen_view_event_example_call_tool.js", |
| 169 | + ], |
| 170 | + }, |
| 171 | + }, |
| 172 | + ]} |
| 173 | +/> |
| 174 | + |
| 175 | +Send a screen view event for app usage analytics. |
| 176 | + |
| 177 | +**Parameters** |
| 178 | + |
| 179 | +- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation |
| 180 | +- **enable_strict_validation** (`string`, optional) Enable strict validation for returning proper HTTP error codes (400/401) for failures. Set to `1` to enable. Only used when mode is 'execute'. |
| 181 | +- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
| 182 | + |
| 183 | +**Secrets** |
| 184 | + |
| 185 | +This tool requires the following secrets: `CUSTOMERIO_API_KEY` (learn how to [configure secrets](/home/build-tools/create-a-tool-with-secrets)) |
| 186 | + |
| 187 | +## CustomerioPipelinesApi.AddToGroup |
| 188 | + |
| 189 | +<br /> |
| 190 | +<TabbedCodeBlock |
| 191 | + tabs={[ |
| 192 | + { |
| 193 | + label: "Call the Tool Directly", |
| 194 | + content: { |
| 195 | + Python: [ |
| 196 | + "/examples/integrations/mcp-servers/customerio_pipelines_api/add_to_group_example_call_tool.py", |
| 197 | + ], |
| 198 | + JavaScript: [ |
| 199 | + "/examples/integrations/mcp-servers/customerio_pipelines_api/add_to_group_example_call_tool.js", |
| 200 | + ], |
| 201 | + }, |
| 202 | + }, |
| 203 | + ]} |
| 204 | +/> |
| 205 | + |
| 206 | +Add a person to a specified group. |
| 207 | + |
| 208 | +**Parameters** |
| 209 | + |
| 210 | +- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation |
| 211 | +- **enable_strict_validation** (`string`, optional) Set 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'. |
| 212 | +- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
| 213 | + |
| 214 | +**Secrets** |
| 215 | + |
| 216 | +This tool requires the following secrets: `CUSTOMERIO_API_KEY` (learn how to [configure secrets](/home/build-tools/create-a-tool-with-secrets)) |
| 217 | + |
| 218 | +## CustomerioPipelinesApi.AliasUserIdentity |
| 219 | + |
| 220 | +<br /> |
| 221 | +<TabbedCodeBlock |
| 222 | + tabs={[ |
| 223 | + { |
| 224 | + label: "Call the Tool Directly", |
| 225 | + content: { |
| 226 | + Python: [ |
| 227 | + "/examples/integrations/mcp-servers/customerio_pipelines_api/alias_user_identity_example_call_tool.py", |
| 228 | + ], |
| 229 | + JavaScript: [ |
| 230 | + "/examples/integrations/mcp-servers/customerio_pipelines_api/alias_user_identity_example_call_tool.js", |
| 231 | + ], |
| 232 | + }, |
| 233 | + }, |
| 234 | + ]} |
| 235 | +/> |
| 236 | + |
| 237 | +Reconcile anonymous and identified user IDs for select destinations. |
| 238 | + |
| 239 | +**Parameters** |
| 240 | + |
| 241 | +- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation |
| 242 | +- **enable_strict_validation** (`string`, optional) Set 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'. |
| 243 | +- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
| 244 | + |
| 245 | +**Secrets** |
| 246 | + |
| 247 | +This tool requires the following secrets: `CUSTOMERIO_API_KEY` (learn how to [configure secrets](/home/build-tools/create-a-tool-with-secrets)) |
| 248 | + |
| 249 | +## CustomerioPipelinesApi.SendBatchRequests |
| 250 | + |
| 251 | +<br /> |
| 252 | +<TabbedCodeBlock |
| 253 | + tabs={[ |
| 254 | + { |
| 255 | + label: "Call the Tool Directly", |
| 256 | + content: { |
| 257 | + Python: [ |
| 258 | + "/examples/integrations/mcp-servers/customerio_pipelines_api/send_batch_requests_example_call_tool.py", |
| 259 | + ], |
| 260 | + JavaScript: [ |
| 261 | + "/examples/integrations/mcp-servers/customerio_pipelines_api/send_batch_requests_example_call_tool.js", |
| 262 | + ], |
| 263 | + }, |
| 264 | + }, |
| 265 | + ]} |
| 266 | +/> |
| 267 | + |
| 268 | +Send multiple requests in a single batch call. |
| 269 | + |
| 270 | +**Parameters** |
| 271 | + |
| 272 | +- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation |
| 273 | +- **enable_strict_mode** (`string`, optional) Set 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'. |
| 274 | +- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
| 275 | + |
| 276 | +**Secrets** |
| 277 | + |
| 278 | +This tool requires the following secrets: `CUSTOMERIO_API_KEY` (learn how to [configure secrets](/home/build-tools/create-a-tool-with-secrets)) |
| 279 | + |
| 280 | +## Reference |
| 281 | + |
| 282 | +Below is a reference of enumerations used by some of the tools in the CustomerioPipelinesApi MCP Server: |
| 283 | + |
| 284 | +### ToolMode |
| 285 | + |
| 286 | +- **GET_REQUEST_SCHEMA**: `get_request_schema` |
| 287 | +- **EXECUTE**: `execute` |
| 288 | + |
| 289 | +<ToolFooter pipPackageName="arcade_customerio_pipelines_api" /> |
0 commit comments