Skip to main content

Quickstart

1. Create a game​

In the Guardyn dashboard:

  1. Open Games.
  2. Add the game name and Roblox universe ID.
  3. Keep the generated Guardyn game ID available for your server-side code.

2. Create an API key​

Open Development, create an API key, and copy it immediately. Guardyn stores only a keyed hash and cannot reveal the complete value later. If it is lost, revoke it and create a replacement.

3. Create the Roblox Secret​

In Creator Hub, open your game and create a Secret:

  • Name: GUARDYN_API_KEY
  • Value: the complete Guardyn API key
  • Allowed domain: api.guardyn.xyz

In Roblox Studio, enable Allow HTTP Requests under File > Experience Settings > Security.

4. Build the integration​

Guardyn is API-only. Use the documented HTTP contract to build a prototype in an access-restricted test experience. Keep the API key and all HTTP calls in a server Script, and validate RemoteEvent input on the server. Optional community templates may be published separately in Resources.

Your interface may submit either a specific reported chat message or a player's written description of what happened. Both use the same text field. For a simple written-report form, send the player's complete response as one text value and leave context out.

5. Test safely​

Publish to an access-restricted test experience. Join with controlled test accounts, send a harmless synthetic message, submit a report, and confirm one case appears in the correct workspace and game. Apply a temporary restriction, rejoin with the scoped test account, then revoke it and verify access returns.

Roblox Secrets may not be available in every unpublished local test mode. A published restricted test is the final connection test.