[Foundry P1] Install & validate foundryvtt-rest-api on the production Foundry instance #4

New issue

Open

opened 2026-06-23 00:42:30 +00:00 by rbrooks · 0 comments

rbrooks commented

2026-06-23 00:42:30 +00:00

Owner

Do this first, before any adapter code. The REST module is documented as version-sensitive, so confirm it works on the actual target instance before sinking adapter time.

Scope

Install and configure the ThreeHats/foundryvtt-rest-api module on the production Foundry instance.
Set up the API key on the Foundry side.
Document, in docs/, the required module version, API key setup steps, and the Foundry core version the integration is tested against.

Notes

The module has historically been sensitive to Foundry core upgrades. Record the tested module + core version pair and flag compatibility as a maintenance concern whenever either is updated.
Foundry is often hosted locally or behind a VPN - validate against the real instance, not a throwaway.

Done when

Module installed on prod Foundry, reachable from the backend, version pair documented.

Roadmap: FoundryVTT Bidirectional Integration, Phase 1 step 1.

**Do this first**, before any adapter code. The REST module is documented as version-sensitive, so confirm it works on the actual target instance before sinking adapter time. ## Scope - Install and configure the **ThreeHats/foundryvtt-rest-api** module on the production Foundry instance. - Set up the API key on the Foundry side. - Document, in `docs/`, the required module version, API key setup steps, and the Foundry **core version** the integration is tested against. ## Notes - The module has historically been sensitive to Foundry core upgrades. Record the tested module + core version pair and flag compatibility as a maintenance concern whenever either is updated. - Foundry is often hosted locally or behind a VPN - validate against the real instance, not a throwaway. ## Done when - Module installed on prod Foundry, reachable from the backend, version pair documented. _Roadmap: FoundryVTT Bidirectional Integration, Phase 1 step 1._

rbrooks added this to the v4.0.0 - FoundryVTT Phase 1: Foundation milestone

2026-06-23 00:42:30 +00:00

rbrooks added the

backend

enhancement

labels

2026-06-23 00:42:30 +00:00

rbrooks referenced this issue

2026-06-24 04:21:51 +00:00

[Foundry] Bidirectional integration — architecture & design reference #24