Docs / FiveM / QB-Core Setup

QB-Core Setup

Full integration guide for QB-Core based FiveM servers. This covers whitelist syncing, player identification, and admin log forwarding specific to the QB-Core framework.

Requirements

  • QB-Core framework installed and running
  • Docket Pro or Enterprise subscription
  • Server file access (FTP or txAdmin)
  • Your Docket API key from Dashboard > Integrations > FiveM

Config setup

After placing the docket-fivem resource in your resources folder, open docket-fivem/config.lua and set the following:

Config.ApiKey    = "your-api-key-here"
Config.GuildId   = "your-discord-guild-id"
Config.Framework = "qb-core"

-- QB-Core specific
Config.QBCore = exports['qb-core']:GetCoreObject()

-- Optional: whitelist sync
Config.WhitelistEnabled = true
Config.WhitelistPermission = "allowed"  -- qb-core permission level

-- Optional: admin log forwarding
Config.AdminLogs = true

Whitelist sync with QB-Core

When a whitelist application is approved in Docket, the bot posts the approval to the Docket API, which then calls the docket-fivem resource's exported function to grant the player permission in QB-Core.

The player is identified by their Discord ID. Docket passes the Discord ID in the whitelist approval webhook, and the resource finds the matching player in the QB-Core players table and sets their permission level to allowed (or whatever level you configured).

If the player has never joined your server before, the permission is stored in a pending table and applied on their first connection.

Admin log forwarding

QB-Core admin actions (from qb-admin or any resource using QB-Core's event system) are forwarded to Docket via a server-side event hook in the resource. The following actions are captured:

  • Player kicks (with reason)
  • Player bans (temporary and permanent)
  • Freeze and spectate actions by admins
  • Give weapon / give item commands from admin panel
  • Teleport to player actions

All captured actions appear in Dashboard > Moderation > Admin Logs and optionally in your configured Discord log channel.

FiveM OverviewWhitelist Sync