---
title: "Unity SDK setup"
description: "Install and initialize Gleap in your application with the Gleap Unity SDK. Follow the integration code examples."
url: https://docs.gleap.ai/en/articles/664-unity-sdk-setup
collection: "Unity (Beta)"
updated: 2026-11-01
language: en
---

# Unity SDK setup

Install and initialize Gleap in your application with the Gleap Unity SDK. Follow the integration code examples.

The Gleap SDK for Unity is the easiest way to integrate Gleap into your games and real-time apps. Communicate with your users directly and build better software by discovering their everyday pain points. Gleap is your all-in-one customer feedback tool for apps and websites.

For the SDK to work, you need an API key, which you can get for free at [app.gleap.ai](https://app.gleap.ai).

#### Supported platforms

<table style="min-width: 50px;"><colgroup><col style="min-width: 25px;"><col style="min-width: 25px;"></colgroup><tbody><tr><th colspan="1" rowspan="1"><p>✅ Standalone / Mobile (via a WebView plugin)</p></th><th colspan="1" rowspan="1"><p>✴️ WebGL (via the <a target="_blank" rel="noopener noreferrer nofollow" class="linktype-link link" data-linktype="link" href="https://gleap-developer-docs.gleap.help/en/articles/393-javascript-sdk-setup">JavaScript SDK</a>)</p></th></tr></tbody></table>

> **Info:** **Beta.** The Gleap C# SDK is published as a pre-release (`0.1.0-beta.1`). Expect the odd change before the stable `1.0` release.

## 🏗 Installation

The Unity binding ships as the UPM package `com.gleap.sdk` (it reuses the shared `Gleap.Core` engine, whose DLLs are bundled under `Runtime/Plugins/`). Unity supplies persistence (`PlayerPrefs`), device metadata (`SystemInfo`) and console-log capture; you supply a WebView channel that renders the widget.

### Requirements

-   **Unity** with the [Newtonsoft Json](https://docs.unity3d.com/Packages/com.unity.nuget.newtonsoft-json@latest) package (declared as a dependency).
    
-   A **WebView plugin** for Standalone/Mobile (e.g. [Vuplex 3D WebView](https://developer.vuplex.com/)).
    

### Add the package

In Unity open **Package Manager → Add package from git URL…** and enter:

```javascript
https://github.com/GleapSDK/CSharp-SDK.git?path=/unity/com.gleap.sdk#v0.1.0-beta.1
```

`Gleap.Core.dll` and its dependencies are bundled under `Runtime/Plugins/`. If Unity reports duplicate framework facades on import, delete those specific DLLs and keep `Gleap.Core.dll`, `System.Text.Json.dll`, `System.Text.Encodings.Web.dll`, `Microsoft.Bcl.AsyncInterfaces.dll` and `System.IO.Pipelines.dll`.

### Configure the SDK

Bring your own WebView, route its page→native messages into a `GleapUnityWebViewChannel`, then attach Gleap:

```csharp
using GleapSDK;
using GleapSDK.Unity;

var channel = new GleapUnityWebViewChannel(js => myWebView.ExecuteJavaScript(js));
await GleapUnity.AttachAsync(channel, "YOUR_SDK_KEY"); // IL2CPP-safe Newtonsoft serializer by default
Gleap.Open();

// Optional: add GleapUnityLogHook to a persistent GameObject to capture Debug.Log output.
```

Once attached, drive Gleap from anywhere via the stable static facade (`Gleap.StartConversation()`, `Gleap.TrackEvent(...)`, …).

Congratulations 🎉 You are all set 👋

## Platform notes

-   Unity has **no built-in WebView** — use `GleapUnityWebViewChannel` together with a commercial WebView plugin on Standalone/Mobile.
    
-   On **WebGL**, the widget frame is a cross-origin iframe you cannot inject into — front the existing [Gleap JavaScript SDK](https://gleap-developer-docs.gleap.help/en/articles/393-javascript-sdk-setup) from a `.jslib` instead of this managed channel.
    
-   The default **Newtonsoft** serializer is IL2CPP-safe; a `link.xml` protects the Gleap DTOs from AOT stripping.
    

> **Note:** [Data regions](https://gleap-developer-docs.gleap.help/en/articles/711-data-regions) are not supported by this SDK yet. It always connects to the EU region.

## 🤝 Need help?

We are here to help! [hello@gleap.ai](mailto:hello@gleap.ai)

## Related

- [Unity SDK: User identity](https://docs.gleap.ai/en/articles/665-unity-sdk-user-identity.md)
- [Unity SDK: Track events](https://docs.gleap.ai/en/articles/666-unity-sdk-track-events.md)
- [Unity SDK: Track pages](https://docs.gleap.ai/en/articles/667-unity-sdk-track-pages.md)
- [Unity SDK: Forms](https://docs.gleap.ai/en/articles/668-unity-sdk-forms.md)
- [Unity SDK: Frontend tools](https://docs.gleap.ai/en/articles/669-unity-sdk-frontend-tools.md)