Merge tags added by GravityBoard
GravityBoard adds merge tags for a card’s votes, its assignees, and mention emails. The vote tags and the {gravityboard_assignees:*} tags fill in wherever Gravity Forms fills in merge tags for an entry, such as notifications and confirmations. The single-assignee tags and the mention tags fill in only in the emails their sections name.
GravityBoard’s merge tags, with their options for assignees, votes, and voters, appear in the GravityKit Visual Merge Tags picker. In Mention Notification Subject and Mention Notification Body, the picker also offers the mention tags listed below.
Voting merge tags #
The following merge tags provide vote data for the current entry:
{gravityboard_votes:count}: Total number of voters on the entry.{gravityboard_votes:average}: Average vote weight across all voters (rounded to 2 decimal places).{gravityboard_votes:total}: Net vote total (sum of all weights). Can be negative if downvotes outnumber upvotes.{gravityboard_votes:up}: Number of upvotes (voters with positive weight).{gravityboard_votes:down}: Number of downvotes (voters with negative weight).
This merge tag lists the voters’ email addresses:
{gravityboard_voters:emails}: Comma-separated list of email addresses of all users who voted on the entry.
Assignee merge tags #
These merge tags cover every assignee on the card:
{gravityboard_assignees:emails}: Comma-separated list of assignee email addresses.{gravityboard_assignees:names}: Comma-separated list of assignee display names.{gravityboard_assignees:list}: Formatted list of assignees with avatars (HTML in HTML context, plain text otherwise).
The following merge tags are specific to the individual assigned user:
{gravityboard_assignee_email}: The email address of the assignee. Also available as{gravityboard_assignee:user_email}.{gravityboard_assignee:display_name}: The display name of the assignee.{gravityboard_assignee:user_login}: The login name of the assignee.{gravityboard_assignee:first_name}: The first name of the assignee.{gravityboard_assignee:last_name}: The last name of the assignee.{gravityboard_assignee:ID}: The WordPress user ID of the assignee.{gravityboard_assignee:nickname}: The nickname of the assignee.{gravityboard_assignee:user_nicename}: The assignee’s login name as it appears in author page addresses.{gravityboard_assignee:user_url}: The website address in the assignee’s profile.{gravityboard_assignee:description}: The Biographical Info in the assignee’s profile.
These per-assignee tags fill in for the GravityBoard – Assignee(s) Added and GravityBoard – Assignee(s) Removed notification events. Those two events fire once for each person added or removed. GravityBoard – Assignee(s) Updated fires once per save with the whole list, so there is no single assignee for these tags to describe. In a notification on that event, use the {gravityboard_assignees:*} tags instead.
These tags read only the properties listed above, and the names are case-sensitive. Any other property, such as a user meta key, comes out empty. A developer can allow more with the gk/gravityboard/merge-tags/assignee-properties filter, described in GravityBoard hooks and REST API. Passwords, session tokens, activation keys, and meta keys that start with an underscore stay empty even when added.
Sending a notification to everyone assigned to a card
To email everyone assigned to a card:
- Go to Forms, open your form, then go to Settings and Notifications.
- Create a new notification or edit an existing one.
- Set Send To to Enter Email, and enter
{gravityboard_assignees:emails}in Send To Email.
The CC and BCC fields accept these merge tags too.
Mention notification merge tags #
These merge tags work in Mention Notification Subject and Mention Notification Body, in the board’s Notifications tab.
{notifier_name}: The display name of the user who wrote the note and mentioned someone.{mentioned_user_name}: The display name of the user who was mentioned.{note_excerpt}: A short excerpt of the note containing the mention.{entry_details_url}: A URL to view the entry details within Gravity Forms (your site’s backend).{board_card_link}: A link that opens the card on the page where the note was written. A recipient who cannot edit and delete notes on the board gets “[not available due to permissions]” instead.{note_id}: The ID of the note.{board_name}: The name of the GravityBoard.{entry_id}: The ID of the Gravity Forms entry.{form_id}: The ID of the form.{admin_email}: The admin email address for your WordPress site.
Merge tags in a custom card description #
When a board’s Card Description is set to Custom text (with merge tags), each card fills in the merge tags in that text from its own entry. Field merge tags and {all_fields} work there, and so do the voting tags and the {gravityboard_assignees:*} tags. {user} is whoever is viewing the board, so use {created_by:display_name} for the person who submitted the entry. Setup is in Getting started with GravityBoard.
Notification events #
GravityBoard adds these events to the Event dropdown of a Gravity Forms notification. A notification set to one of them sends when that action happens on the board, as long as Trigger Form Notifications is on in the board’s Notifications tab.
- GravityBoard – Card Added, Card Edited, Card Deleted, Card Sorted, Card Changed Lane
- GravityBoard – Lane Added, Lane Edited, Lane Deleted, Lane Moved
- GravityBoard – Assignee(s) Added, Assignee(s) Removed, Assignee(s) Updated
- GravityBoard – Attachment(s) Added, Attachment(s) Removed, Attachment(s) Updated
- GravityBoard – Vote Added, Vote Removed
