Authentication

Create User

Before you log in a user, the user must exist in CometChat.

For proof of concept / MVPs: Create users via the CometChat Dashboard.
For production apps: Use the Create User REST API when your user signs up.

Sample UsersCometChat provides 5 pre-created users for testing: cometchat-uid-1, cometchat-uid-2, cometchat-uid-3, cometchat-uid-4, and cometchat-uid-5.

This authentication method is ideal for proof-of-concept development or early-stage apps. For production environments, we recommend using an Auth Token instead of an Auth Key for enhanced security.

Auth Flow

The Login node authenticates a user with CometChat. You should call it:

When the user is logging in for the first time
When IsLoggedIn returns false

Blueprint
C++

Get a reference to the CometChat Subsystem
Call the Login Async node
Wire the On Success and On Failure pins

Parameter	Type	Description
Uid	`FString`	The unique ID of the user to log in
Auth Key	`FString`	Your CometChat Auth Key

#include "CometChatSubsystem.h"
#include "AsyncActions/CometChatLoginAction.h"

void AMyActor::BeginPlay()
{
    Super::BeginPlay();

    // 1. Configure the SDK (do this once)
    UCometChatSubsystem* Chat = GetGameInstance()->GetSubsystem<UCometChatSubsystem>();
    Chat->Configure(TEXT("YOUR_APP_ID"), TEXT("us"));

    // 2. Bind real-time events before login
    Chat->OnMessageReceived.AddDynamic(this, &AMyActor::OnMessage);

    // 3. Login
    if (!Chat->IsLoggedIn())
    {
        auto* Login = UCometChatLoginAction::LoginAsync(
            this,
            TEXT("cometchat-uid-1"),
            TEXT("YOUR_AUTH_KEY")
        );
        Login->OnSuccess.AddDynamic(this, &AMyActor::OnLoginSuccess);
        Login->OnFailure.AddDynamic(this, &AMyActor::OnLoginFailed);
        Login->Activate();
    }
}

void AMyActor::OnLoginSuccess()
{
    UE_LOG(LogTemp, Log, TEXT("Login successful!"));
}

void AMyActor::OnLoginFailed(const FString& Error)
{
    UE_LOG(LogTemp, Error, TEXT("Login failed: %s"), *Error);
}

UID format: UIDs can be alphanumeric with underscores and hyphens. Spaces, punctuation, and other special characters are not allowed.

This is the recommended authentication method for production apps. Auth Tokens are generated server-side using the CometChat REST API and provide enhanced security since your Auth Key is never exposed on the client.

How Auth Tokens Work

Your backend calls the Create Auth Token REST API with the user’s UID
The API returns an Auth Token
Your backend sends the token to the Unreal client
The client calls LoginWithAuthTokenAsync with the token

Blueprint
C++

Get a reference to the CometChat Subsystem
Call the Login With Auth Token Async node
Wire the On Success and On Failure pins

Parameter	Type	Description
Auth Token	`FString`	The auth token received from your backend

#include "CometChatSubsystem.h"
#include "AsyncActions/CometChatLoginWithAuthTokenAction.h"

void AMyActor::LoginWithToken(const FString& AuthToken)
{
    UCometChatSubsystem* Chat = GetGameInstance()->GetSubsystem<UCometChatSubsystem>();

    if (!Chat->IsLoggedIn())
    {
        auto* Login = UCometChatLoginWithAuthTokenAction::LoginWithAuthTokenAsync(
            this,
            AuthToken
        );
        Login->OnSuccess.AddDynamic(this, &AMyActor::OnLoginSuccess);
        Login->OnFailure.AddDynamic(this, &AMyActor::OnLoginFailed);
        Login->Activate();
    }
}

void AMyActor::OnLoginSuccess()
{
    UE_LOG(LogTemp, Log, TEXT("Auth token login successful!"));
}

void AMyActor::OnLoginFailed(const FString& Error)
{
    UE_LOG(LogTemp, Error, TEXT("Auth token login failed: %s"), *Error);
}

Security: Never hardcode Auth Tokens in your client. Always fetch them from your backend at runtime.

Before performing operations, you can check whether a user is currently logged in.

Blueprint
C++

Call the Is Logged In node on the CometChat Subsystem. It returns a bool.

UCometChatSubsystem* Chat = GetGameInstance()->GetSubsystem<UCometChatSubsystem>();

if (Chat->IsLoggedIn())
{
    // User is authenticated — safe to send messages, fetch data, etc.
}

Logout

Logs the current user out and disconnects the real-time WebSocket.

Blueprint
C++

Call the Logout Async node on the CometChat Subsystem. Wire the On Success and On Failure pins.

#include "AsyncActions/CometChatLogoutAction.h"

void AMyActor::PerformLogout()
{
    auto* Logout = UCometChatLogoutAction::LogoutAsync(this);
    Logout->OnSuccess.AddDynamic(this, &AMyActor::OnLogoutSuccess);
    Logout->OnFailure.AddDynamic(this, &AMyActor::OnLogoutFailed);
    Logout->Activate();
}

Shutdown

To fully tear down the SDK (e.g., when your game is closing), call Shutdown on the Subsystem. This releases all resources and closes connections.

Blueprint
C++

Call the Shutdown node on the CometChat Subsystem.

UCometChatSubsystem* Chat = GetGameInstance()->GetSubsystem<UCometChatSubsystem>();
Chat->Shutdown();

You typically don’t need to call Shutdown manually — the Subsystem’s Deinitialize handles cleanup when the game instance is destroyed.

Messaging

Users & Groups

Reference

Authentication

Create User

Auth Flow

How Auth Tokens Work

Logout

Shutdown

Next Steps

Send a Message

Real-Time Events

Authentication

Messaging

Users & Groups

Reference

Documentation Index

​Create User

​Login using Auth Key

​Auth Flow

​Login using Auth Token

​How Auth Tokens Work

​Check Login State

​Logout

​Shutdown

​Next Steps

Send a Message

Real-Time Events

Create User

Login using Auth Key

Auth Flow

Login using Auth Token

How Auth Tokens Work

Check Login State

Logout

Shutdown

Next Steps