Events

Create custom events for when a user joins, a channel is created, etc.

The Custom Events module is where you can trigger actions based on things that occur in your server, on a timed basis, from an IFTTT trigger, and even from a BotGhost webhook.

Getting Started

  1. Located in the Custom Events module, you will see the "New Custom Event" section, click the "Custom Event Builder" yellow block to create a new event.

2. Select a custom event from the options currently provided.

These options will activate when a condition is met. For instance, if a user joins your server, you can then have the bot greet them, like the announcement module, and DM them.

3. Under the yellow main block, click on it and set an "Event Nickname". This will be shown in the dashboard if you are ever looking to edit a certain event. You can name it to whatever you'd want.

Blocks

In the custom event builder, the blocks you can use vary to the custom command builder. While creating an event, you cannot use options or certain conditions. As an example, you cannot use a "User Condition" in a timed event as the event has no user trigger. You can however use it if you have at least one button or select menu in your event.

Available Events

The type of events you may use in the custom events builder can be found below.

Member Events

The member events are based on actions in your server that are related to users.

  • When a new user joins the serer

  • When a user is banned from the server

  • When a user is unbanned from the server

  • When a user leaves or is kicked from the server

  • When a role is added to a user

  • When a role is removed from a user

  • When a guild member is updated

  • When a user changes their nickname

  • When a user changes their status

Channel Events

The channel events are based on actions in your server that are related to channels.

  • When a channel is created

  • When a channel is deleted

  • When a channel is updated

  • When a channel's permissions are updated

Thread Events

The thread events are based on actions in your server that are related to threads or forum posts.

  • When a thread is created

  • When a thread is deleted

  • When a thread is updated

Scheduled Events Events

The scheduled events events are based on actions in your server that are related to the scheduled events feature.

  • When a scheduled event is created

  • When a scheduled event is updated

  • When a scheduled event is deleted

  • When a user joins a scheduled event

  • When a user leaves a scheduled event

Message Events

The message events are based on actions in your server that are related to messages.

  • When a new message is sent

  • When a message is updated or edited

  • When a message is deleted

  • When a message is pinned

Role Events

The role events are based on actions in your server that are related to roles.

  • When a role is created

  • When a role is updated

  • When a role is deleted

Voice Events

The voice events are based on actions in your server that are related to voice channels and users inside of them.

  • When a member joins a voice channel

  • When a member switches voice channels

  • When a member leaves a voice channel

  • When a member is server muted

  • When a member self mutes

  • When a member is server unmuted

  • When a member self unmutes

  • When a member is server deafened

  • When a member self deafens

  • When a member is server undeafened

  • When a member self undeafens

Reaction Events

The reaction events are based on actions in your server that are related to reactions on messages.

  • When a reaction is added to a message

  • When a reaction is removed from a message

Invite Events

The invite events are based on actions in your server that are related to invites.

  • When a invite is created

  • When a invited is deleted

Boost Events

The boost events are based on actions in your server related to server boosts.

  • When a member boosts the server for the first time

  • When a member unboosts the server

  • When a server boost level increases

  • When a server boost level decrease

Poll Events

The poll events are based on actions in your server related to the discord builtin poll feature.

  • When a user votes on a poll

  • When a user removes their vote on a pol

Bot Events

The bot events are related to actions that occur within your bot.

  • When a bot joins a server

  • When the bot starts or is restarted

  • When a custom variable's value changes

  • When the bot is updated through the dashboard

Timed Events

Timed events are a special type of events that can run on a scheduled (every day at 5 pm) or a set interval (every 10 minutes). Check out the Timed Events page for more.

IFTTT Events

IFTTT events can be triggered by IFTTT when something occurs (ex. you've created an applet that triggers a custom event when a video is posted on YouTube). Learn more on how to use them here.

Webhook Events

Webhook events can be triggered by an API Request sent to BotGhost. Learn more on the Webhooks page.

Variables

All specific and special variables can be found in the variable tab, the variable list changes per event type.

All event specific variables can be found in the variable list (represented by a clipboard icon), that appears on every input in your event builder. Those vary per event type. Learn more about variables and other variable types in the Variables page.

Last updated