In Good Grants, the communications sent to your programs users can be personalised through the use of merge fields.
What are merge fields?
Merge fields are system tags which pull information automatically from within a user's profile and/or applications. Merge fields are used to populate messages with personalised information like a user's name, the name of their application, their category selection, and more.
Where can I personalise content?
Merge fields are available in broadcasts, notifications, certificates, and more. They're represented with curly brackets ({}) like those shown below. When the message is sent the merge field is replaced with data. For example, the {account_name} field will be replaced by a the name of your Good Grants program.
What merge fields are available?
There are two different types of merge fields: those that are built into the platform and those that you can customise yourself based on your program's application form or user fields.
Depending on what trigger you've selected in a notification or where you've opted to broadcast from, the available merge fields will change. When you're composing your message they'll appear as clickable links or are available for selection in the text editing tools (shown below).
| Clickable merge fields box |
|
| Text editing tools |
To add a merge field, all you need to do is place your cursor where you want the merge field and then click the merge tag you want, it will automatically be placed where your cursor is in the email subject line, email body, or SMS body.
Default merge fields
Account and recipient merge fields
| Merge field | What it represents | Available in |
| {account_name} | Account name | Every notification |
| {account_url} | Account URL | Every notification except Application invited, Collaborator invited, and User invited |
| {recipient_first_name} | Notification recipient's first name | Every notification except User invited |
| {recipient_last_name} | Notification recipient's last name | Every notification except User invited |
| {user_email} | Email address of the user associated with the event | Collaborator invited, Document created, Role granted, User invited, and User registered |
Applicant and application merge fields
| Merge field | What it represents | Available in |
| {applicant_name} | Applicant's full name | Review stage completed / started |
| {applicant_first_name} | Applicant's first name | Applicant-context notifications |
| {applicant_last_name} | Applicant's last name | Applicant-context notifications |
| {applicant_email} | Applicant's email address | Applicant-context notifications |
| {application_name} | Application name | Application-context notifications |
| {application_slug} | Application slug | Application-context notifications |
| {application_local_id} | Application's local identifier | Application-context notifications |
| {parent_category} | Parent category associated with the application | Application-context notifications except Application resubmitted |
| {category} | Application category | Application-context notifications |
| {chapter} | Chapter associated with the entry | Application-context notifications |
Judging and assignment merge fields
| Merge field | What it represents | Available in |
| {review_url} | Link to the relevant action flow task | Action stage started / completed |
| {reviewer_name} | Reviewer's name | Action stage started / completed |
| {assignment_url} | Link to the reviewing assignment | Assignment created |
Invitation merge fields
| Merge field | What it represents | Available in |
| {message} | Message associated with the invitation | Application invited, collaborator invited, and User invited |
| {invite_link} | Invitation link | Application invited and collaborator invited |
| {join_link} | Link for the user to join | User invited |
Document merge fields
| Merge field | What it represents | Available in |
| {date_document_created} | Document creation date | Document created |
Grant report fields
| Merge field | What it represents | Available in |
| {report_name} | Grant report name | Grant report due / scheduled / submitted |
| {report_due} | Grant report due date | Grant report due / scheduled / submitted |
| {report_url} | Link to the grant report | Grant report due / scheduled / submitted |
| {report_slug} | Grant report slug | Grant report due / scheduled / submitted |
Payment and order merge fields
| Merge field | What it represents | Available in |
| {payment_amount} | Payment amount | Order payment pending / success |
| {payment_method} | Payment method | Payment due / status changed |
| {payment_due_date} | Payment due date | Payment due / status changed |
| {payment_reference} | Payment reference | Payment due / status changed |
| {payment_currency} | Payment currency | Payment due / status changed |
| {payment_status} | Payment status | Payment due / status changed |
| {order_id} | Order identifier | Order payment pending / success |
| {invoice_url} | Link to the invoice | Order payment pending / success |
Custom merge fields
You can create custom merge fields from fields you’ve created by using the {application_field:abcd1234} and {user_field:abcd1234} merge fields, however, these are subject to the notification trigger type.
Example: Trigger: Application submitted
For this to work you’ll need to replace the 'abcd1234' sample slug with the actual slug for the field. The slug is the unique ID for each field which can be found at the very end of the URL of that field. To find it, open the Manage workspace, go to Settings > Applications > Fields, and click on any field to open it for editing in your browser. Check the URL in the browser address bar and you’ll see something like this:
https://yourprogram.grantplatform.com/field/YlegNDAo
The eight-character code at the end is the slug. This is the unique ID that references that specific field. If it’s an application field the merge field in this example will look like this:
{application_field:YlegNDAo}
If the field is a user field then it will look like this:
{user_field:YlegNDAo}
Good to know
- Merge fields are represented with curly brackets ({}) and are replaced with data when the message is sent.
- The merge fields available depend on the notification trigger or broadcast source you select.
- Merge fields that pull in multi-line text fields or tables should be placed on their own line to allow for proper formatting.
- Custom merge fields require the actual field slug in place of the 'abcd1234' sample.
- The field slug is the eight-character code at the end of the field's URL.