Skip to main content

Forms Builder

The Forms Builder module enables users to create Q/A forms that are presented to end-users by sending a Direct Message to the bot. The Q/As can be set up to be a sequence of multi-choice or open questions, with the final output (submission) being sent into a server channel by the bot itself for further validation, priority assignment and optional integration with external services.

(Optional features) Upon accepting a submission, a submission summary can be forwarded as a read-only post to a different channel and can be automatically given an "upvote" and "downvote" reaction for people to show their support (or lack thereof) to the specific submission.

Currently, each form submission can be configured to remain within the Discord realm, or uploaded to Trello (a powerful web-based, list-making application) as a "Trello card" ("share mode").

Trello integration also includes the 2-way synchronization of upvotes/downvotes and comments number from and to Discord and Trello (showing the number of upvotes and downvotes on the Trello card, as well as showing the current number of Trello comments and votes on the Discord message), and Discord DM notifications to the author of the submission upon Trello card activities (new comments, title changes, card archival, etc.).

Warning

For the Trello integration to work, some limitations currently apply:

  1. You must invite GiselleBot to your Trello team and give it permissions to edit the board in order for the bot to monitor, post and update cards. You can invite GiselleBot to your Trello team using this email address: [email protected].
  2. You must pair the Discord server with the Trello team from your server's Forms page on the dashboard. Each Discord server can only be paired with 1 Trello team.
  3. Form settings will be fixed once a user sends a submission. Any change to a form will not apply to submissions that are already in the approval queue. This also means that the Trello board must be set (thus, exist) before a submission is sent.

Note

Users that are enabled to use the module using the Permissions System will always be authorized to accept or reject any submission coming from any form. In order to enable more roles to accept/reject specific forms, you can set one or more roles as "authorized roles" on each form from your server's Forms page on the dashboard.

Note

Premium: Out of the box, each server is limited to having a total of 3 available forms. If you want to remove this limitation and have up to 20 forms, you can unlock the number of forms as a Premium feature (see Premium Perks).

Note

Creating, editing, publishing/withholding, and deleting forms, and blacklisting users from seeing them, are all done from your server's Forms page on the dashboard - see the Form Management section below.

Trello pairing (dashboard)

Note

Pairing a Trello team is done from your server's Forms page on the dashboard, not a Discord command.

Enter the team name or the URL containing the team name (the team name is the one you find inside the Trello URL within the team page, which usually has this form: https://trello.com/TEAM_NAME/home) to pair, or unpair the server's currently-paired team.

No restrictions are applied to the number of Discord servers that can pair a Trello team, although each server must pass the verification step individually (see below).

As a security measure, the Trello team pairing process is composed of 2 steps. Starting a pairing issues a verification request to the target Trello team, giving you a 6-digit unique code (generated randomly). You must then verify that you have enough permissions to create cards on at least one Team board before the pairing is effective.

Next, GiselleBot will start querying the Trello team boards in order to find a card with the 6-digit code set as title. You must head to one of the Team boards and create a card (in any list) with the provided 6-digit code as title.

If no card is found with the correct title within 5 minutes of starting the pairing, it will fail. If the card is found, the pairing will complete and the team boards will be available for use in the Forms module.

Once the card is found the pairing will complete, activating the integration. The verification card will be deleted.

/submit

Command Syntax

/submit

Command Description

Sends the user running the command a DM showing the available forms for the server the command was run in, giving them the option to start filling a submission.

Warning

/submit can only be run inside a server - it cannot be run directly in a Direct Message channel with GiselleBot to pick from a list of servers. Run it from within the server whose forms you want to fill out.

Permissions Needed

  • User: None, other than a specific blacklist check (see the Form Management section below). The actual form submission always happens through GiselleBot's DMs.

Examples

/submit

Submit reactions (dashboard)

Note

Setting up and removing "submit reactions" is configured from your server's Forms page on the dashboard, not a Discord command.

Other than running /submit in a server to start the DM workflow, authorized people can enable a specific reaction on a message of choice (or a message created by GiselleBot for that purpose) to have GiselleBot send the initial form submission DM to the user clicking on the reaction. The Forms page lets you create this on a specific message, using a Discord message URL, a channel + message ID, or a brand-new message, and pick the reaction emoji.

Form Management

Note

The entire forms-authoring toolkit - initializing a form, adding/editing/removing/reordering its questions, configuring it (title, color, authorization channel, forwarding channels, authorized roles, share mode, upvoting/downvoting, attachment highlighting, Trello board, anonymization, and every other setting), publishing/withholding it, previewing it, deleting it, and blacklisting users from it - is done entirely from your server's Forms page on the dashboard.

On the Dashboard

Your server's Forms page covers the full authoring and management workflow that has no slash-command equivalent:

  • Current Forms lists every form as a card (title, ON/OFF live status, Discord vs. Trello share mode), with Add New Form and, per form, a Manage link into that form's full editor (questions, title, color, authorization channel, forwarding channels, authorized roles, upvote/downvote, attachment highlighting, Trello board, anonymization, publish/withhold, preview, delete, and blacklist).
  • Guild Form Settings has the server-wide Auto-Delete Submit Messages toggle (requires Manage Messages), which deletes the message used to submit a form once it's been submitted.
  • Reaction Messages lets you add or remove a "submit reaction" on any message.
  • Blacklist lets you block specific users from seeing or submitting any of the server's forms.
  • Trello Team is where you pair (or unpair) the server's Trello team, as described above.

See also

Full migration mapping for these commands: Migration Guide.