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

# Fullstory

Look up and update Fullstory users, record server-side events, fetch session replay links and export segment data from StackAI workflows.

### Connectors

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

| Connector | Authentication |
| --------- | -------------- |
| Fullstory | API Key        |

#### Fullstory

Connect to Fullstory to look up and update users, record server-side events, fetch session replay links and export segment data.

**Set up in Fullstory**

1. In Fullstory, open Settings → Integrations → API Keys and select Create key.
2. Name the key and choose the permission level required by the selected actions. Save it and copy the key value when it is displayed.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Fullstory**.
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      | In Fullstory, open Settings, then Integrations, then API Keys, and create a key. Its value is shown once, so copy it at creation. The key's permission level decides what this connection can do: a Standard key can create and update users, record events, list sessions and list segments; an Architect key (Enterprise plans) is also needed to read users by id and to run segment exports. Data-center routing is automatic: the key's na1./eu1. prefix selects the region. [Provider instructions](https://app.fullstory.com/ui/org/settings/apikeys). |

**Connection notes**

* Standard, Architect, and Admin keys have different capabilities. For example, viewing or exporting user data requires Architect access; changing privacy block rules requires Admin access.

**Provider documentation:** [Setup reference](https://developer.fullstory.com/server/authentication/).

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

#### Get User

Fetch a Fullstory user's profile and custom properties.

**Inputs**

| Field                  | Type    | Required | Description                                                                                                                                                    |
| ---------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Fullstory user ID      | string  | No       | The id Fullstory assigned to the user, as returned by Create User, List Users or an earlier Get User. Leave empty to look the user up by your own uid instead. |
| Your user ID (uid)     | string  | No       | Your application's identifier for the user, the value passed to FS.identify or set when the user was created.                                                  |
| Include property types | boolean | No       | Also return the inferred or declared type of each property. Default: false.                                                                                    |

**Outputs**

| Field | Type   | Description         |
| ----- | ------ | ------------------- |
| User  | object | The Fullstory user. |

#### List Users

Find Fullstory users by uid, email, display name or identified state.

**Inputs**

| Field                  | Type            | Required | Description                                                                                                                               |
| ---------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Your user ID (uid)     | string          | No       | Only users with this application uid.                                                                                                     |
| Email                  | string          | No       | Only users with this email address.                                                                                                       |
| Display name           | string          | No       | Only users with this display name.                                                                                                        |
| Identified             | select (string) | No       | Restrict to identified users, anonymous users, or both. Available values: Any, Identified only, Anonymous only. Default: any.             |
| Include property types | boolean         | No       | Also return the type of each custom property. Default: false.                                                                             |
| Maximum results        | integer         | No       | How many users to return at most, up to 200. Whole pages come back, so slightly more than asked can be returned. Minimum: 1. Default: 20. |
| Page token             | string          | No       | Continue from a previous call's next page token.                                                                                          |

**Outputs**

| Field           | Type          | Description                                           |
| --------------- | ------------- | ----------------------------------------------------- |
| Users           | object\_array | Matching users.                                       |
| Next page token | string        | Pass this back as Page token to continue, if present. |

#### Create User

Create a Fullstory user, or set properties on one your app already identifies.

**Inputs**

| Field              | Type   | Required | Description                                                                                           |
| ------------------ | ------ | -------- | ----------------------------------------------------------------------------------------------------- |
| Your user ID (uid) | string | No       | Your application's identifier for this user. Immutable once set; omit it to create an anonymous user. |
| Display name       | string | No       | The name shown for this user in Fullstory.                                                            |
| Email              | string | No       | The user's email address.                                                                             |
| Custom properties  | object | No       | Custom properties as a JSON object, for example {"pricing\_plan": "paid", "total\_spent": 14.55}.     |
| Property types     | object | No       | Optional explicit types for properties, for example {"days\_active": "int"}.                          |

**Outputs**

| Field             | Type   | Description                            |
| ----------------- | ------ | -------------------------------------- |
| Fullstory user ID | string | The id Fullstory assigned to the user. |

#### Update User

Change a Fullstory user's name, email or custom properties.

**Inputs**

| Field              | Type   | Required | Description                                                                                          |
| ------------------ | ------ | -------- | ---------------------------------------------------------------------------------------------------- |
| Fullstory user ID  | string | No       | The id Fullstory assigned to the user. Leave empty to address the user by your own uid instead.      |
| Your user ID (uid) | string | No       | Your application's identifier for the user.                                                          |
| Display name       | string | No       | New display name. An empty string clears it.                                                         |
| Email              | string | No       | New email address. An empty string clears it.                                                        |
| Custom properties  | object | No       | Custom properties to set or overwrite, as a JSON object. Existing properties not mentioned are kept. |
| Property types     | object | No       | Optional explicit types, for example {"days\_active": "int"}.                                        |

**Outputs**

| Field             | Type   | Description                 |
| ----------------- | ------ | --------------------------- |
| Fullstory user ID | string | The id of the updated user. |

#### Create Event

Record a custom event in Fullstory, optionally inside a user's session.

**Inputs**

| Field                         | Type     | Required | Description                                                                                                     |
| ----------------------------- | -------- | -------- | --------------------------------------------------------------------------------------------------------------- |
| Event name                    | string   | Yes      | The event's name as it should appear in Fullstory.                                                              |
| Event properties              | object   | No       | Event payload as a JSON object, for example {"order\_id": "A-1", "total": 99.5}.                                |
| Property types                | object   | No       | Optional explicit types, for example {"quantity": "int"}.                                                       |
| Timestamp                     | datetime | No       | When the event happened. Defaults to when Fullstory receives it.                                                |
| Session ID                    | string   | No       | Attach the event to this exact Fullstory session (from List Sessions). Leave empty to identify by user instead. |
| Fullstory user ID             | string   | No       | Attach the event to this Fullstory user.                                                                        |
| Your user ID (uid)            | string   | No       | Attach the event to the user your app identifies with this uid.                                                 |
| Attach to most recent session | boolean  | No       | Stitch the event into the user's session from the last 30 minutes, if any. Default: false.                      |
| Page URL                      | string   | No       | Browser context: the page the event relates to.                                                                 |
| User agent                    | string   | No       | Browser context: the client's user agent string.                                                                |
| IP address                    | string   | No       | Location context: the client's IP address.                                                                      |
| Country code                  | string   | No       | Location context: ISO 3166-1 alpha-2 country code.                                                              |

**Outputs**

| Field   | Type    | Description                           |
| ------- | ------- | ------------------------------------- |
| Success | boolean | Whether Fullstory accepted the event. |

#### List Sessions

Get replay links for a user's most recent Fullstory sessions.

**Inputs**

| Field                         | Type    | Required | Description                                                                                                             |
| ----------------------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------- |
| Your user ID (uid)            | string  | No       | Sessions of the user your app identifies with this uid.                                                                 |
| Email                         | string  | No       | Sessions of the user with this email address.                                                                           |
| Your session ID (session uid) | string  | No       | Fetch one session by the identifier your own system assigned to it, if you set one via the Fullstory SDK or server API. |
| Maximum sessions              | integer | No       | How many of the most recent sessions to return, up to 100. Minimum: 1. Maximum: 100. Default: 20.                       |

**Outputs**

| Field    | Type          | Description                              |
| -------- | ------------- | ---------------------------------------- |
| Sessions | object\_array | Session replay links, most recent first. |
| Count    | integer       | Number of sessions returned.             |

#### List Segments

List the saved segments in your Fullstory account.

**Inputs**

| Field            | Type    | Required | Description                                                                                                                                  |
| ---------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Created by       | string  | No       | Only segments created by this Fullstory user (email).                                                                                        |
| Maximum results  | integer | No       | How many segments to return at most, up to 200. Whole pages come back, so slightly more than asked can be returned. Minimum: 1. Default: 20. |
| Pagination token | string  | No       | Continue from a previous call's next pagination token.                                                                                       |

**Outputs**

| Field                 | Type          | Description                                                 |
| --------------------- | ------------- | ----------------------------------------------------------- |
| Segments              | object\_array | Saved segments.                                             |
| Next pagination token | string        | Pass this back as Pagination token to continue, if present. |

#### Create Segment Export

Start an export of a segment's individuals or events; poll it with Get Segment Export Status.

**Inputs**

| Field                         | Type            | Required | Description                                                                                                                                                                                                                             |
| ----------------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Segment                       | select (string) | Yes      | The segment to export. Pick from the dropdown, or paste a segment id from the Fullstory URL. 'everyone' exports all users. Options load from the selected connection.                                                                   |
| Export type                   | select (string) | Yes      | Export the individuals in the segment, or the events they performed. Available values: Individuals in the segment, Events performed by the segment.                                                                                     |
| Format                        | select (string) | No       | File format of the export. Available values: NDJSON, CSV, JSON. Default: FORMAT\_NDJSON.                                                                                                                                                |
| Data from                     | datetime        | No       | Only include data from this time on. Empty means no lower bound.                                                                                                                                                                        |
| Data until                    | datetime        | No       | Only include data up to this time. Empty means up to now.                                                                                                                                                                               |
| Override segment window from  | datetime        | No       | Replace the segment's own time window (usually 'last 30 days') with one starting here. Needed for bulk exports of 'everyone'.                                                                                                           |
| Override segment window until | datetime        | No       | End of the replacement segment window.                                                                                                                                                                                                  |
| Event scope                   | select (string) | No       | For event exports: which events to include relative to the segment's event criteria. Available values: Only matching events, All events on pages with a match, All events in sessions with a match, All events by matching individuals. |
| Fields                        | array           | No       | Restrict the export to these columns, for example UserId, SessionId, EventStart, PageUrl. Empty exports every field.                                                                                                                    |
| Timezone                      | string          | No       | IANA timezone used to resolve the segment's relative dates.                                                                                                                                                                             |

**Outputs**

| Field        | Type   | Description                                                    |
| ------------ | ------ | -------------------------------------------------------------- |
| Operation ID | string | Track the export with Get Segment Export Status using this id. |

#### Get Segment Export Status

Check whether a segment export has finished and get its download link.

**Inputs**

| Field        | Type   | Required | Description                                         |
| ------------ | ------ | -------- | --------------------------------------------------- |
| Operation ID | string | Yes      | The operation id returned by Create Segment Export. |

**Outputs**

| Field                    | Type     | Description                                  |
| ------------------------ | -------- | -------------------------------------------- |
| State                    | string   | PENDING, COMPLETED or FAILED.                |
| Progress (%)             | integer  | Fullstory's progress estimate, 0 to 100.     |
| Error details            | string   | Why the export failed, when it did.          |
| Created at               | datetime | When the export was scheduled.               |
| Finished at              | datetime | When the export completed or failed.         |
| Search export ID         | string   | Fullstory's id for the produced export file. |
| Download URL             | string   | Temporary link to download the export file.  |
| Download link expires at | datetime | When the download link stops working.        |

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