Standard service variables
This article describes all available service variables on Wooxy.
Things to know before starting
- Adherence to the lowerCamelCase naming convention for all variables (e.g., contactBirthday), where multiple words are joined as one and each word except the first starts with a capital letter.
- Requirement of the YYYY-MM-DD format for all date-related values to ensure correct system recognition (e.g., "1900-01-01").
- A preliminary review of common file import errors is recommended to ensure successful data processing and variable creation.
- Mandatory use of double curly braces to enclose any variable for correct rendering within Wooxy templates and other platform sections (e.g., {{variableName}}).
Contact list variables
Contact list variables are data points defined in the contact list settings and created or modified when a list is created or modified.
-
Variables
- {{listName}} - displays the current name of the Contact List.
- {{host}} - represents the website domain associated with the "From Email" address, updating automatically upon switching the domain in the account.
- {{companyName}} - displays the company name, typically utilized for branding or legal identification in template footers.
- {{companyEmail}} - generates a contact email by combining the "Default from email" value and the {{host}} variable from the Contact List settings.
- {{companyAddress}} - displays the company's physical address (excluding city and country, which are handled by separate variables).
- {{companyCountry}} - inserts the specific geographic location of the company at the country level.
Contact variables
Contact variables provide access to specific contact data for display in messages and can be used for list segmentation or to create dynamic templates with Twig. While certain variables, such as {{emailSubscribe}}, maintain standard system values, others require strict adherence to specific input formats for correct data processing.
-
Variables
- {{name}} - optional display name used for the recipient; automatically merges firstName and lastName upon initial import but remains editable or definable as a separate value.
- {{firstName}} - contact’s first name.
- {{lastName}} - contact’s last name.
- {{fullName}} - dynamic combination of the firstName and lastName variables; this value is generated for display and is not stored permanently in the system.
- {{email}} - unique email address of the contact and one of the three primary identifiers; requires strict syntax validation to avoid delivery errors.
- {{phoneNumber}} - contact’s phone number in E.164 format; serves as one of the three unique identifiers and is mandatory for SMS communications.
- {{userId}} - platform-specific unique identifier used for advanced list management, segmentation, and as an alias for email addresses.
- {{active}} - contact's activity status where "1" indicates an active subscription and "0" (default) marks the contact as inactive and ineligible for communications.
- {{contactBirthday}} - contact’s date of birth, requiring the YYYY-MM-DD format.
- {{contactLanguage}} - contact’s locale specified in ISO 639-1 format.
- {{contactGender}} - contact’s gender representation based on the ISO/IEC 5218 standard.
- {{contactTimezone}} - contact’s timezone in ISO 8601 format; enables campaign delivery according to the recipient's local time instead of the account's default zone.
- {{contactScore}} - numerical value used to qualify leads and assess contact value to the organization.
- {{avatarLink}} - direct URL to the contact’s profile image or avatar.
- {{facebookLink}}, {{instagramLink}}, {{linkedInLink}}, {{twitterLink}}, {{tiktokLink}} - direct links to the contact’s respective social media profiles.
- {{sourceId}} - internal acquisition source ID registered within the Wooxy admin panel.
- {{customerSourceId}} - external acquisition source ID from a third-party system used for cross-platform synchronization.
- {{sourceName}} - name of the customer acquisition source as defined in the source section.
- {{cacValue}} - string value representing the cost of acquisition per contact.
- {{cacCurrency}} - acquisition currency, restricted to uppercase Latin "USD" or "EUR" values.
- {{contactCreatedAt}} - system-generated date indicating when the contact profile was first created.
- {{emailSubscribe}}, {{smsSubscribe}}, {{telegramSubscribe}}, {{viberSubscribe}} - channel-specific subscription statuses where "1" enables and "0" (default) disables communication for that specific channel.
- {{desktopWebPushSubscribe}}, {{mobileWebPushSubscribe}} - subscription management for web push notifications across different device types.
Standard service variables
Standard service variables are available for integration into message templates, with some restricted to specific channels, such as Web Push or Telegram. Furthermore, the utilization of specific variables within the email channel may be subject to additional constraints depending on the selected sending method or campaign type.
-
Variables
- {{telegramBot_yourBotName}} - generates a subscription link to the Telegram bot connected to the Wooxy platform; functions exclusively within templates sent via the Telegram channel.
- {{currentDate}} - displays the current date in MM-DD-YYYY format based on the UTC time zone.
- {{currentMonth}} - inserts the numerical value of the current month.
- {{currentYear}} - displays the current year.
- {{campaignName}} - inserts the specific title of a campaign; restricted to templates used in Campaign communications and applicable for UTM parameter formation.
- {{workflowName}} - displays the name of the workflow; functions exclusively within templates sent via Workflows and is applicable for UTM parameter formation.
- {{splitTestName}} - displays the name of the A/B test; functions exclusively within templates sent via Split Tests and is applicable for UTM parameter formation.
- {{segmentName}} - inserts the name of the segment; restricted to templates used in Campaigns and Split Tests, also applicable for UTM parameter formation.
- {{templateId}} - provides the unique template ID for the account, primarily used to track recipient actions and generate UTM parameters.
Service variables for email
These specialized variables enable the inclusion of subscription and unsubscribe links within email templates. Utilizing these links directly updates the contact's {{emailSubscribe}} status to 1 or 0, respectively, managing their presence on the email list without adding them to the global blacklist.
-
Variables
- {{unSubscribeUrl}} - provides contacts with a direct link to unsubscribe from the email list.
- {{subscribeUrl}} - provides contacts with a direct link to subscribe to the email list.
- {{webVersionLink}} - generates a link that lets recipients view the email in their browser.
Service placeholders
Placeholders function as dynamic elements within templates, automatically replaced with relevant values upon delivery. These universal components require no additional configuration and perform essential tasks, such as incorporating unsubscribe links. Beyond standard templates, these placeholders are also compatible with raw content for SMTP communications and various API methods, including Send Email.
-
Placeholders
- {webVersion} - generates a link to the web version of the message for browser viewing if the email client fails to render the template correctly; compatible with SMTP, all API methods, test sends, automations, and campaigns.
- {listUnsubscribeLink} - enables the list-unsubscribe mechanism within the email; contacts using this method are automatically moved to the suppression list. Compatible with SMTP, all API methods, test sends, automations, and campaigns.
