Events
GET /hooks/subscribe
Subscribe to real-time events via Server-Sent Events (SSE)
Opens a persistent SSE connection for the specified event type. Supported event types: hooks (all Foundry hooks), combat, actor, scene.
Required scope: events:subscribe
Parameters
| Name | Type | Required | Source | Description |
|---|---|---|---|---|
| clientId | string | query | Client ID for the Foundry world | |
| hooks | string | query | Comma-separated hook names to filter (hooks type only) | |
| encounterId | string | query | Filter by encounter ID (combat type only) | |
| actorUuid | string | query | Actor UUID to subscribe to (actor type only; optional — omit to receive events for all actors on this client) | |
| sceneId | string | query | Scene ID to filter (scene type only) |
Returns
SSE stream - SSE event stream
Try It Out
GET /encounters/subscribe
Subscribe to real-time events via Server-Sent Events (SSE)
Opens a persistent SSE connection for the specified event type. Supported event types: hooks (all Foundry hooks), combat, actor, scene.
Required scope: events:subscribe
Parameters
| Name | Type | Required | Source | Description |
|---|---|---|---|---|
| clientId | string | query | Client ID for the Foundry world | |
| hooks | string | query | Comma-separated hook names to filter (hooks type only) | |
| encounterId | string | query | Filter by encounter ID (combat type only) | |
| actorUuid | string | query | Actor UUID to subscribe to (actor type only; optional — omit to receive events for all actors on this client) | |
| sceneId | string | query | Scene ID to filter (scene type only) |
Returns
SSE stream - SSE event stream
Try It Out
GET /actor/subscribe
Subscribe to real-time events via Server-Sent Events (SSE)
Opens a persistent SSE connection for the specified event type. Supported event types: hooks (all Foundry hooks), combat, actor, scene.
Required scope: events:subscribe
Parameters
| Name | Type | Required | Source | Description |
|---|---|---|---|---|
| clientId | string | query | Client ID for the Foundry world | |
| hooks | string | query | Comma-separated hook names to filter (hooks type only) | |
| encounterId | string | query | Filter by encounter ID (combat type only) | |
| actorUuid | string | query | Actor UUID to subscribe to (actor type only; optional — omit to receive events for all actors on this client) | |
| sceneId | string | query | Scene ID to filter (scene type only) |
Returns
SSE stream - SSE event stream
Try It Out
GET /scene/subscribe
Subscribe to real-time events via Server-Sent Events (SSE)
Opens a persistent SSE connection for the specified event type. Supported event types: hooks (all Foundry hooks), combat, actor, scene.
Required scope: events:subscribe
Parameters
| Name | Type | Required | Source | Description |
|---|---|---|---|---|
| clientId | string | query | Client ID for the Foundry world | |
| hooks | string | query | Comma-separated hook names to filter (hooks type only) | |
| encounterId | string | query | Filter by encounter ID (combat type only) | |
| actorUuid | string | query | Actor UUID to subscribe to (actor type only; optional — omit to receive events for all actors on this client) | |
| sceneId | string | query | Scene ID to filter (scene type only) |
Returns
SSE stream - SSE event stream