Connect Guildbase to FiveRoster to automatically sync accepted applicants to your FiveM server whitelist. Perfect for roleplay communities using the FiveRoster whitelist system.
What is FiveRoster?
FiveRoster is a popular whitelist management system for FiveM servers. The Guildbase integration allows you to automatically add accepted applicants to your FiveRoster whitelist without manual intervention.
Prerequisites
Before setting up the integration, ensure you have:
- An active FiveRoster account with API access
- Your FiveRoster API key
- Server ID from FiveRoster
Setting Up the Integration
- Navigate to your guild's Integrations page
- Find the FiveRoster section
- Click Connect
- Enter your FiveRoster API key
- Enter your Server ID
- Click Save
Screenshot: FiveRoster integration settings
Finding Your API Key
- Log into your FiveRoster dashboard
- Navigate to Settings or API
- Generate or copy your API key
Keep It Secret
Your API key grants access to your FiveRoster account. Never share it publicly or commit it to version control.
Configuring Workflow Actions
After connecting, set up automatic whitelist sync:
- Go to Workflows and edit your workflow
- Select your "Accepted" stage
- Click Add Action
- Select FiveRoster Sync
- Configure the action settings
- Save the workflow
Identifier Mapping
To sync users to FiveRoster, Guildbase needs to know their identifier. You can collect this in your application template:
| Identifier Type | Format | Example |
|---|---|---|
| Steam ID | steam:XXXXXXX | steam:110000112345678 |
| Discord ID | discord:XXXXXXX | discord:123456789012345678 |
| License | license:XXXXXXX | license:abc123def456 |
Pro Tip
If applicants have Discord linked to Guildbase, their Discord ID can be automatically used as the identifier. Otherwise, add a field to your application template asking for their Steam ID.
Sync Options
Configure how the sync behaves:
| Option | Description |
|---|---|
| Add to Whitelist | Add the user to the FiveRoster whitelist |
| Remove from Whitelist | Remove the user (useful for rejected stage) |
| Assign Role | Assign a specific FiveRoster role |
Troubleshooting
Sync Failed
Check that your API key is valid and has the necessary permissions. Verify the identifier format is correct.
User Not Found
The identifier provided doesn't match any account. Ensure the applicant entered their identifier correctly.
API Rate Limited
You've made too many requests. Wait a few minutes and try again.
Note
FiveRoster integration is available on all plans. Check FiveRoster's pricing for any API usage limits on their end.