events

name	events
description	Use playfab-cli to write PlayStream events, telemetry events, and manage telemetry keys. Use when the user needs to emit custom events, set up telemetry pipelines, or manage telemetry key lifecycle. Do not use for reading event data or analytics queries.
allowed-tools	Bash, Read, Grep, Glob
metadata	{"author":"akiojin","version":"0.2.0","category":"analytics"}

PlayStream Events and Telemetry

Use playfab-cli to write events and manage telemetry keys.

Use When

• The user needs to write custom PlayStream events.
• The user wants to send telemetry data to the telemetry pipeline.
• The user needs to create, manage, or rotate telemetry keys.
• The task involves event tracking or analytics instrumentation.

Do Not Use When

• The user needs to read or query event data (use PlayFab Game Manager or Data Explorer).
• The user needs experimentation features (use experimentation skill).
• The user needs server-side event writing (use server skill for server_write_* tools).

Available Tools

Tool	Description
write_events	Write one or more PlayStream events
write_telemetry_events	Write one or more telemetry events to the telemetry pipeline
create_telemetry_key	Create a new telemetry key for the title
delete_telemetry_key	Delete an existing telemetry key
get_telemetry_key	Get details of a specific telemetry key
list_telemetry_keys	List all telemetry keys for the title
set_telemetry_key_active	Activate or deactivate a telemetry key

Examples

Write a PlayStream event

playfab-cli tool call write_events --json '{
  "events": [
    {
      "name": "player_level_up",
      "eventNamespace": "custom.gameplay",
      "payload": {"newLevel": 10, "previousLevel": 9},
      "entity": {"Id": "ABCD1234", "Type": "title_player_account"}
    }
  ]
}'

Write multiple events

playfab-cli tool call write_events --json '{
  "events": [
    {
      "name": "item_purchased",
      "eventNamespace": "custom.economy",
      "payload": {"itemId": "sword-001", "price": 500, "currency": "gold"}
    },
    {
      "name": "currency_spent",
      "eventNamespace": "custom.economy",
      "payload": {"currency": "gold", "amount": 500, "reason": "purchase"}
    }
  ]
}'

Write telemetry events

playfab-cli tool call write_telemetry_events --json '{
  "events": [
    {
      "name": "session_start",
      "eventNamespace": "custom.telemetry",
      "payload": {"platform": "iOS", "appVersion": "1.2.3", "deviceModel": "iPhone15"}
    }
  ]
}'

Create a telemetry key

playfab-cli tool call create_telemetry_key --json '{"keyName": "mobile-client-key"}'

List telemetry keys

playfab-cli tool call list_telemetry_keys --json '{}'

Get telemetry key details

playfab-cli tool call get_telemetry_key --json '{"keyName": "mobile-client-key"}'

Activate/deactivate a key

playfab-cli tool call set_telemetry_key_active --json '{"keyName": "mobile-client-key", "active": false}'

Delete a telemetry key

playfab-cli tool call delete_telemetry_key --json '{"keyName": "old-key"}'

Common Workflows

1. Set up telemetry pipeline

# Create key for client
playfab-cli tool call create_telemetry_key --json '{"keyName": "game-client"}'
# Verify
playfab-cli tool call get_telemetry_key --json '{"keyName": "game-client"}'
# Test event writing
playfab-cli tool call write_telemetry_events --json '{"events": [{"name": "test", "eventNamespace": "custom.test", "payload": {"test": true}}]}'

2. Rotate telemetry keys

# Create new key
playfab-cli tool call create_telemetry_key --json '{"keyName": "game-client-v2"}'
# Deactivate old key
playfab-cli tool call set_telemetry_key_active --json '{"keyName": "game-client-v1", "active": false}'
# Delete old key after migration
playfab-cli tool call delete_telemetry_key --json '{"keyName": "game-client-v1"}'

3. Track custom game events

playfab-cli tool call write_events --json '{
  "events": [
    {"name": "match_completed", "eventNamespace": "custom.gameplay", "payload": {"matchId": "m-123", "duration": 300, "winner": "PLAYER_A"}},
    {"name": "xp_earned", "eventNamespace": "custom.progression", "payload": {"amount": 150, "source": "match"}, "entity": {"Id": "PLAYER_A", "Type": "title_player_account"}}
  ]
}'

Notes

• PlayStream events are processed in real-time and can trigger rules and actions.
• Telemetry events are sent to a separate pipeline optimized for high-volume data.
• Telemetry keys authenticate direct telemetry event writes from clients.
• Event namespaces should follow the pattern custom.<domain> for custom events.