Satori Integration

Satori is the LiveOps solution from Heroic Labs, designed from inception to seamlessly integrate and work with Nakama. This guide demonstrates interacting with Satori via the Nakama server framework.

Prerequisites #

• Nakama instance
  • Satori configuration
• Satori instance

Getting started #

Learn how to configure and get started using the Satori Client via the Nakama server runtime.

Configuration #

You’ll need to create a Satori API Key for Nakama to use, and also copy the session.signingkey from the Satori configuration.

The Satori server connection details are configured in your Nakama configuration.

Satori client #

The Satori Client connects to your Satori Server and is the entry point to access Satori features. Fetch the Satori client as follows:

1

satori := nk.GetSatori()

1

const satori = nk.getSatori();

1

local satori = nk.get_satori()

Authentication #

Authenticate users with Satori and create a corresponding Satori identity, if one does not exist already. The id used can be the Nakama user ID or any other unique identifier.

1
2

userId := "user-id"
satori.Authenticate(ctx, userId)

1
2

const userId = "user-id";
satori.authenticate(userId);

1
2

local userId = "user-id"
satori.authenticate(userId)

Properties #

Fetch the associated properties of an identity, and update any of these properties as desired.

Get properties #

To fetch the properties of an identity:

1

properties, err := satori.PropertiesGet(ctx, "identityId")

1

const properties = satori.propertiesGet("identityId");

1

local properties = satori.properties_get("identityId")

Update properties #

To update the properties of an identity:

1
2
3
4
5
6
7
8

err := satori.PropertiesUpdate(ctx, "identityId", &runtime.PropertiesUpdate{
  Default: map[string]string{
    "language": "japanese",
  },
  Custom: map[string]string{
    "customProperty": "someValue",
  },
}, true)

1
2
3
4
5
6
7
8

satori.propertiesUpdate("identityId", {
    default: {
        language: "japanese"
    },
    custom: {
        someKey: "someValue"
    }
}, true);

1
2
3
4
5
6
7
8

satori.properties_update("identityId", {
    ["default"] = {
        ["language"] = "japanese"
    },
    ["custom"] = {
        ["someKey"] = "someValue"
    }
}, true)

When updating an identity’s properties, you can set an optional recompute parameter (set to true in the example above) to re-evaluate this identity’s audience memberships. This is useful if you have changed the properties of an identity and want to immediately update the audience membership.

Events #

Publish one or more events to Satori for a given identity.

1
2
3
4
5
6
7
8
9

satori.EventsPublish(ctx, "identityId", []*runtime.Event{{
  Name: "eventName",
  Id: "optionalEventId",
  Metadata: map[string]string{
    "someKey": "someValue",
  },
  Value: "someValue",
  Timestamp: time.Now().Unix(),
}})

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

satori.eventsPublish("identityId", [
    {
        name: "eventName",
        id: "optionalEventId",
        metadata: {
            "someProperty": "someValue"
        },
        value: "someValue",
        timestamp: Date.now()
    }
]);

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

satori.events_publish("identityId", {
    {
        ["name"] = "eventName",
        ["id"] = "optionalEventId",
        ["metadata"] = {
            ["someProperty"] = "someValue"
        },
        ["value"] = "someValue",
        ["timestamp"] = os.time()
    }
})

Experiments #

You can list all experiments for a given identity, or optionally filter by a specific experiment.

1

experimentList, err := satori.ExperimentsList(ctx, "identityId", "experimentName1", "experimentName2")

1

const experiments = satori.experimentsList("identityId", ["experimentName1", "experimentName2"]);

1

local experiments = satori.experiments_list("identityId", { "experimentName1", "experimentName2" })

Feature Flags #

You can list all flags for a given identity, or optionally filter by a specific feature flag.

1

flagList, err := satori.FlagsList(ctx, "identityId", "flagName1", "flagName2")

1

const flags = satori.flagsList("identityId", ["flagName1", "flagName2"]);

1

local flags = satori.flags_list("identityId", { "flagName1", "flagName2" })

Live Events #

You can list all Live Events for a given identity, or optionally filter by a specific live event.

1

liveEventList, err := satori.LiveEventsList(ctx, "identityId", "liveEventName1", "liveEventName2")

1

const liveEvents = satori.liveEventsList("identityId", ["liveEventName1", "liveEventName2"])

1

local liveEvents = satori.live_events_list("identityId", { "liveEventName1", "liveEventName2" })