> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenReplay

> How to set up the OpenReplay connector, plus the actions and events that are available.

![OpenReplay](https://stackone-logos.com/api/openreplay/filled/svg)

Previewv0.1.0[See changelog](https://docs.stackone.com/connectors/openreplay/changelog.md)

[13 actions](#actions) · [1 event](#events) · 1 auth method

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/openreplay/guides/connector-profile/api-key.md)
>
> Uses the Organization API Key as a Bearer token. Works with OpenReplay Cloud by default, or a Cloud Dedicated or self-ho...

Optionally, configure receiving Events for OpenReplay into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/openreplay/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/openreplay/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

13 actions

ActionDescription

Retrieve Live Sessions`openreplay_retrieve_live_sessions`

Retrieve the sessions currently live in a project, optionally for one user (Enterprise Edition).

Search Live Sessions`openreplay_search_live_sessions`

Search the live sessions of a project with filters, sorting and paging (Enterprise Edition).

Retrieve Events`openreplay_retrieve_events`

Retrieve the events captured during a session, paged and optionally filtered.

List All Jobs`openreplay_list_all_jobs`

List the data jobs of a project, such as user data deletion jobs.

Get Job Details`openreplay_get_job_details`

Get the status and details of one job.

Cancel Job`openreplay_cancel_job`

Cancel a job that has not finished yet.

Create Project`openreplay_create_project`

Create a new project in the current OpenReplay tenant.

List Projects`openreplay_list_projects`

List all projects in the current OpenReplay tenant.

Get Project`openreplay_get_project`

Get a single project by its project key.

Retrieve User Sessions`openreplay_retrieve_user_sessions`

Retrieve the recorded sessions of one user within a time window.

Search Users`openreplay_search_users`

Search the identified users of a project with a free-text query, filters and a time window.

Get User`openreplay_get_user`

Get the profile of one identified user in a project.

Delete User`openreplay_delete_user`

Schedule deletion of a user's data from a project.

## Events

Tags

Select all
|
Clear

Alerts

Webhook

No tags found

1 event

EventDescriptionTags

Alert Triggered`openreplay_webhook_alert_triggered`

Processes OpenReplay alert notifications sent to a webhook.

WebhookAlerts


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.