Skip to main content

transcripts.json object

The transcripts.json file allows you to configure everything related to transcripts. There are currently 2 types of transcripts available (text & HTML)! You can use these to save your ticket chats when they are deleted. More info about transcripts can be found here.

An example of the HTML Transcripts without custom background.An example of the HTML Transcripts without custom background.
HTML Transcripts FAQ

HTML Transcripts are currently hosted and processed at https://transcripts.dj-dj.be.

  • It is IMPOSSIBLE to change with the current version (v2)!
  • It will be POSSIBLE with the upcoming version (v3)!
  • The processing of transcripts will ALWAYS stay on our servers because the compiler is closed-source.

Custom domains will probably be a paid feature, but it will be very cheap. Suggestions are always welcome in our discord server!

If you need help with configuring the transcripts, feel free to join our discord server!

Table Of Contents

General Settings​

These are the general settings for the transcripts. Here you can configure where transcripts are sent and where not.

"general" object​

Configure where the transcripts are sent. You are able to send it to a channel or the DM's of participants.

  • "enabled": boolean - Enable the transcript system. When this is disabled, nothing will work!
  • "enableChannel": boolean - Send transcripts to a designated discord channel.
  • "enableCreatorDM": boolean - Send transcripts to the creator of the ticket via DM.
  • "enableParticipantDM": boolean - Send transcripts to all participants of the ticket via DM.
  • "enableActiveAdminDM": boolean - Send transcripts to admins who actively sent messages in the ticket.
  • "enableEveryAdminDM": boolean - Send transcripts to all admins assigned to the ticket, even if they didn't participate.
  • "channel": string - The discord channel ID where the transcript will be sent if "enableChannel" is enabled.
  • "mode": string - Set it to "html" for HTML Transcripts and "text" for text transcripts.

✅ It's recommended to send transcripts to a channel & the creator of the ticket.

Embed Settings​

These are additional settings for the embed which contains the transcript file or url.

"embedSettings"."customColor" string​

Default Value: "#f8ba00" (Open Ticket Yellow)
Allowed Values: A valid hex-color

The color of the embed which contains the transcript file or URL. Leave it empty to use the default color of the bot.

✅ If you don't know how to get a hex-color, you can use the website Color Picker for it.

"embedSettings"."listAllParticipants" boolean​

Default Value: false (Disabled)

When enabled, everyone who sent at least 1 message will be listed in the transcript embed.

✅ This list won't contain any role mentions from admins.

"embedSettings"."includeTicketStats" boolean​

Default Value: false (Disabled)

Enables including ticket statistics (e.g., duration, messages sent) in the transcript embed.

✅ Not all statistics will be shown here. Only the most important ones.

Text Transcript Style​

Configure the style of the text transcripts.

"textTranscriptStyle"."layout" string​

Default Value: "simple"
Allowed Values: "simple", "normal", "detailed"

Determines the level of detail in text transcripts.

  • "simple": Includes the text content and basic message details.
  • "normal": Includes everything from "simple" + embed titles & descriptions + attachments.
  • "detailed": Includes everything from "normal" + full embed details + reactions.

✅ More details might make it more difficult to read.

"textTranscriptStyle"."includeStats" boolean​

Default Value: true (Enabled)

Enables the inclusion of ticket statistics in the text transcript.

✅ This will include all available ticket statistics.

"textTranscriptStyle"."includeIds" boolean​

Default Value: false (Disabled)

Enables including user IDs in the text transcript.

✅ Only enable this when needed. It might make transcripts harder to read.

"textTranscriptStyle"."includeEmbeds" boolean​

Default Value: true (Enabled)

Enables including embeds in the text transcript.

✅ Bots are the only users that can send embeds.

"textTranscriptStyle"."includeFiles" boolean​

Default Value: true (Enabled)

Enables including file attachments in the text transcript.

✅ This will also include a URL to the attachment. (when using "normal" or "detailed" layout)

"textTranscriptStyle"."includeBotMessages" boolean​

Default Value: true (Enabled)

Enables including messages from bots/apps in the text transcript.

✅ Bots might send too much messages which could make the transcript unreadable.

"textTranscriptStyle"."fileMode" string​

Default Value: "custom"
Allowed Values: "custom", "channel-name", "channel-id", "user-name", "user-id"

Determines the naming convention for the transcript file.

  • "custom": Use a custom filename set in "customFileName".
  • "channel-name": Use the channel name as filename.
  • "channel-id": Use the channel id as filename.
  • "user-name": Use the creator username as filename.
  • "user-id": Use the creator id as filename.

✅ All files will end with .txt as extension.

"textTranscriptStyle"."customFileName" string​

Default Value: "" (No custom name)

A custom file name for the transcript file. Only used if "fileMode" is set to "custom".

✅ The custom file name will have .txt as extension.

HTML Transcript Style​

Configure the style of the HTML transcripts.

"htmlTranscriptStyle"."background" object​

Configure a custom background for the HTML Transcripts. When disabled, the default background will be used.

  • "enableCustomBackground": boolean - Enables a custom background for the HTML transcripts.
  • "backgroundColor": string - The background color. (Default: #36393e)
  • "backgroundImage": string - A URL to a background image.

✅ The background image will always overwrite the color.

"htmlTranscriptStyle"."header" object​

Configure a custom header for the HTML Transcripts. When disabled, the default header will be used.

  • "enableCustomHeader": boolean - Enables a custom header for the HTML transcripts.
  • "backgroundColor": string - The background color of the header. (Default: #202225)
  • "decoColor": string - The decoration (horizontal line) color of the header. (Default: #f8ba00)
  • "textColor": string - The text color of the header. (Default: #ffffff)

✅ The header includes the name of the ticket & bot and is always visible.

"htmlTranscriptStyle"."stats" object​

Configure custom stats for the HTML Transcripts. When disabled, the default stats will be used.

  • "enableCustomStats": boolean - Enables custom stats for the HTML transcripts.
  • "backgroundColor": string - The background color of the stats. (Default: #202225)
  • "keyTextColor": string - The text color of the stats labels. (Default: #737373)
  • "valueTextColor": string - The text color of the stats values. (Default: #ffffff)
  • "hideBackgroundColor": string - The background color of the stats hide button. (Default: #40444a)
  • "hideTextColor": string - The text color of the stats hide button. (Default: #ffffff)

✅ The stats are visible on the right-side of the screen and can be hidden.

"htmlTranscriptStyle"."favicon" object​

Configure a custom favicon for the HTML Transcripts. When disabled, the default favicon will be used.

  • "enableCustomFavicon": boolean - Enables custom stats for the HTML transcripts.
  • "imageUrl": string - The URL for the favicon image.

✅ Using a small image (32x32) is recommended for better load time.

Example File

All variables above have been made acording to this config for Open Ticket v4.0.0. This configuration might change in future versions!

transcripts.json
{
    "general":{
        "enabled":false,

        "enableChannel":false,
        "enableCreatorDM":false,
        "enableParticipantDM":false,
        "enableActiveAdminDM":false,
        "enableEveryAdminDM":false,

        "channel":"transcript channel id (or leave empty)",
        "mode":"html OR text"
    },
    "embedSettings":{
        "customColor":"#f8ab00 (or leave empty)",
        "listAllParticipants":false,
        "includeTicketStats":false
    },
    "textTranscriptStyle":{
        "layout":"simple OR normal OR detailed",
        "includeStats":true,
        "includeIds":false,
        "includeEmbeds":true,
        "includeFiles":true,
        "includeBotMessages":true,

        "fileMode":"custom OR channel-name OR channel-id OR user-name OR user-id",
        "customFileName":"this-is-a-transcript (or leave empty)"
    },
    "htmlTranscriptStyle":{
        "background":{
            "enableCustomBackground":false,
            "backgroundColor":"#f8ba00 (or leave empty)",
            "backgroundImage":"https://www.example.com/image.png (or leave empty)"
        },
        "header":{
            "enableCustomHeader":false,
            "backgroundColor":"#202225",
            "decoColor":"#f8ba00",
            "textColor":"#ffffff"
        },
        "stats":{
            "enableCustomStats":false,
            "backgroundColor":"#202225",
            "keyTextColor":"#737373",
            "valueTextColor":"#ffffff",
            "hideBackgroundColor":"#40444a",
            "hideTextColor":"#ffffff"
        },
        "favicon":{
            "enableCustomFavicon":false,
            "imageUrl":"https://transcripts.dj-dj.be/favicon.png"
        }
    }
}