A full reference of the variables you can use when writing custom DM Notices.
When configuring custom DM Notices, you can use a select group of variables to inject dynamic data into the text. This allows you to format the message to your liking. For example, instead of typing a generic “You were promoted,” you can use {target.mention} to automatically ping the target.Below is the complete list of available variables, categorised by what they represent.
Target Variables
These variables pull information about the user who is receiving the staff action (the person being hired, fired, promoted, or demoted).
Variable
Description
Example Output
{target.mention}
Mentions the target user directly.
<@1051468172693360670>
{target.displayName}
The target’s display name.
Joy ^•^
{target.username}
The target’s Discord username.
snozlight
{target.id}
The target’s unique Discord User ID.
1051468172693360670
{target.avatar}
A direct URL to the target’s profile picture.
https://cdn.discordapp.com/...
Executor Variables
These variables pull information about the user who actually ran the /staff command.
Variable
Description
Example Output
{executor.mention}
Mentions the manager.
<@728846598330646662>
{executor.displayName}
The manager’s display name.
Frozen
{executor.username}
The manager’s Discord username.
frozen4917
{executor.id}
The manager’s unique Discord User ID.
728846598330646662
{executor.avatar}
A direct URL to the manager’s profile picture.
https://cdn.discordapp.com/...
Server Variables
Information regarding the Discord server where the action took place.
Variable
Description
Example Output
{server.name}
The exact name of your Discord server.
Nocturne Support
{server.id}
Your server’s unique Guild ID.
1470773005587190029
{server.icon}
A direct URL to your server’s icon image.
https://cdn.discordapp.com/...
Context & Action Variables
These variables represent the specific details of the staff action being executed, such as the roles involved and the reasons provided.
Variable
Description
Example Output
{action}
The action executed (always past tense and lowercase).
hired / fired / promoted / demoted
{tree.name}
The name of the hierarchy tree the action occurred in.
Moderation
{role.name}
The name of the new base role acquired (or stripped away if fired).
Moderator
{oldRole.name}
The name of the previous base role. Note: ReturnsNonefor Hire, and is identical to{role.name}for Fire.
Trainee Mod
{reason}
The text provided in the reason field of the command.
Breaking staff reporting policy!
{notes}
The text provided in the optional notes field.
Remember to check the guidebook.
All variables are case-sensitive, i.e. {target.ID} and {oldrole.name} will not work, but {target.id} and {oldRole.name} will.
Real-World Example
Not sure how to put this together? Here is an example of what a message might look like when it is configured and how it will be seen by the user.
Configured Example
Visual Output
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Nocturne","description":"Nocturne is a specialised Discord bot that acts as your server’s automated Human Resources system. Instead of manually giving users five different roles when they become a Moderator, Nocturne allows your management team to simply run /staff hire, and the bot handles all the underlying role math, cleanups, DMing the user, and logging automatically.","colors":{"primary":"#3B488C","light":"#6C78B5","dark":"#1F2550"},"logo":"https://mintcdn.com/nocturneidle/2-3YwYR-s24LwC-D/images/Nocturne2-EL.png?fit=max\u0026auto=format\u0026n=2-3YwYR-s24LwC-D\u0026q=85\u0026s=d57fcb6ad55d5016fb71305da7038dbf","favicon":{"light":"https://mintcdn.com/nocturneidle/2-3YwYR-s24LwC-D/images/Nocturne2-EL.png?fit=max\u0026auto=format\u0026n=2-3YwYR-s24LwC-D\u0026q=85\u0026s=d57fcb6ad55d5016fb71305da7038dbf","dark":"https://mintcdn.com/nocturneidle/2-3YwYR-s24LwC-D/images/Nocturne2-EL.png?fit=max\u0026auto=format\u0026n=2-3YwYR-s24LwC-D\u0026q=85\u0026s=d57fcb6ad55d5016fb71305da7038dbf"},"appearance":{"default":"dark","strict":false},"background":{"decoration":"gradient"},"navbar":{"links":[],"primary":{"type":"button","label":"Invite Nocturne","href":"https://discord.com/oauth2/authorize?client_id=1473533466673938617\u0026permissions=275683527680\u0026integration_type=0\u0026scope=bot+applications.commands"}},"footer":{"socials":{"discord":"https://discord.com/invite/ZWdVcXhpn4"}},"integrations":{"ga4":{"measurementId":"G-JZTTXYZCQG"}},"thumbnails":{"appearance":"dark"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nocturneidle","hasAudioNarration":false,"actualSubdomain":"nocturneidle","customDomains":[],"gitSource":{"type":"github","owner":"nocturne-idle","repo":"nocturne-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6acefc5aed3f1b53161e8a33","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Nocturne RW v2.0.0-B1","count":20},{"language":"default","tag":"Commands","count":11},{"language":"default","tag":"Configuration","count":6},{"language":"default","tag":"Tree","count":3},{"language":"default","tag":"Guide","count":3},{"language":"default","tag":"Home","count":3},{"language":"default","tag":"Legal","count":2},{"language":"default","tag":"Resources","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"guide/variables-guide","slug":"/guide/variables-guide","pageMetadata":{"title":"Variables Guide","description":"A full reference of the variables you can use when writing custom DM Notices.","href":"/guide/variables-guide"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"A full reference of the variables you can use when writing custom DM Notices.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,em:`em`,hr:`hr`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Column,Columns,Heading,OptimizedImage,Tab,Table,Tabs,Warning}=_components;if(!Column)_missingMdxReference(`Column`,true);if(!Columns)_missingMdxReference(`Columns`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Tab)_missingMdxReference(`Tab`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tabs)_missingMdxReference(`Tabs`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`When configuring custom DM Notices, you can use a select group of variables to inject dynamic data into the text. This allows you to format the message to your liking. For example, instead of typing a generic “You were promoted,” you can use `,_jsx(_components.code,{children:`{target.mention}`}),` to automatically ping the target.`]}),`\n`,_jsx(_components.p,{children:`Below is the complete list of available variables, categorised by what they represent.`}),`\n`,_jsx(Heading,{level:`2`,id:`target`,children:`Target Variables`}),`\n`,_jsx(_components.p,{children:`These variables pull information about the user who is receiving the staff action (the person being hired, fired, promoted, or demoted).`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Variable`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Description`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Example Output`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{target.mention}`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`Mentions the target user directly.`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:_jsx(_components.code,{children:`\u003c@1051468172693360670>`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{target.displayName}`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`The target’s display name.`}),_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`Joy ^•^`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{target.username}`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`The target’s Discord username.`}),_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`snozlight`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{target.id}`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`The target’s unique Discord User ID.`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:_jsx(_components.code,{children:`1051468172693360670`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{target.avatar}`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`A direct URL to the target’s profile picture.`}),_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`https://cdn.discordapp.com/...`})})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`executor`,children:`Executor Variables`}),`\n`,_jsxs(_components.p,{children:[`These variables pull information about the user who actually ran the `,_jsx(_components.code,{children:`/staff`}),` command.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Variable`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Description`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Example Output`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{executor.mention}`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`Mentions the manager.`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:_jsx(_components.code,{children:`\u003c@728846598330646662>`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{executor.displayName}`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`The manager’s display name.`}),_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`Frozen`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{executor.username}`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`The manager’s Discord username.`}),_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`frozen4917`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{executor.id}`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`The manager’s unique Discord User ID.`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:_jsx(_components.code,{children:`728846598330646662`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{executor.avatar}`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`A direct URL to the manager’s profile picture.`}),_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`https://cdn.discordapp.com/...`})})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`server`,children:`Server Variables`}),`\n`,_jsx(_components.p,{children:`Information regarding the Discord server where the action took place.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Variable`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Description`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Example Output`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{server.name}`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`The exact name of your Discord server.`}),_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`Nocturne Support`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{server.id}`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`Your server’s unique Guild ID.`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:_jsx(_components.code,{children:`1470773005587190029`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{server.icon}`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`A direct URL to your server’s icon image.`}),_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`https://cdn.discordapp.com/...`})})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`context`,children:`Context \u0026 Action Variables`}),`\n`,_jsx(_components.p,{children:`These variables represent the specific details of the staff action being executed, such as the roles involved and the reasons provided.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Variable`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Description`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Example Output`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{action}`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`The action executed (always past tense and lowercase).`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[_jsx(_components.code,{children:`hired`}),` / `,_jsx(_components.code,{children:`fired`}),` / `,_jsx(_components.code,{children:`promoted`}),` / `,_jsx(_components.code,{children:`demoted`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{tree.name}`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`The name of the hierarchy tree the action occurred in.`}),_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`Moderation`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{role.name}`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`The name of the new base role acquired (or stripped away if fired).`}),_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`Moderator`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{oldRole.name}`})}),_jsxs(_components.td,{style:{textAlign:`left`},children:[`The name of the previous base role. `,_jsx(_components.em,{children:`Note: Returns`}),_jsx(_components.code,{children:`None`}),_jsx(_components.em,{children:`for Hire, and is identical to`}),_jsx(_components.code,{children:`{role.name}`}),_jsx(_components.em,{children:`for Fire.`})]}),_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`Trainee Mod`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{reason}`})}),_jsxs(_components.td,{style:{textAlign:`left`},children:[`The text provided in the `,_jsx(_components.code,{children:`reason`}),` field of the command.`]}),_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`Breaking staff reporting policy!`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`{notes}`})}),_jsxs(_components.td,{style:{textAlign:`left`},children:[`The text provided in the optional `,_jsx(_components.code,{children:`notes`}),` field.`]}),_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`Remember to check the guidebook.`})})]})]})]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`All variables are case-sensitive, i.e. `,_jsx(_components.code,{children:`{target.ID}`}),` and `,_jsx(_components.code,{children:`{oldrole.name}`}),` will not work, but `,_jsx(_components.code,{children:`{target.id}`}),` and `,_jsx(_components.code,{children:`{oldRole.name}`}),` will.`]})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`example`,children:`Real-World Example`}),`\n`,_jsx(_components.p,{children:`Not sure how to put this together? Here is an example of what a message might look like when it is configured and how it will be seen by the user.`}),`\n`,_jsxs(Tabs,{children:[_jsx(Tab,{title:`Configured Example`,icon:`code-simple`,id:`configured-example`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/nocturneidle/rKKUixGtrUsPbPeX/images/DMs-Notice-Modal.png?fit=max\u0026auto=format\u0026n=rKKUixGtrUsPbPeX\u0026q=85\u0026s=9974291e1c2864376e7ad2403e66f7e3`,alt:`DM Notice Configured Example`,title:`DM Notice Configured Example`,className:`mint-mx-auto`,style:{width:`42%`},\"data-og-width\":`525`,width:`525`,\"data-og-height\":`638`,height:`638`,\"data-path\":`images/DMs-Notice-Modal.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/nocturneidle/rKKUixGtrUsPbPeX/images/DMs-Notice-Modal.png?w=280\u0026fit=max\u0026auto=format\u0026n=rKKUixGtrUsPbPeX\u0026q=85\u0026s=9e91e4bc68d17cdd5ad236027b7c80a4 280w, https://mintcdn.com/nocturneidle/rKKUixGtrUsPbPeX/images/DMs-Notice-Modal.png?w=560\u0026fit=max\u0026auto=format\u0026n=rKKUixGtrUsPbPeX\u0026q=85\u0026s=ea74a7dea717189a4df9495050471f71 560w, https://mintcdn.com/nocturneidle/rKKUixGtrUsPbPeX/images/DMs-Notice-Modal.png?w=840\u0026fit=max\u0026auto=format\u0026n=rKKUixGtrUsPbPeX\u0026q=85\u0026s=a20cf4207f27cad9144ff96bcc97ab2d 840w, https://mintcdn.com/nocturneidle/rKKUixGtrUsPbPeX/images/DMs-Notice-Modal.png?w=1100\u0026fit=max\u0026auto=format\u0026n=rKKUixGtrUsPbPeX\u0026q=85\u0026s=a45256b69e29bd337c6be2394bd6d01a 1100w, https://mintcdn.com/nocturneidle/rKKUixGtrUsPbPeX/images/DMs-Notice-Modal.png?w=1650\u0026fit=max\u0026auto=format\u0026n=rKKUixGtrUsPbPeX\u0026q=85\u0026s=0701bf5fc54a38fdc155c1a8a4e31c36 1650w, https://mintcdn.com/nocturneidle/rKKUixGtrUsPbPeX/images/DMs-Notice-Modal.png?w=2500\u0026fit=max\u0026auto=format\u0026n=rKKUixGtrUsPbPeX\u0026q=85\u0026s=d5ce32a4bfd922371df1a1a0ad03f0b0 2500w`})}),_jsx(Tab,{title:`Visual Output`,icon:`image`,id:`visual-output`,children:_jsxs(Columns,{cols:2,children:[_jsx(Column,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/nocturneidle/HGP1XeHwOgeZO9_d/images/Staff-Hire.png?fit=max\u0026auto=format\u0026n=HGP1XeHwOgeZO9_d\u0026q=85\u0026s=89685da80a91982151c7b1d5ad232a37`,alt:`Staff Hire Command Output`,title:`Staff Hire Command Output`,className:`mint-mx-auto`,style:{width:`91%`},\"data-og-width\":`500`,width:`500`,\"data-og-height\":`273`,height:`273`,\"data-path\":`images/Staff-Hire.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/nocturneidle/HGP1XeHwOgeZO9_d/images/Staff-Hire.png?w=280\u0026fit=max\u0026auto=format\u0026n=HGP1XeHwOgeZO9_d\u0026q=85\u0026s=799a9521b93c4f4b0b03f9c87798774c 280w, https://mintcdn.com/nocturneidle/HGP1XeHwOgeZO9_d/images/Staff-Hire.png?w=560\u0026fit=max\u0026auto=format\u0026n=HGP1XeHwOgeZO9_d\u0026q=85\u0026s=2473c9d9c28cc5cbdbccbaeb029454d0 560w, https://mintcdn.com/nocturneidle/HGP1XeHwOgeZO9_d/images/Staff-Hire.png?w=840\u0026fit=max\u0026auto=format\u0026n=HGP1XeHwOgeZO9_d\u0026q=85\u0026s=b676ad764daba080dd2803507335d82b 840w, https://mintcdn.com/nocturneidle/HGP1XeHwOgeZO9_d/images/Staff-Hire.png?w=1100\u0026fit=max\u0026auto=format\u0026n=HGP1XeHwOgeZO9_d\u0026q=85\u0026s=ffc1a25a3a2930ca0d9e88a0bee27360 1100w, https://mintcdn.com/nocturneidle/HGP1XeHwOgeZO9_d/images/Staff-Hire.png?w=1650\u0026fit=max\u0026auto=format\u0026n=HGP1XeHwOgeZO9_d\u0026q=85\u0026s=01f7b6fbb0785b55db154af34080d2f2 1650w, https://mintcdn.com/nocturneidle/HGP1XeHwOgeZO9_d/images/Staff-Hire.png?w=2500\u0026fit=max\u0026auto=format\u0026n=HGP1XeHwOgeZO9_d\u0026q=85\u0026s=7c395f61b2fe90975b3905f48c0995df 2500w`})}),_jsx(Column,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/nocturneidle/HGP1XeHwOgeZO9_d/images/Staff-Hire-DM-Message.png?fit=max\u0026auto=format\u0026n=HGP1XeHwOgeZO9_d\u0026q=85\u0026s=b102447f88f1a394977065bea4114ed2`,alt:`DM Message from Hire command`,title:`DM Message from Hire command`,className:`mint-mx-auto`,style:{width:`98%`},\"data-og-width\":`798`,width:`798`,\"data-og-height\":`397`,height:`397`,\"data-path\":`images/Staff-Hire-DM-Message.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/nocturneidle/HGP1XeHwOgeZO9_d/images/Staff-Hire-DM-Message.png?w=280\u0026fit=max\u0026auto=format\u0026n=HGP1XeHwOgeZO9_d\u0026q=85\u0026s=1c2d8be383a5ee99e02af9a4a1450a3f 280w, https://mintcdn.com/nocturneidle/HGP1XeHwOgeZO9_d/images/Staff-Hire-DM-Message.png?w=560\u0026fit=max\u0026auto=format\u0026n=HGP1XeHwOgeZO9_d\u0026q=85\u0026s=6ba0543ce68d9a42d0c3db0f9358e3c5 560w, https://mintcdn.com/nocturneidle/HGP1XeHwOgeZO9_d/images/Staff-Hire-DM-Message.png?w=840\u0026fit=max\u0026auto=format\u0026n=HGP1XeHwOgeZO9_d\u0026q=85\u0026s=37865bfd2bb5e23bde544705f285f0b6 840w, https://mintcdn.com/nocturneidle/HGP1XeHwOgeZO9_d/images/Staff-Hire-DM-Message.png?w=1100\u0026fit=max\u0026auto=format\u0026n=HGP1XeHwOgeZO9_d\u0026q=85\u0026s=7c2b56c2367e39e72c48547e503f5158 1100w, https://mintcdn.com/nocturneidle/HGP1XeHwOgeZO9_d/images/Staff-Hire-DM-Message.png?w=1650\u0026fit=max\u0026auto=format\u0026n=HGP1XeHwOgeZO9_d\u0026q=85\u0026s=d64b2062fa76c1fb2aa6d42ab8489cea 1650w, https://mintcdn.com/nocturneidle/HGP1XeHwOgeZO9_d/images/Staff-Hire-DM-Message.png?w=2500\u0026fit=max\u0026auto=format\u0026n=HGP1XeHwOgeZO9_d\u0026q=85\u0026s=09a259494e558dd0c5a52b3e50980298 2500w`})})]})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Variables Guide","description":"A full reference of the variables you can use when writing custom DM Notices.","href":"/guide/variables-guide"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Target Variables","slug":"target","depth":2,"children":[]},{"title":"Executor Variables","slug":"executor","depth":2,"children":[]},{"title":"Server Variables","slug":"server","depth":2,"children":[]},{"title":"Context \u0026 Action Variables","slug":"context","depth":2,"children":[]},{"title":"Real-World Example","slug":"example","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"dynamicCss":".mint-mx-auto {\n margin-left: auto;\n margin-right: auto\n}","subdomain":"nocturneidle","siteName":"Nocturne","title":"Variables Guide - Nocturne","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-28T16:14:42.388Z","originalFileLocation":"guide/variables-guide.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"A full reference of the variables you can use when writing custom DM Notices.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Nocturne\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nocturneidle/cSylThs5lfIgkzAY/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/nocturneidle/cSylThs5lfIgkzAY/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nocturneidle/cSylThs5lfIgkzAY/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/nocturneidle/cSylThs5lfIgkzAY/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/nocturneidle/cSylThs5lfIgkzAY/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nocturneidle/cSylThs5lfIgkzAY/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nocturneidle/cSylThs5lfIgkzAY/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/nocturneidle/cSylThs5lfIgkzAY/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/nocturneidle/cSylThs5lfIgkzAY/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Variables Guide - Nocturne\">\u003cmeta data-mint-head property=\"og:description\" content=\"A full reference of the variables you can use when writing custom DM Notices.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Nocturne\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://nocturneidle.mintlify.app/guide/variables-guide\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nocturneidle.mintlify.site/_mintlify/api/og/v2?division=Guide\u0026amp;title=Variables+Guide\u0026amp;description=A+full+reference+of+the+variables+you+can+use+when+writing+custom+DM+Notices.\u0026amp;theme=d8c814fa0887e96463151325\u0026amp;signature=fe6e3bdf56c5e1830b262cf62457b33ed39736e28a4380a7b634f686830e1bd6\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Variables Guide - Nocturne\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"A full reference of the variables you can use when writing custom DM Notices.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nocturneidle.mintlify.site/_mintlify/api/og/v2?division=Guide\u0026amp;title=Variables+Guide\u0026amp;description=A+full+reference+of+the+variables+you+can+use+when+writing+custom+DM+Notices.\u0026amp;theme=d8c814fa0887e96463151325\u0026amp;signature=fe6e3bdf56c5e1830b262cf62457b33ed39736e28a4380a7b634f686830e1bd6\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/nocturneidle/cSylThs5lfIgkzAY/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Nocturne\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3B488C\">\u003clink data-mint-head rel=\"canonical\" href=\"https://nocturneidle.mintlify.app/guide/variables-guide\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/guide/variables-guide.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://nocturneidle.mintlify.app/#organization\",\"name\":\"Nocturne\",\"url\":\"https://nocturneidle.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nocturneidle/2-3YwYR-s24LwC-D/images/Nocturne2-EL.png?fit=max\u0026auto=format\u0026n=2-3YwYR-s24LwC-D\u0026q=85\u0026s=d57fcb6ad55d5016fb71305da7038dbf\"}},{\"@type\":\"WebSite\",\"@id\":\"https://nocturneidle.mintlify.app#website\",\"name\":\"Nocturne\",\"url\":\"https://nocturneidle.mintlify.app\",\"publisher\":{\"@id\":\"https://nocturneidle.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://nocturneidle.mintlify.app/guide/variables-guide#webpage\",\"url\":\"https://nocturneidle.mintlify.app/guide/variables-guide\",\"name\":\"Variables Guide\",\"description\":\"A full reference of the variables you can use when writing custom DM Notices.\",\"dateModified\":\"2026-06-28T16:14:42.388Z\",\"isPartOf\":{\"@id\":\"https://nocturneidle.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://nocturneidle.mintlify.app/guide/variables-guide#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://nocturneidle.mintlify.app/guide/variables-guide#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Guide\",\"item\":\"https://nocturneidle.mintlify.app/guide/before-you-start\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Variables Guide\",\"item\":\"https://nocturneidle.mintlify.app/guide/variables-guide\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://nocturneidle.mintlify.app/guide/variables-guide#article\",\"headline\":\"Variables Guide\",\"name\":\"Variables Guide\",\"description\":\"A full reference of the variables you can use when writing custom DM Notices.\",\"url\":\"https://nocturneidle.mintlify.app/guide/variables-guide\",\"mainEntityOfPage\":{\"@id\":\"https://nocturneidle.mintlify.app/guide/variables-guide#webpage\"},\"dateModified\":\"2026-06-28T16:14:42.388Z\",\"publisher\":{\"@id\":\"https://nocturneidle.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://nocturneidle.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Nocturne\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Nocturne\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/guide/variables-guide.md","siteName":"Nocturne","nav":{"global":null,"tabs":[{"tab":"Nocturne RW v2.0.0-B1","pages":[{"group":"Home","pages":[{"title":"Nocturne Documentation","href":""},{"title":"Support Server","url":"https://discord.gg/ZWdVcXhpn4","icon":"book-open","href":"/support"},{"title":"Top.gg Page","icon":"chart-line-up","url":"https://top.gg/bot/1473533466673938617","href":"/topgg"}]},{"group":"Resources","pages":[{"title":"Why Nocturne?","href":"/resources/why-nocturne"}]},{"group":"Guide","pages":[{"title":"Before You Start","href":"/guide/before-you-start"},{"title":"Quick Setup Guide","description":"A step-by-step checklist to build your first tree and get Nocturne running in under 10 minutes.","href":"/guide/quick-start"},{"title":"Variables Guide","href":"/guide/variables-guide"}]},{"group":"Commands","pages":[{"group":"Tree","pages":[{"title":"Tree Basics","description":"A Tree in Nocturne is a container for a specific staff hierarchy. Each tree acts like a ladder/promotional pathway and is used to keep departments separate (e.g., Moderation, Events).","href":"/commands/tree/basics"},{"title":"Base Roles","href":"/commands/tree/base-roles"},{"title":"Linked Roles","href":"/commands/tree/linked-roles"}]},{"group":"Configuration","pages":[{"title":"Config Overview \u0026 Flags","href":"/commands/config/overview"},{"title":"Umbrella Role","href":"/commands/config/umbrella-role"},{"title":"Log Channel","href":"/commands/config/log-channel"},{"title":"Whitelist Roles","href":"/commands/config/whitelist-roles"},{"title":"Predefined Reasons","href":"/commands/config/reasons"},{"title":"DM Notices","href":"/commands/config/dm-notices"}]},{"title":"Staff Actions","href":"/commands/staff-actions"},{"title":"System Fix","href":"/commands/system-fix"}]},{"group":"Legal","pages":[{"title":"Terms of Service","href":"/legal/tos"},{"title":"Privacy Policy","href":"/legal/privacy"}]}]}]},"basePath":"","title":"Variables Guide - Nocturne","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["a74be98ba7"],"chunks":["zoom-image-lightbox-BbK2OBGL.js","lightbox-handle-r17bVUz3.js"]}