Event variables

Your code starts with some variables already filled in, like user and server. Which ones you get depends on what started the code.

The tables below list them. Using a variable that is not in the list fails with a "not defined" error. All helper functions in the API reference are there too, unless a section says otherwise.

To read what is on each object, see Objects.

Slash command#

Only in the post-hook, after the reply is sent:

See How commands run for the order of pre-hook, reply and post-hook.

Text command#

The same as a slash command, with two changes:

• message is the message that ran the command. There is no interaction.
• Saved variables load first, so a built-in name wins over a variable with the same name.

See Text commands.

Member Join, Leave and Update#

There is no channel and no message. message_id and channel_id are None.

Message#

Runs for every new message. Premium only.

if user is None or user.is_bot:
    return

Reaction#

Runs when someone adds or removes one of the emojis you list on the event.

There is no message object. Get it with get_message(channel_id, message_id).

Voice Join, Leave and Change#

Thread#

Runs when a thread is made, changed or deleted.

There is no server here. Use event.get_guild().

Clock#

Runs when a clock or a repeating job fires. See Scheduling.

In the event's custom IDs, list exact names, or end with * to match many, like remind_*.

Vote (top.gg)#

Runs when someone votes for your server on top.gg.

Form sent#

Runs after a member sends one of your forms, on the web or on Discord. It runs for every form, so check which one first. The answers are already saved.

if form["slug"] == "staff-application":
    age = answers_by_label.get("How old are you?", "—")
    await send_message(123456789012345678, f"<@{user_id}> applied. Age: {age}")

Each entry in answers has five keys:

Use text when you show an answer, and value when you act on it:

LOG = 123456789012345678  # your log channel's ID

await send_message(
    LOG,
    message=Message(
        title=f"{form['name']}: new answer",
        description=f"From <@{user_id}>",
        color="#5865F2",
        fields=[(a["label"], a["text"] or "-", False) for a in answers],
    ),
)

Button Click / Select Menu Change#

Runs when someone clicks a saved button or picks from a saved menu. List the component IDs on the event.

Also here: defer_response, respond_interaction, send_modal, cooldown, require_permission, allowed_roles, banned_roles, allowed_channels, banned_channels.

Modal Submit#

Runs when someone sends a form. The event's custom IDs list the form IDs.

answer = values.get("reason", "")

There is no message. The same 3-second rule and helpers as button clicks apply. See Forms.

Autocomplete#

Runs while someone types into a command option that has autocomplete. You return the suggestions.

There is no user. Reply in under 3 seconds with respond_options. Write await yourself.

await respond_options(options, auto_filter=True)

await respond_options([
    AutocompleteChoice(name="Red team", value="red"),
    AutocompleteChoice(name="Blue team", value="blue"),
])

name is what people see. value is what your command gets. Do not fetch or sleep here: it is too slow.