> 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/jitsu.md).

# Jitsu

Send track, identify, page, group, and batch events into the Jitsu customer data platform.

### Connectors

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

| Connector | Authentication |
| --------- | -------------- |
| Jitsu     | Write Key      |

#### Jitsu

Connect to a Jitsu site to send track, identify, page, group, and batch events into its ingestion pipeline.

**Set up in Jitsu**

1. Prepare the Jitsu account or service that the workflow will access. Grant access to the required resources and operations.
2. **Jitsu Ingestion URL:** The site's ingestion host. On Jitsu Cloud, copy it from the site's Setup Instructions page in the console: it looks like 'https\://\<site-id>.d.jitsu.com', or your custom tracking domain. Self-hosted users paste their own Jitsu host instead.
3. **Write Key:** The site's server-side (private) write key, copied from the Jitsu console, in the format 'keyId:keySecret'.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Jitsu**.
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                                                                                                                                                                                                                                                                                                        |
| ------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Jitsu Ingestion URL | Yes      | The site's ingestion host. On Jitsu Cloud, copy it from the site's Setup Instructions page in the console: it looks like 'https\://\<site-id>.d.jitsu.com', or your custom tracking domain. Self-hosted users paste their own Jitsu host instead. [Provider instructions](https://jitsu.com/docs/sending-data/http). |
| Write Key           | Yes      | The site's server-side (private) write key, copied from the Jitsu console, in the format 'keyId:keySecret'. [Provider instructions](https://jitsu.com/docs/sending-data/http).                                                                                                                                       |

#### 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 **Jitsu** 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

#### Track Event

Record a named user action in Jitsu, such as a signup or a purchase.

**Inputs**

| Field                | Type     | Required | Description                                                                  |
| -------------------- | -------- | -------- | ---------------------------------------------------------------------------- |
| Event Name           | string   | Yes      | What the user did, e.g. 'Order Completed'.                                   |
| User ID              | string   | Yes      | Your own identifier for the user this event belongs to.                      |
| Properties (JSON)    | textarea | No       | Extra details about the event, as a JSON object.                             |
| Show advanced fields | boolean  | No       | Show anonymous ID, event time, message ID, and context. Default: false.      |
| Anonymous ID         | string   | No       | Pre-signup visitor ID, if you are stitching anonymous activity to this user. |
| Event Time           | datetime | No       | When the action happened, if it was not just now.                            |
| Message ID           | string   | No       | Your own unique ID for this event, for tracing it downstream.                |
| Context (JSON)       | textarea | No       | Environment details such as locale or app version, as a JSON object.         |

**Outputs**

| Field      | Type   | Description                              |
| ---------- | ------ | ---------------------------------------- |
| Event Name | string | The event name that was sent.            |
| User ID    | string | The user the event was recorded for.     |
| Event Sent | object | The exact payload delivered to Jitsu.    |
| Result     | string | Human-readable summary of what was sent. |

#### Identify User

Attach traits such as name, email, or plan to a user profile in Jitsu.

**Inputs**

| Field                | Type     | Required | Description                                                             |
| -------------------- | -------- | -------- | ----------------------------------------------------------------------- |
| User ID              | string   | Yes      | Your own permanent identifier for this user.                            |
| Traits (JSON)        | textarea | No       | What you know about the user, as a JSON object.                         |
| Show advanced fields | boolean  | No       | Show anonymous ID, event time, message ID, and context. Default: false. |
| Anonymous ID         | string   | No       | Pre-signup visitor ID to merge into this profile.                       |
| Event Time           | datetime | No       | When these traits became true, if not now.                              |
| Message ID           | string   | No       | Your own unique ID for this call, for tracing it downstream.            |
| Context (JSON)       | textarea | No       | Environment details such as locale, as a JSON object.                   |

**Outputs**

| Field       | Type   | Description                              |
| ----------- | ------ | ---------------------------------------- |
| User ID     | string | The user the traits were attached to.    |
| Traits Sent | object | The traits delivered to Jitsu.           |
| Event Sent  | object | The exact payload delivered to Jitsu.    |
| Result      | string | Human-readable summary of what was sent. |

#### Track Page View

Record that a user viewed a page or screen.

**Inputs**

| Field                | Type     | Required | Description                                                                           |
| -------------------- | -------- | -------- | ------------------------------------------------------------------------------------- |
| User ID              | string   | Yes      | Your own identifier for the user who viewed the page.                                 |
| Page Name            | string   | No       | A short name for the page, e.g. 'Pricing'.                                            |
| Page URL             | string   | No       | The full URL of the page that was viewed.                                             |
| Properties (JSON)    | textarea | No       | Extra page details, as a JSON object.                                                 |
| Show advanced fields | boolean  | No       | Reveal page title, anonymous ID, event time, message ID, and context. Default: false. |
| Page Title           | string   | No       | The browser title of the page.                                                        |
| Anonymous ID         | string   | No       | Pre-signup visitor ID, if stitching anonymous activity.                               |
| Event Time           | datetime | No       | When the page was viewed, if not now.                                                 |
| Message ID           | string   | No       | Your own unique ID for this event, for tracing it downstream.                         |
| Context (JSON)       | textarea | No       | Environment details such as locale, as a JSON object.                                 |

**Outputs**

| Field      | Type   | Description                              |
| ---------- | ------ | ---------------------------------------- |
| Page Name  | string | The page name that was sent, if any.     |
| User ID    | string | The user the view was recorded for.      |
| Event Sent | object | The exact payload delivered to Jitsu.    |
| Result     | string | Human-readable summary of what was sent. |

#### Add User to Group

Associate a user with a company, account, or workspace in Jitsu.

**Inputs**

| Field                | Type     | Required | Description                                                             |
| -------------------- | -------- | -------- | ----------------------------------------------------------------------- |
| User ID              | string   | Yes      | Your own identifier for the user joining the group.                     |
| Group ID             | string   | Yes      | Your own identifier for the company or account.                         |
| Group Traits (JSON)  | textarea | No       | What you know about the company or account, as a JSON object.           |
| Show advanced fields | boolean  | No       | Show anonymous ID, event time, message ID, and context. Default: false. |
| Anonymous ID         | string   | No       | Pre-signup visitor ID, if stitching anonymous activity.                 |
| Event Time           | datetime | No       | When the association happened, if not now.                              |
| Message ID           | string   | No       | Your own unique ID for this event, for tracing it downstream.           |
| Context (JSON)       | textarea | No       | Environment details such as locale, as a JSON object.                   |

**Outputs**

| Field      | Type   | Description                               |
| ---------- | ------ | ----------------------------------------- |
| User ID    | string | The user that was associated.             |
| Group ID   | string | The account the user was associated with. |
| Event Sent | object | The exact payload delivered to Jitsu.     |
| Result     | string | Human-readable summary of what was sent.  |

#### Send Event Batch

Send many events to Jitsu in one call, for backfills or bulk logging.

**Inputs**

| Field                 | Type     | Required | Description                                                                |
| --------------------- | -------- | -------- | -------------------------------------------------------------------------- |
| Events (JSON)         | textarea | Yes      | The list of events to send, as a JSON array.                               |
| Shared Context (JSON) | textarea | No       | Environment details applied to every event in the batch, as a JSON object. |

**Outputs**

| Field       | Type    | Description                                                |
| ----------- | ------- | ---------------------------------------------------------- |
| Events Sent | integer | How many events were delivered.                            |
| Event Types | object  | The event types present in the batch and how many of each. |
| Result      | string  | Human-readable summary of the batch.                       |

#### Send Custom Event

Send a ready-made Jitsu event payload exactly as written.

**Inputs**

| Field        | Type     | Required | Description                                           |
| ------------ | -------- | -------- | ----------------------------------------------------- |
| Event (JSON) | textarea | Yes      | The complete event payload to send, as a JSON object. |

**Outputs**

| Field      | Type   | Description                              |
| ---------- | ------ | ---------------------------------------- |
| Event Type | string | The event type read from the payload.    |
| Event Sent | object | The exact payload delivered to Jitsu.    |
| Result     | string | Human-readable summary of what was sent. |

### 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/jitsu.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.
