Webhooks & Logs

What it isCopy Anchor Link

Many systems post a log to Discord when something happens: a ban, a robbery, a house break-in, a black market buy. All of these logs are set in one file:

server-data/resources/[scripts]/[standalone]/mvx_scripts/modules/webhooks/config.lua

Each log has a channel name, for example admin_bans or housing. You paste a Discord webhook link next to a channel, and that log starts showing up in Discord. A channel with no link sends nothing.

How to make a Discord webhookCopy Anchor Link

1. In Discord, open the channel that should get the logs (for example #ban-logs).
2. Click the gear next to the channel name: Edit Channel → Integrations → Webhooks.
3. Press New Webhook. Give it a name if you want (the server sets its own name anyway).
4. Press Copy Webhook URL. The link starts with https://discord.com/api/webhooks/.

You can make one webhook per Discord channel, or use the same link for several log channels.

Where to paste itCopy Anchor Link

Open modules/webhooks/config.lua and paste the link between the quotes of the channel:

Webhooks = {
    default = '',
    admin_bans = 'https://discord.com/api/webhooks/123.../abc...',
    housing = '',
    -- ...
}

Then restart mvx_scripts (in the txAdmin console: restart mvx_scripts) or the whole server.

Rules

• An empty channel ('') uses the default link. If default is also empty, that log is off.
• To send everything to one Discord channel, fill in only default.
• To turn one channel off while default is set, add its name to disabled in WebhookSettings, for example disabled = { 'connections' }.

Or keep the links in server.cfg. A line in server-data/server.cfg beats the file:

set mvx_webhook_admin_bans "https://discord.com/api/webhooks/..."
set mvx_webhook_default "https://discord.com/api/webhooks/..."

The name is always mvx_webhook_ + the channel name. Use set, never setr: setr would send the link to every player.

Every channelCopy Anchor Link

Bot name, picture and coloursCopy Anchor Link

Below the channels, WebhookSettings sets how the logs look:

To get a role ID: in Discord turn on User Settings → Advanced → Developer Mode, then Server Settings → Roles, right-click the role → Copy Role ID.

Logs that have their own settingCopy Anchor Link

• ox_inventory and ox_lib logs (item moves, shop buys, admin item commands) do not go to Discord. They go to Fivemanage, Datadog or Grafana Loki. To turn them on, add to server.cfg: set ox:logger "fivemanage" and set fivemanage:key "<your Fivemanage logs token>".
• ox_inventory image check: set inventory:webhook "<link>" in server-data/oxinventory.cfg checks the picture link of items and posts each one there. Leave it empty unless items get custom pictures.

Admin Quick TestCopy Anchor Link

Setup

1. Make a test webhook in a private Discord channel (see How to make a Discord webhook).
2. Paste it into admin_actions in modules/webhooks/config.lua, save, and type restart mvx_scripts in the txAdmin console. The console prints webhooks: 1 of 17 log channels send to Discord.

Test command

3. In the txAdmin console type webhooktest. It lists the channels that are On and Off; admin_actions is On.
4. Type webhooktest admin_actions. A green Webhook test log appears in your Discord channel within a few seconds.
5. Type webhooktest housing. It says the channel has no link and nothing is sent.

A real log

6. Have a second player online. Press HOME, click the player and press Kick with the reason "test". A red Player Kicked log appears in Discord with the name, identifiers, reason and your name as executioner.
7. Paste the same link into default and leave housing empty. Restart mvx_scripts, then open the storage of a house you own. A Storage log appears: empty channels fall back to default.

Clean up

8. Delete the test webhook in Discord, or replace it with the real ones for each channel.