> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/mparticle.md).

# mParticle

Integration with mParticle to ingest events, read user profiles, and list data feeds on this customer data platform.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector                            | Authentication |
| ------------------------------------ | -------------- |
| mParticle (Events API)               | API Secret     |
| mParticle (Profile and Platform API) | Credentials    |

#### mParticle (Events API)

Connect an mParticle Custom Feed input to ingest events and user attributes. This credential can only write events; it cannot read profiles or list feeds.

**Set up in mParticle**

1. Prepare the mParticle account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** The key for the Custom Feed input this data lands in. Create a Custom Feed at app.mparticle.com/setup/inputs/feeds to generate one.
3. **API Secret:** The secret paired with the API key above, from the same Custom Feed input.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **mParticle (Events API)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required                 | What to enter                                                                                                                                                                                              |
| ------------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes                      | The key for the Custom Feed input this data lands in. Create a Custom Feed at app.mparticle.com/setup/inputs/feeds to generate one. [Provider instructions](https://app.mparticle.com/setup/inputs/feeds). |
| API Secret    | Yes                      | The secret paired with the API key above, from the same Custom Feed input. [Provider instructions](https://app.mparticle.com/setup/inputs/feeds).                                                          |
| Pod           | Optional / as applicable | The regional pod this mParticle account is hosted in: us1 (default), us2, eu1 or au1. Your mParticle account manager provides this; it is not discoverable through any API.                                |

#### mParticle (Profile and Platform API)

Connect an mParticle OAuth2 API credential to read user profiles and list data feeds. This credential cannot ingest events.

**Set up in mParticle**

1. Prepare the mParticle account or service that the workflow will access. Grant access to the required resources and operations.
2. **Client ID:** The OAuth2 client id from an mParticle API credential (Settings > API Credentials). Create it with the Profile API selected, and the Platform API too if you need List Feeds; User permission is sufficient because this integration performs no Platform writes.
3. **Organization ID:** Your mParticle organization id. No mParticle API returns this value; copy it from the mParticle UI.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **mParticle (Profile and Platform API)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field   | Required | What to enter                                                                                                                                                                                                                                                                                                                                            |
| --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Client ID       | Yes      | The OAuth2 client id from an mParticle API credential (Settings > API Credentials). Create it with the Profile API selected, and the Platform API too if you need List Feeds; User permission is sufficient because this integration performs no Platform writes. [Provider instructions](https://docs.mparticle.com/developers/credential-management/). |
| Client Secret   | Yes      | The OAuth2 client secret paired with the client id above. [Provider instructions](https://docs.mparticle.com/developers/credential-management/).                                                                                                                                                                                                         |
| Organization ID | Yes      | Your mParticle organization id. No mParticle API returns this value; copy it from the mParticle UI. [Provider instructions](https://docs.mparticle.com/developers/credential-management/).                                                                                                                                                               |
| Account ID      | Yes      | Your mParticle account id: the same id the Platform API takes as its accountId query parameter. [Provider instructions](https://docs.mparticle.com/developers/credential-management/).                                                                                                                                                                   |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **mParticle** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Upload Event Batch

Send one user's events and attributes into mParticle.

**Inputs**

| Field                   | Type            | Required | Description                                                                                                                                                              |
| ----------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Customer ID             | string          | No       | Your own id for this user, so mParticle can match the events to the right profile.                                                                                       |
| Email                   | string          | No       | The user's email address, used to match their mParticle profile.                                                                                                         |
| Event name              | string          | No       | Name of the event to record, for example 'Signup Completed'.                                                                                                             |
| Event category          | select (string) | No       | Which kind of activity this event represents. Available values: Navigation, Location, Search, Transaction, User Content, User Preference, Social, Other. Default: other. |
| Event attributes (JSON) | textarea        | No       | Extra details about the event, as a JSON object of names and values.                                                                                                     |
| User attributes (JSON)  | textarea        | No       | Profile fields to set on this user, as a JSON object of names and values.                                                                                                |
| Environment             | select (string) | No       | Whether this data is real production traffic or test data. Available values: Production, Development. Default: production.                                               |
| mParticle ID (MPID)     | string          | No       | An mParticle profile id, if you already know it.                                                                                                                         |
| Other ID                | string          | No       | A custom identifier for this user, if your account uses one.                                                                                                             |
| Events JSON             | textarea        | No       | Full event list as JSON, for events the simple fields above cannot express.                                                                                              |
| Device info (JSON)      | textarea        | No       | Device details for this upload, as a JSON object.                                                                                                                        |
| Request ID              | string          | No       | Leave blank. A unique id is generated for you so a retried upload is not counted twice.                                                                                  |

**Outputs**

| Field            | Type    | Description                                              |
| ---------------- | ------- | -------------------------------------------------------- |
| Accepted         | boolean | True when mParticle accepted the request for processing. |
| Request ID       | string  | The deduplication id sent with this upload.              |
| Events submitted | integer | How many events this action put in the request.          |
| Status           | string  | Plain-language result of the upload.                     |

#### Bulk Upload Events

Send batches for many users to mParticle in one request.

**Inputs**

| Field        | Type            | Required | Description                                                                                                                                                          |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Batches JSON | textarea        | Yes      | The batches to upload, as a JSON array. One entry per user.                                                                                                          |
| Environment  | select (string) | No       | Whether this data is real production traffic or test data. Batches that set their own value keep it. Available values: Production, Development. Default: production. |
| Request ID   | string          | No       | Leave blank. A unique id is generated per batch so a retried upload is not counted twice.                                                                            |

**Outputs**

| Field             | Type    | Description                                                        |
| ----------------- | ------- | ------------------------------------------------------------------ |
| Accepted          | boolean | True when mParticle accepted the request for processing.           |
| Request ID prefix | string  | The deduplication id prefix used for this upload.                  |
| Batches submitted | integer | How many batches this action put in the request.                   |
| Events submitted  | integer | How many events this action put in the request across all batches. |
| Status            | string  | Plain-language result of the upload.                               |

#### Get User Profile

Look up everything mParticle knows about one user.

**Inputs**

| Field               | Type                      | Required | Description                                                                                                                                                                                                                                       |
| ------------------- | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Workspace           | select (string)           | Yes      | Which mParticle workspace holds this user's profile. Options load from the selected connection.                                                                                                                                                   |
| mParticle ID (MPID) | string                    | No       | The mParticle profile id to read, if you know it.                                                                                                                                                                                                 |
| Identity type       | select (string)           | No       | Which kind of identifier you are looking the user up by. Available values: Customer ID, Other.                                                                                                                                                    |
| Identity value      | string                    | No       | The identifier value to look the user up by.                                                                                                                                                                                                      |
| Include             | multiple\_select (string) | No       | Which parts of the profile to return. Pick several; defaults to everything except partner identities. Available values: Device identities, User identities, User attributes, Audience memberships, Attribution, Partner identities. Default: \[]. |
| Environment         | select (string)           | No       | Whether to look in production or development data. Only applies to identity lookups. Available values: Production, Development. Default: production.                                                                                              |

**Outputs**

| Field   | Type    | Description                          |
| ------- | ------- | ------------------------------------ |
| Profile | object  | The user profile mParticle returned. |
| Found   | boolean | True when a profile matched.         |

#### List Feeds

List the data feeds (inputs) set up in an mParticle workspace.

**Inputs**

| Field         | Type            | Required | Description                                                                              |
| ------------- | --------------- | -------- | ---------------------------------------------------------------------------------------- |
| Workspace     | select (string) | Yes      | Which mParticle workspace to list feeds from. Options load from the selected connection. |
| Name contains | string          | No       | Only show feeds whose name contains this text.                                           |
| Max results   | integer         | No       | Most feeds to return. Minimum: 1. Maximum: 1000. Default: 100.                           |

**Outputs**

| Field       | Type          | Description                                            |
| ----------- | ------------- | ------------------------------------------------------ |
| Feeds       | object\_array | The feeds found in the workspace.                      |
| Total count | integer       | How many feeds matched before Max results was applied. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/mparticle.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
