config.yml

The main configuration of the plugin.

Any configuration changes can be reloaded on the fly using the /webhooklogger reload command. Permission for the reload command is webhooklogger.command.reload.

Webhooks

This is where you define the webhook URL's and which events go to which webhook.

The default configuration section will look like this:

webhooks:
- url: ''
  events:
  - CHAT

Instructions on how to acquire the webhook URL can be found here.

Multiple webhooks

Defining multiple webhooks is just a simple matter of copy pasting the existing webhook like this:

webhooks:
- url: 'https://discord.com/api/webhooks/<id>/<token>'
  events:
  - CHAT
  - COMMAND
- url: 'https://discord.com/api/webhooks/<id>/<token>'
  events:
  - DEATH

Important

YAML uses spaces for intendation and will break if formatted incorrectly. You can use a tool such as YAMLlint to check if your configuration is valid.

In the example above we've defined 2 webhooks. First one logging CHAT and COMMAND events and the second one just the DEATH event.

Optional settings

There are additional settings you may optionally configure per webhook.

Name	Description	Default value
send-rate	In seconds, how often buffered events are sent to Discord. To avoid rate limiting, this should never be below 5 seconds.	5
message-style	Supported styles are NORMAL or CODE_BLOCK. Code block takes more space but supports 16 colors.	NORMAL
minimum-queue-size	How many events need to be queued before sending. Useful for grouping events and sending them in bulk.	1

Text replacements

# You can use this to filter or replace text.
# Supports regex.
textReplacements:
  '#': (hashtag)
  '@': (at)

Placeholders

placeholders:
  # Format for the <timestamp> placeholder.
  timestampFormat: HH:mm:ss
  # The timezone used in <timestamp> placeholder.
  # Set to 'default' to use the server timezone.
  timestampTimezone: default
  # The text used in <cancelled> placeholder.
  cancelled: '[Cancelled] '