Skip to main content
PATCH
/
v1
/
worlds
/
{id}
/
events
/
{eventName}
Update an event
curl --request PATCH \
  --url https://api.alakazam.gg/v1/worlds/{id}/events/{eventName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "from": [
    "<string>"
  ],
  "to": "<string>",
  "base": "<string>",
  "detail": "<string>",
  "hotkey": "<string>",
  "hidden": true,
  "oneShot": true,
  "requires": [
    "<string>"
  ],
  "grants": [
    "<string>"
  ]
}
'
{
  "world": {
    "id": "<string>",
    "name": "<string>",
    "entrance": {
      "image": {
        "src": "<string>",
        "label": "<string>"
      },
      "state": "<string>"
    },
    "scene": {
      "states": {},
      "events": [
        {}
      ]
    },
    "description": "<string>",
    "cover": "<string>"
  },
  "diagnostics": [
    {
      "lint": "<string>",
      "path": "<string>",
      "message": "<string>",
      "loc": {
        "field": "<string>",
        "template": "<string>",
        "slot": "<string>",
        "fill": "<string>"
      }
    }
  ],
  "rev": "<string>",
  "schemaVersion": "1.0"
}

Authorizations

Authorization
string
header
required

An app API key, e.g. Authorization: Bearer sk_live_…. Secret (sk_) for writes/sessions; publishable (pk_) for read/embed.

Headers

If-Match
string

Path Parameters

id
string<uuid>
required
eventName
string
required

Body

application/json

An edge in the graph, addressed by its unique name. A transition MUST carry a to; an override MUST NOT. Optional fields beyond those listed are allowed (forward-compatible).

name
string
required

Unique edge id within the world.

kind
enum<string>
required
Available options:
transition,
override,
terminal
from
string[]
required

Source state id(s) this edge fires from.

to
string

Destination state id. Required for transition, forbidden for override.

base
string
detail
string
hotkey
string | null

Bound key. Reserved keys (WASD / digits) are rejected.

hidden
boolean
oneShot
boolean
requires
string[]
grants
string[]

Response

Event updated

The result of a graph write. world is the new, kernel-validated world; diagnostics carries advisory (warning/info) findings; rev is the new concurrency token (also returned as the ETag header).

world
object

A playable world. The full contract is published as JSON Schema at https://alakazam.gg/schema/smworld-1.0.json (see schema/COMPATIBILITY.md). Additional optional properties are allowed (forward-compatible).

diagnostics
object[]
rev
string

The new revision token. Pass it as If-Match on the next write.

schemaVersion
string
Example:

"1.0"