Boost recurring donations this giving season with the new upsell prompt!In the Events app, administrators can customize the display of a confirmation page and automate the sending of confirmation emails and scheduled emails. This guide showcases how to include merge fields (or "variables" or "merge tags") in these elements to dynamically insert information, streamlining the communication process.
Merge fields can be used to customize email subject, confirmation page title, and body content in the following as indicated in the charts below. The first chart identifies Event- and Order-specific merge fields. The second details Ticket- and Attendee-specific merge fields:
Event confirmation page
Event confirmation email using the standard email template
Event confirmation email using the custom email template
Event scheduled emails
Administrator notification emails
Event and Order Merge Fields for Body Text
The following table details the available order-level merge fields for the body text of confirmation emails, scheduled emails and confirmation pages.
Defining default values
For some merge fields, default values can be defined so this text appears when no value exists for the merge field. Where default values are supported, it is noted in the Description column of the merge field. The format for including a default value is as follows:
{merge_field_name|This is my default value.}
Referencing custom Microsoft fields as merge fields
For sites integrating with Microsoft Dynamics, if you have included a Microsoft Marketing question field for an event on the Reservation Info tab, you can include this field value as a merge field. As noted be below, the format for the merge field is as follows with the Microsoft field Id accessible on the Reservation Info tab in the Custom Microsoft Dynamics for Marketing Fields section:
{msft_MICROSOFT-FIELD-ID}
| Merge Field | Description | Example | |||||
| {name} | Orderer full name | Jane Doe | |||||
| {orderer_first_name} | Orderer first name | Jane | |||||
| {orderer_last_name} | Orderer last name | Doe | |||||
| {orderer_email} | Orderer email address. Default value can be defined. | janedoe@example.com | |||||
| {orderer_phone} | Orderer phone. Default value can be defined. | (202) 555-1212 | |||||
| {orderer_organization} | Orderer organization. Default value can be defined. | Someorg | |||||
| {orderer_address} | Orderer street address. Default value can be defined. | 10 Main Street | |||||
| {orderer_city} | Orderer city. Default value can be defined. | Washington | |||||
| (orderer_state} | Orderer state. Default value can be defined. | DC | |||||
| {orderer_zip_code} | Orderer zip code. Default value can be defined. | 20005 | |||||
| {orderer_country} | Orderer country. Default value can be defined. | US | |||||
| {order_addon} | Selected choice for add on. Default value can be defined. | Accepted | |||||
| {amount} | Total amount of order (including tickets and optional donation) | $1,234.56 (NOTE: Confirmation page merge field does not include currency symbol) |
|||||
| {tickets} | Number of tickets included in order | 12 | |||||
| {ticketslist} | List of tickets ordered, and any optional donation | 1 x Gold Level = $1,234.56 | |||||
| {order_number} | Soapbox Engage order number | 1234 | |||||
| {order_sbxid} | Soapbox Engage order ID | example-O-482BD54B-6B8E7053-75D14135-AA40C4C2 | |||||
| {soapboxorderid} | Soapbox Engage order ID | example-O-482BD54B-6B8E7053-75D14135-AA40C4C2 | |||||
| {order_date} | Order date (Month D, YYYY) | April 2, 2030 | |||||
| {paymentstatus} | Payment status ("paid", "not paid") | paid | |||||
| {eventtitle} | Event title | Annual Black Tie Gala | |||||
| {eventimage} | HTML displaying the first image included in the description of event |
<div class="margin-top__larger" |
|
|
|||
| {eventdate} | Event date and time (includes range for multi-day or recurring events) |
Tuesday, December 31, 2030 - 6:00 PM to 7:00 PM EST
|
|
|
|
|
|
| {startdate} | Event start date (Day, Month DD, YYYY) | Tuesday, December 31, 2030 | |||||
| {enddate} | Event end date (Day, Month DD, YYYY) | Wednesday, January 1, 2031 | |||||
| {starttime} | Event start time (H:MM AMPM TZ) | 6:00 PM EST | |||||
| {endtime} | Event end time (H:MM AMPM TZ) | 7:00 PM EST | |||||
| {datetimestart} | Event start datetime (YYYY-MM-DDTHH:MM:SS) | 2030-12-31T18:00:00 | |||||
| {datetimeend} | Event end datetime (YYYY-MM-DDTHH:MM:SS) | 2031-01-01T19:00:00 | |||||
| {eventurl} | Front-end URL of the event |
https://example.secure.nonprofitsoapbox.com /calendar/gala |
|
|
|||
| {addtocalendar} | Descriptive text and links for Google, Outlook or iCal | Add to Calendar: Add to Google Outlook iCal | |||||
| {zoomwebinarid} | Zoom Webinar Id | 84801751243 | |||||
| {webinarmeetingid} | Zoom Meeting Id | 84801751243 | |||||
| {webinarattendeelinks} | Name, email, and personalized Zoom webinar link for each attendee | zoom041124b1 zoom041124b1 tim+zoom041124b1@picnet.net Personalized Webinar Link: Click to Join |
|||||
| {webinarattendeelinks_ sbxticket} |
Iterative attendee number, Soapbox Ticket Id, attendee name, attendee email, and personalized Zoom webinar link for each attendee | Attendee #1 testing002-T-17B01BA0-F73AE288-81B78DAC-3DF38367 zoom041124b1 zoom041124b1 tim+zoom041124b1@picnet.net Personalized Webinar Link: Click to Join |
|||||
| {location_name} | Venue name | Civic Center Auditorium | |||||
| {address_1} | Venue street address | 1234 Main St | |||||
| {address_2} | Venue street address second line | 3rd Floor | |||||
| {city} | Venue city OR city and state | For standard template confirmation email and standard template scheduled email, renders as: Washington, For custom template confirmation email, custom template scheduled email, or admin notifiication email, renders as: Washington, DC |
|||||
| {state} | Venue state | DC | |||||
| {zip} | Venue postal code | 20001 | |||||
| {country} | Venue country | USA | |||||
| {baseurl} | Domain of your Soapbox site with a trailing slash (/) - either a custom domain or Soapbox prefix domain | https://www.myorg.org/ https://engage.myorg.org/ https://myorg.secure.nonprofitsoapbox.com/ |
|||||
| {sbxaccountprefix} | Prefix for your Soapbox site | myorg | |||||
| {sbxaccountname} | Account Name for site as it appears in the header of the administrator | My Organization Name | |||||
| {sbxaccounturl} | Domain of your Soapbox site without a trailing slash (/) - either a custom domain or Soapbox prefix domain | https://www.myorg.org https://engage.myorg.org https://myorg.secure.nonprofitsoapbox.com |
|||||
| {sbxaccountlogo} | Account Logo defined in Account Settings | ||||||
| {sbxaccountaddress} | Address defined in Account Settings | 1100 15th Street NW | |||||
| {sbxaccountcity} | City defined in Account Settings | Washington | |||||
| {sbxaccountstate} | State defined in Account Settings | DC | |||||
| {sbxaccountcountry} | Country defined in Account Settings | US | |||||
| {msft_MICROSOFT-FIELD-ID} | Value entered for custom Microsoft field. Default value can be defined. | This is the value for the custom Microsoft field on the Reservation Info tab of an event. |
Ticket and Attendee Merge Fields for Body Text
The following table details the available ticket and attendee merge fields for the body text of confirmation emails and confirmation pages. Ticket and attendee merge fields are not supported for scheduled emails at this time.
Repeating ticket section of body text
Within the body text of the confirmation page and confirmation emails, you can add a block of text that will repeat for each ticket included in an order. To do so, place the following opening and closing tag before and after the text block:
{ticket_section}{/ticket_section}
Text within the block may include the ticket and attendee merge fields below, order fields noted in the table above and any other content you wish. For example:
{ticket_section}
Ticket Name: {ticket_name}
Name of Attendee: {attendee_first_name|(First name not provided} {attendee_last_name|(Last name not provided}
Email of Attendee: {attendee_email|(Email not provided)}
Orderer: {orderer_first_name} {orderer_last_name}
Event name: {eventtitle}
{/ticket_section}
Defining default values
For some merge fields, default values can be defined so this text appears when no value exists for the merge field. Where default values are supported, it is noted in the Description column of the merge field. The format for including a default value is as follows:
{merge_field_name|This is my default value.}
Referencing custom Microsoft fields as merge fields
For sites integrating with Microsoft Dynamics, if you have included a Microsoft Marketing question field for an event on the Attendee Info tab, you can include this field value as a merge field. As noted be below, the format for the merge field is as follows with the Microsoft field Id accessible on the Attendee Info tab in the Custom Microsoft Dynamics for Marketing Fields section:
{msft_ticket_MICROSOFT-FIELD-ID}
| Merge Field | Description | Example | |||||
|
VIP Ticket |
|||||||
| VIP Ticket holders are allowed early entrance to the event and will receive a special thank you gift. | |||||||
| {attendee_mailing_postal_code} | Attendee zip code. Default value can be defined. | 20005 | |||||
| {msft_ticket_MICROSOFT-FIELD-ID} | Value entered for custom Microsoft field. Default value can be defined. | This is the value for the custom Microsoft field on the Attendee Info tab of an event. |