Custom ID Actions

Through Message Components you can create custom interactions with different features to help customize your experience with Betsy even further.

How do I use Custom ID Implementations?

Each component has a field available called "Custom ID". This field can be used to create custom interactions between features and allow you to create your unique custom actions.

When using a Custom ID Action for a menu there is both a Menu Custom ID and an Menu Option Custom ID. Be sure to enter both of these values correctly for the functionality to work.

Custom actions may have variables that are accepted that can be added using the ":" character. Reference the example on each of the custom actions to understand how to add those variables and what variables each custom action accepts.

You can chain Custom ID Actions together to create multiple actions for a single component action. For example ButtonChannelSendTrackedMessage:test&CreateTicket:1098254540890972220:1098254541406883924 which will send a tracked message and create a ticket both in the same button click.

Chaining Custom ID Actions is a premium feature. Refer to the https://docs.betsybot.xyz/betsy-bot-discord-bot/betsy-premium-subscriptions page for more information

List of Custom ID Actions Available

MenuCreateTicket (Formely ManualCreateTicket)

This allows you to open tickets through a menu allowing you to create different types of tickets from a single message. You can read it more using the page below

You must supply the identifier of the ticket in the fields custom ID.

Custom Implementations

CloseTicket

This action can only be used in Button components and when used inside of a Ticket Channel will close the ticket. Acts the same as the global command "/ticket close"

ConfirmCloseTicket

This action can only be used in Button components. This custom action can be used to confirm the closure of a ticket if the "Auto Close" feature is used. This will force close the ticket. Currently this only works when the ticket creator clicks the button.

CancelAutoCloseTicket

This action can only be used in Button components. This custom action can be used to confirm the closure of a ticket if the "Auto Close" feature is used. This will cancel the auto close that has been setup for the ticket.

DeleteTicket

This action can only be used in Button components. When used inside a ticket channel this will delete a ticket. This will override the close action and the ticket will not be closed. This is essentially the same as deleting the channel or using the "/channel delete" global command.

ClaimTicket

This action can only be used in Button components. When used inside a ticket channel this will claim the ticket. This behavior mimics the behavior of the Claim Ticket button added when the ticket is opened in the initial message. A ticket MUST have "Allow Claiming" setting turned on.

ButtonCreateTicket:{identifier}

This allows you to open tickets through button components. You can read it more using the page below. You must use the delimiter and append the identifier for the support ticket.

Example "ButtonCreateTicket:Some Ticket Identifier"

Custom Implementations

ButtonSendTrackedMessage:{identifier}:{?channelId}

This allows you to send a tracked message with a button. This is a channel message and anyone in the channel can see this message. You must use the delimiter and append the identifier for the tracked message.

The channel ID parameter is option. The channel id parameter can be used to change which channel the message will be sent in. Without this parameter it will always be sent to the channel the button was clicked in.

Example "ButtonSendTrackedMessage:MyIdentifier"

Example "ButtonSendTrackedMessage:MyIdentifier:1234567890"

ButtonChannelSendTrackedMessage:{identifier}

Example "ButtonSendTrackedMessage:MyIdentifier"

An interaction response is required for components so when using this you will receive "Message Sent" privately. We suggest using ButtonSendTrackedMessage instead.

ButtonReplyTrackedMessage:{identifier}

This allows you to send a tracked message with a button. This is a reply message that is private and only the person interacting with the button can see the tracked message. You must use the delimiter and append the identifier for the tracked message.

Example "ButtonReplyTrackedMessage:TestTrackedMessage"

ButtonUpdateWithTrackedMessage:{identifier}

This allows you to update the message that was interacted with. The new message that appears will use the visibility of the original message. That means if you update a replied to message ("Only visible to me") it will still only be visible to the person interacting. You must use the delimiter and append the identifier for the tracked message.

Example "ButtonUpdateWithTrackedMessage:Updated Tracked Message"

AddRole:{roleId}

This allows you to have a button that will add a user to a specific role. You must use the delimiter and append the role ID.

Example "AddRole:951157914612146241"

RemoveRole:{roleId}

This allows you to have a button that will remove a role from a specific user. You must use the delimiter and append the role ID.

Example "RemoveRole:951157914612146241"

MenuUpdateWithTrackedMessage

The Menu Custom ID Must be "MenuUpdateWithTrackedMessage" and then the Option Custom ID Must match an Identifier used for a Tracked Message

MenuSendTrackedMessage

This allows you to send a tracked message with a button. This is a channel message and anyone in the channel can see this message.

The Menu Custom ID Must be "MenuSendTrackedMessage" and then the Option Custom ID Must match an Identifier used for a Tracked Message

MenuChannelSendTrackedMessage

This allows you to send a tracked message with a button. This is a channel message and anyone in the channel can see this message.

The Menu Custom ID Must be "MenuChannelSendTrackedMessage" and then the Option Custom ID Must match an Identifier used for a Tracked Message

An interaction response is required for components so when using this you will receive "Message Sent" privately. We suggest using MenuSendTrackedMessage instead

MenuReplyTrackedMessage

This allows you to send a tracked message with a menu select. This is a reply message that is private and only the person interacting with the button can see the tracked message.

The Menu Custom ID Must be "MenuReplyTrackedMessage" and then the Option Custom ID Must match an Identifier used for a Tracked Message

DeleteMessage

Deletes the message that the component is attached to

DeleteTrackedMessage:{identifier}

Deletes the last message that was sent for a tracked message

Example "DeleteTrackedMessage:MyIdentifier"

VerifyMessage

This is the custom ID action used to send the verification for the User Verification feature. This custom ID action allows you to customize the message that is sent to your liking. Creating a button with this Custom ID Action will send the link they need to click in order to verify for your server.

ReviewServer

Opens up the modal experience to review the server using the Review feature

ReviewUser

Opens up the modal experience to review the Server using the Review feature

ReviewCategory:{categoryName}

Opens up the modal experience to review the category provided with the parameter.

Example "ReviewCategory:MyReviewCategory"

GithubIssueSubscribe:{repo}:{issueNumber}

Subscribes the channel to updates about the issue.

Example "GithubIssueSubscribe:my-repo:1234"

SaveTicketTranscript

Saves the transcript for the support ticket that this custom ID action was executed in

Example "SaveTicketTranscript"

GenerateTicketTranscript

Sends the HTML File for the ticket transcript in the support ticket channel the Custom ID Action was executed in

Example "GenerateTicketTranscript"

MoveChannel:{categoryId}

Moves the channel that this custom ID action is executed on.

Example "MoveChannel:123456789"

RenameChannel:{name}

Renames the channel with the given string

Example "RenameChannel:SomeNewName"

PreviousMessage FAQs NextBetsy REST API

Last updated 1 month ago