Birthdays

Celebrate your members' birthdays with a post, wishes, a role for the day and more. Free for every bot.

Birthdays lets members add their birthday, then celebrates them on the day. At the hour you pick, your bot posts a birthday message with a Send a wish button, gives them a birthday role for the day and takes it off again when the day ends, even after a restart. You can add a birthday card, reactions, a wishes thread, an Upcoming list, join anniversaries and your server's own special days. Birthdays is free for every bot.

The Discord birthday bot page gives a shorter tour of what Birthdays can do.

The birthday post for Fabian in #birthdays with the birthday card, the party popper reaction and the Send a wish button

What your members will see

Before you start

You need:

  • Your bot in your Discord server. See Invite Your Bot if it isn't yet.
  • A channel for the birthday posts, like #birthdays. In it, your bot needs View Channel, Send Messages, Embed Links, Add Reactions and Create Public Threads.
  • A birthday role, like Birthday, if you want one. Your bot's own role must be above it, with Manage Roles turned on.
  • A channel for the ask panel, where members press Add my birthday. It can be the same channel.

Some settings need more permissions:

Setting Your bot needs
Birthday role, month role, star sign roles Manage Roles, with its role above those roles
Pin the post for the day Manage Messages
Cake on their name Manage Nicknames
Join anniversaries for members already there The Server Members intent, in the Discord Developer Portal

Set up Birthdays

  1. 1

    Turn on Birthdays

    Open Birthdays in your bot's dashboard and press Enable at the top right.

    The top of the Birthdays page with Enabled, the server menu, Reset to Default and Docs marked
    • A Enable turns Birthdays on. It adds the /birthday commands, the View birthday right click command, the events Birthdays needs, an hourly timed event, and the custom variables it keeps its settings in.
    • B The server you're setting up. Every Birthdays setting belongs to one server (its channels, its roles and its time), so pick the server first. The page shows the server's icon and name on the settings you're changing.
    • C Reset to Default puts every setting in that server back to how a new Birthdays starts. The channels and roles stay.
    • D Docs opens this page.

    Still using the old Birthdays module? The page offers to move your birthdays and settings across. See Moving from the old Birthdays.

  2. 2

    Pick the birthday channel and role

    On the Celebrate tab, pick the channel in Where birthdays are posted and the role in Birthday role. If you don't want a role, press Skip beside Pick a birthday role at the top of the page.

  3. 3

    Save

    A bar pops up at the bottom of the page. Press Save Changes. Your bot restarts to pick up the changes, which takes about 20 seconds.

    The Unsaved changes bar with Save Changes marked
  4. 4

    Post the ask panel

    On the Ask members tab, pick the panel channel and press Post the panel. Or run /birthday panel in your server.

    The setup strip with what to do next, the Setup guide link and the steps marked
    • A What to do next. Once everything is done, it says Birthdays is ready.
    • B The steps, ticked off as you do them. Press one to go to it.

    To try it out, add your own birthday with /birthday set and set it to today: it's celebrated within the hour.

The tabs

Everything else is on six tabs. The preview on the right shows what members see in Discord for the tab you're on.

The tabs: Celebrate, Ask members, Wishes, Upcoming, Special days and Birthdays
  • Celebrate: the channel, the time, the birthday post, the role and the extras on their day.
  • Ask members: the ask panel, who can add a birthday, the birth year, changes, star sign roles and staff.
  • Wishes: the Wish button, how wishes show and the birthday book.
  • Upcoming: the Upcoming list, the monthly post and the heads-ups before a birthday.
  • Special days: join anniversaries and your server's own days.
  • Birthdays: every birthday in the server, importing and downloading them, and what is kept.

Celebrate

Where birthdays are posted

  • Birthday channel: where the birthday post goes. The bot needs to see it, send messages, add reactions and make threads there.

What time

What time, with Post at, the time zone, Celebrate each member in their own time zone and the 29 February choice
  • Post at: the hour the post goes out on their birthday (some time in that hour, not always at the start). It starts at 9:00.
  • Time zone: the server's time zone, like Europe/London. It starts on UTC. Summer time is handled for you.
  • Celebrate each member in their own time zone: off to start with. While it's on, members pick their time zone with /birthday timezone and are celebrated at your hour in their zone. Members who don't pick one use the server's.
  • 29 February birthdays, in other years: celebrated on 28 February (to start with) or 1 March.

Who gets celebrated

  • Only members with these roles: leave it empty to celebrate everyone who added a birthday.
  • Not if it was added fewer than a number of days before, from 0 to 60. It stops people changing their birthday to today to get the role. It starts at 0, which celebrates a birthday whenever it was added.

The birthday post

When it's someone's birthday, with the message, Edit message, the variables and Add a version

The When it's someone's birthday card is the post. Each message card has the message, Edit message to open the Message Builder, and the variables it fills in. The bot adds the Send a wish button under the post itself.

  • Add a version: up to 10 versions of the message. One is picked at random each time. Stop using this version takes the last one away.
  • When several people have a birthday the same day: one post for everyone celebrated in the same hour, with one Wish button that asks who the wish is for. A post names up to 40 members; the rest are counted.

A different message for some roles

  • Use a different message for these roles: off to start with. Members with one of the Roles get the When it's the birthday of someone with these roles message instead of the usual one, like staff, boosters or VIPs.

Who to ping

  • Ping: Them (to start with), A role, @here or Nobody. With A role, pick the Role to ping.

Birthday role

Birthday role and Birthday month role, with Give a role, the role, Keep it and the month role
  • Give a role: on to start with. Pick the Role. The bot can only give roles below its own.
  • Keep it: For the rest of their day (to start with) or For 24 hours. It comes off by itself, even after your bot restarts.

Birthday month role

  • Give a role for the whole month: off to start with. Everyone whose birthday is this month gets the Role on the 1st, and it's taken off when the month ends.

Reactions

  • Reactions: the bot reacts to the birthday post with these emojis. Leave it empty for none.

Pin and thread

  • Pin the post for the day: off to start with. It's unpinned when their day ends. Needs Manage Messages.
  • Wishes thread: off to start with. A thread under the post for messages, locked when the day ends. Thread name starts as Wishes for {bday_name}, up to 100 characters.

Also send them a DM

  • Send a DM: off to start with. Sends When it's their birthday (DM) as well as the post. If their DMs are closed, nothing else happens.

Cake on their name

  • Add it: off to start with. Adds the Emoji (a cake to start with) to their nickname for the day. Their name goes back when the day ends. Needs Manage Nicknames. A bot can't change the server owner's name.

A reward

  • Give a reward: off to start with. Adds an amount to one of your member number custom variables, like coins, once on their birthday. Pick the Custom variable and how much to Add, from 1 to 1,000,000. It starts at 100. Make the variable in Data Storage first if your bot has none.

Birthday card

Birthday card switched on, with the birthday card, the group card, Edit the card and Back to the default
  • Add a card: off to start with. A picture made for them at the top of the post, free in this module.
  • The birthday card: on the post for one member. Edit the card opens the Card Studio.
  • The group card: on the post when several people share a day, with everyone's picture in a row. Edit the group card opens the Card Studio.
  • Back to the default puts the default design back.

Ask members

The ask panel

When the ask panel is posted, with the panel channel, the message and Post the panel

The panel is where members press Add my birthday. It also has Upcoming and Remove mine buttons, and its buttons keep working for a year.

  • Panel channel: where it's posted. The bot needs to see it, send messages and embed links there.
  • Post the panel: posts it in the channel. Once it's there, the button says Post it again: after you change the panel, press it to update the panel where it is.

Save before you post: posting uses your saved settings. Right after a save, the button waits for your bot to restart.

Add my birthday opens a form with the Month, the Day, the Year (only while the server asks for it), How should we celebrate? (In the channel, Just the role or Not at all) and their time zone (only while members can pick their own).

Who can add a birthday

  • Roles: members with one of these roles can add theirs. Leave it empty so everyone can.

Birth year

  • Birth year: Don't ask (to start with), or Ask, only kept to show their age. When asked, it's optional and only kept when they choose to show their age. Ages under 18 are never shown, and a year that makes someone under 13 isn't kept.

Changes

  • Members can change it a number of times a year, from 1 to 10. It starts at 3. Adding it the first time doesn't count.
  • Members can't change it once it's set: off to start with. Staff can still change it with /birthday add-for.

Star sign roles

  • Give star sign roles: off to start with. Pick a role for each of the 12 signs, shown with their dates. Members get theirs when they save their birthday. A sign with no role gets nothing.

Staff

Staff, with the staff roles, Staff can add birthdays, Tell the member and Members confirm birthdays staff add
  • Staff roles: members with one of these roles can use the staff commands. Members with Manage Server always can.
  • Staff can add birthdays: on to start with, with /birthday add-for.
    • Tell the member: on to start with. They get a DM saying a moderator added it.
    • Members confirm birthdays staff add: off to start with. A birthday staff add is only celebrated once the member says it's right under /birthday mine. It's forgotten after 14 days without a yes.

Wishes

Wish button

The Wishes tab, with Add a Wish button, the button text, the emoji and the wish settings
  • Add a Wish button: on to start with. It goes under the birthday post. Members press it and type a short wish, up to 200 characters, once each. Nobody can send themselves a wish.
  • Button text: starts as Send a wish, with an Emoji if you like.

The button keeps working for a year. Once the birthday is over, pressing it says so.

Wishes on the post

  • Show how many wishes: off to start with. The post says how many wishes so far and keeps it up to date.
  • Let wishes have a picture: off to start with. The picture goes in the birthday book with the wish.
  • Early wishes: off to start with. Members can use /birthday wish up to 30 days before. They're opened on the day.

The birthday book

  • Send the birthday book: off to start with. When their birthday ends, they get every wish in one DM. If their DMs are closed, nothing else happens. The wishes are deleted once the day ends.

Upcoming

Upcoming list

Upcoming list, with Keep an upcoming list, the channel, how many to show and Post the list
  • Keep an upcoming list: off to start with. A message the bot keeps up to date at midnight every day, where it was posted.
  • Channel: where it goes. Leave it empty to use the birthday channel. The monthly post goes here too.
  • Show a number of birthdays, up to 25. It starts at 10. /birthday upcoming shows the same number.
  • Post the list: posts it in the channel, with an Add my birthday button. Post it again updates it where it is.

The Birthdays today message is the private reply to /birthday today.

Monthly post

  • Post each month: off to start with. A post with that month's birthdays, in the Upcoming list's channel. On day 1 to 28 of the month (it starts on the 1st), At an hour.

Heads-up before a birthday

Heads-up before a birthday, with the three days, Send it, the staff channel, the hour and the planning thread
  • Send a heads-up: off to start with. Up to 3, each its own number of days before, up to 30. They start at 7 and 1 days before, and the third at 0, which is off.
  • Send it: To staff (to start with) or To everyone.
  • Staff channel (or Channel when it goes to everyone): a channel the birthday member can't see keeps it a surprise. With To everyone, leave it empty to use the birthday channel.
  • At: the hour it's sent.
  • Open a planning thread: off to start with. A thread on the heads-up named Birthday plans and the date. Use a staff channel to keep it from the birthday member.

Anniversaries and special days

These are on the Special days tab.

Where anniversaries and special days go

  • Channel: one channel for both. Leave it empty to use the birthday channel.
  • Post at: one hour for both, in the server's time zone.

Join anniversaries

Join anniversaries, with the switch, the milestone roles and Fill in join dates
  • Celebrate join anniversaries: off to start with. A post each year on the day a member joined. Everyone who joined on the same day goes in one post.
  • Milestone roles: Add a milestone for up to 5 roles, each given on their join anniversary once they've been here a number of years, from 1 to 50.
  • Fill in join dates: new members are noted when they join. Run this once for members who joined before anniversaries were on. It needs the Server Members intent (Discord Developer Portal, your bot, Bot), and a big server takes a while: about half a minute for every 1,000 members.

Special days

Special days, with a day's name, its day and month, Edit message and Add a day

Your server's own days, like its birthday, a founder's birthday or an event. Each is posted every year with its own message.

  • Add a day: up to 25 days. Give each a name (the message shows it as {special_name}), a day and a month.
  • Edit message: the day's own message.
  • When you have no days yet, the page offers to add your server's own birthday, from the day it was made.

Staff can also add and remove days with /birthday special.

Everyone's birthdays

These are on the Birthdays tab.

The Birthdays list

Birthdays in the server, with the search, Import a CSV, Download as CSV, Clean up members who left and the list of members

Every birthday in the server, with the member, their birthday (day and month only), how they're celebrated, and Waiting for them or Locked where that applies. Ages and years are never shown here.

  • Search by name or member ID. Names are shown for the first 1,000 members of a server.
  • Remove: press it twice. The birthday goes through Forget a Birthday, so their wishes and star sign role go too.
  • Import a CSV: up to 5,000 lines, each with a member ID, the day and the month (a number or a name). A header line naming the columns (member_id, day, month) lets them come in any order. Years are never read. Each birthday is saved as if the member added it, so a member over their changes for the year is skipped.
  • Download as CSV: every birthday, with member_id, name, day and month.
  • Clean up members who left: finds birthdays of members who aren't in the server any more, and forgets them after two presses.

Imports, removes and clean ups go one birthday every few seconds. The page shows how long is left, with a Stop button.

What is kept

  • The day and month of their birthday.
  • The year only when they choose to show their age.
  • Their time zone only when members can pick their own.
  • Wishes until their birthday ends.
  • Nothing else.

Birthdays aren't proof of age, so there's no 18+ option. Ages under 18 are never shown.

When a member leaves

  • Keep it for a while in case they come back: off to start with, so a leaving member's birthday is forgotten straight away. While it's on, it's kept for up to 90 days (it starts at 30), and forgotten after that unless they rejoin first.

Delete all birthdays

  • Delete all birthdays: press it twice to delete every birthday in the server, for good. Each one goes through Forget a Birthday, so wishes and star sign roles go too. It takes a few seconds a birthday.

When your bot leaves a server, every birthday, wish and list Birthdays kept for that server is deleted. The page's settings for it are kept.

The bot's messages

Every message Birthdays sends has its own card on the tab it belongs to. Each card has the message, Edit message to open the Message Builder, and the variables it fills in. Messages to the member are private replies only they can see, except the ones marked DM. Members with DMs closed don't get a DM, and nothing else happens.

The When a birthday is saved card, with the message, Edit message and the variables
Tab Message When it's sent
Celebrate When it's someone's birthday Posted in the birthday channel with the Wish button. Up to 10 versions, one picked at random
Celebrate When several people have a birthday the same day One post for everyone celebrated in the same hour
Celebrate When it's the birthday of someone with these roles Instead of the usual message, while A different message for some roles is on
Celebrate When it's their birthday (DM) A DM on their birthday, while Also send them a DM is on
Ask members When the ask panel is posted The panel, with Add my birthday, Upcoming and Remove mine
Ask members When a birthday is saved Once it's saved
Ask members When it can't be saved Saying why. {bday_problem} is the reason
Ask members When staff add someone's birthday (DM) To the member, while Tell the member is on
Ask members When staff add a birthday that needs a yes (DM) To the member, while Members confirm birthdays staff add is on
Ask members When a member confirms it They press That's right under /birthday mine
Ask members When a birthday is removed Once it's gone
Ask members When someone checks their birthday The reply to /birthday mine
Ask members When someone looks up a birthday The reply to /birthday view and View birthday
Ask members When they haven't added one The member has no birthday in this server
Ask members When staff preview the post Under the preview of /birthday preview
Wishes When someone sends a wish Once their wish is saved
Wishes When they've already sent one A second wish for the same member
Wishes When someone sends an early wish /birthday wish before the day, while Early wishes is on
Wishes When their birthday ends (DM) Every wish they got, while The birthday book is on
Upcoming When the Upcoming list is posted The list in its channel, and the reply to Upcoming and /birthday upcoming
Upcoming Birthdays today The reply to /birthday today
Upcoming When a new month starts The monthly post, while it's on
Upcoming When a birthday is coming up The heads-up, to staff or everyone
Special days When it's someone's server anniversary On the day they joined, every year after, while join anniversaries are on
Special days Each special day's own message On that day every year

Commands

The birthday commands, with /birthday and its subcommands, View birthday, Settings and one subcommand

Each subcommand of /birthday is its own command: open one to edit it in the builder, and its switch turns it on or off.

Command Who What it does
/birthday set Members Add or change your birthday: day, month, and optionally year, show_age, celebrate and zone
/birthday remove Members Remove your birthday from this server
/birthday mine Members See the birthday you saved here
/birthday view Members See a member's birthday
/birthday upcoming Members See the birthdays coming up, the last 30 days, or one month
/birthday today Members See whose birthday it is today
/birthday timezone Members Set your time zone, so you're celebrated at the right time
/birthday wish Members Send a member a birthday wish (or an early one)
/birthday panel Staff Post the ask panel, or update the one that is there. channel posts it somewhere else
/birthday add-for Staff Add a member's birthday
/birthday remove-for Staff Remove a member's birthday
/birthday block Staff Stop a member's birthday being added. unblock allows it again
/birthday lock Staff Stop a member changing their birthday. unlock allows changes again
/birthday preview Staff See the birthday post privately, for you or a member. Nothing is saved and nobody is pinged
/birthday special Staff Add or remove one of the server's special days
View birthday Members Right click a member, Apps, View birthday

Staff commands are for members with Manage Server or a staff role (Ask members tab, Staff). Anyone else is told they need one. The zone options suggest time zones as members type a city or a country.

If your bot already has a /birthday command, the page says so: rename or switch off yours in Custom Commands, or switch off the Birthdays one.

Events

Birthdays is made of ordinary builder blocks. Open an event to see how it works, or add your own blocks.

The birthday events, with Open in builder, the switch and Show variable names
  • Hourly Check runs every hour, in every server. It finds whose birthday it is now in their time zone, then runs Celebrate. It also sends the heads-ups, the monthly post, the Upcoming list, the birthday month role and the special days.
  • Celebrate gives the birthday role and the cake on their name until their day ends, then one post for everyone due that hour with the Wish button, the reactions, the pin, the thread and the DM.
  • Day Over runs when a member's birthday ends: it sends the birthday book, then forgets the wishes.
  • Save a Birthday is the one place a birthday is saved: the checks, the year, the day lists and the star sign role.
  • Forget a Birthday takes a member out of everything: the day lists, their saved birthday, their wishes and their star sign role.
  • Upcoming works out the lines for the next birthdays, the last 30 days, a month or today.
  • Post the Panel posts the ask panel or the Upcoming list, or updates the one that is there. It holds what their buttons do.
  • Anniversaries posts the join anniversaries, gives the milestone roles, then posts the special days.
  • Fill Join Dates runs from Fill in join dates on the page.
  • Move Members runs from Move my birthdays on the page.
  • Member Joined notes the day a new member joined, and stops forgetting a member who came back in time.
  • Member Left forgets a leaving member's birthday, now or after the days you picked.
  • Bot Left deletes everything Birthdays kept for a server when your bot leaves it.

Open in builder opens an event in the Command Builder, and the switch turns it on or off. Show variable names shows the variable behind each setting on the page, if you want to use them in your own commands. The hourly timer is listed on the Timed Events page too.

The settings on this page are read by the events' blocks, so changing a setting never changes the events. If you change an event and want the original back, use Put it back how it was beside it on the Birthdays page.

Message variables

Every Birthdays message can use these. Each message card lists the ones it fills in.

Variable What it shows
{server} The server's name
{bday_mentions} The birthday members, as mentions
{bday_name} The member's display name (the first one, when several share a day)
{bday_member} The member, as a mention
{bday_date} Their birthday, like 14 October
{bday_line} "Turns 21 today" when they show their age (18 or older), else their birthday
{bday_count} How many birthdays there are today
{bday_lines} One line per birthday member
{bday_time} The hour birthdays are celebrated, like 9:00
{bday_zone} The time zone they're celebrated in
{bday_year_line} ", born 2001" when their year is kept, empty otherwise
{bday_how_words} How they're celebrated: in the channel, just the role, or not at all
{bday_waiting_line} A line saying it waits for their yes, when a moderator added it
{bday_until} When it is, like in 3 days
{bday_problem} Why it couldn't be saved
{bday_count_line} " They have 3 wishes so far." while the wish count is on
{bday_wishes} Every wish, one per line
{bday_wish_count} How many wishes they got
{bday_wish_tally} " · 3 wishes" once people send wishes, while Show how many wishes is on
{bday_ping_text} " · @here" or the role, as a mention, when the post pings one
{upcoming_lines} The birthdays coming up, one per line
{bday_month_name} The month, like October
{bday_days_ahead} How many days before the birthday the heads-up goes
{bday_day_word} "day" when the heads-up is one day before, else "days"
{bday_anniv_lines} The members with a server anniversary today, one per line
{special_name} The special day's name

Every limit

What Limit
Versions of the birthday message Up to 10
Members named in one post 40, the rest are counted
Changes to a birthday 1 to 10 a year, 3 to start
Not celebrated if added fewer than Up to 60 days before
Birth year Not kept under 13, age not shown under 18
A wish 200 characters
Early wishes Up to 30 days before
Staff-added birthday waiting for a yes 14 days
Upcoming list Up to 25 birthdays, 10 to start
Monthly post Day 1 to 28 of the month
Heads-ups 3, each up to 30 days before
Milestone roles 5, each 1 to 50 years
Special days 25
Reward 1 to 1,000,000, 100 to start
Keeping a birthday after they leave Up to 90 days, 30 to start
CSV import 5,000 lines
Panel and Wish buttons Keep working for a year

Every feature is free for every bot. On free bots, the module's messages sometimes have a small Made with BotGhost line under them, about one time in three. Premium bots never do. Birthdays' variables and stored birthdays never count toward your free limits.

Moving from the old Birthdays

If your bot still has the old Birthdays module on, the page shows Birthdays (old) is still on at the top.

Birthdays (old) is still on, with Move my birthdays
  1. Press Move my birthdays. The channel, the time, the role, the message, the card, the reactions and the staff roles move into each server, and the old Birthdays is switched off, so nobody is celebrated twice.
  2. Press Save Changes.
  3. Press Move the birthdays. Each birthday goes through Save a Birthday as if the member added it, so nobody gets a DM. They go 30 at a time, with a progress bar and a Stop button. When it's done, the page says what moved in each server.

Turning the new Birthdays on while the old one is still on asks to switch the old one off first. Both can't run at once: everyone would be celebrated twice, and both have a /birthday command. The old one's birthdays and settings are kept.

Good to know

  • Each server has its own settings: channels, roles, the time and every message. Pick the server at the top of the page before you change them.
  • Each member is celebrated once a year. Changing their birthday after they've been celebrated doesn't post again.
  • A post goes out during the hour you picked, not always at the start of it.
  • After an update to Birthdays, the page shows an Update button. Your own changes to the events and messages are kept.

Common questions

Nobody was celebrated

Check your bot is online, a birthday channel is picked and you saved. Check the Hourly Check and Celebrate events are switched on. The member must have chosen In the channel (with Just the role they only get the role), have one of the roles in Who gets celebrated if you set any, and have added their birthday at least the number of days you picked before it. If the page warns that your bot's time zone for timed events isn't one the bot knows, pick another one in your bot's Settings, under Timed Events.

The birthday role isn't given

Check that your bot's role is above the birthday role in Server Settings > Roles, and has Manage Roles.

It was celebrated at the wrong time

Check the Time zone on the Celebrate tab. While Celebrate each member in their own time zone is on, members who picked a zone with /birthday timezone are celebrated at your hour in their zone.

Members can't add their birthday

Check Who can add a birthday, and whether staff blocked or locked their birthday with /birthday block or /birthday lock. A member who changed it too many times this year has to wait. The reply says why.

The panel's buttons don't do anything

Check your bot is online, and post the panel again after your last save: press Post it again on the Ask members tab.