Skip to main content

Variable overview

Variables are a powerful feature that allow you to make your platform communications dynamic, personalized, and context-aware

Marie Xhauflair avatar
Written by Marie Xhauflair
Updated this week

What are variables?

First, let's talk about what variables actually are. Essentially, variables are dynamic placeholders to personalize content. Instead of writing each userโ€™s name, module title, or manager manually, variables pull in this data automatically which saves time and makes communication to users more relevant.

Where can we find variables?

  • Notifications

    • Platform

    • Emails

  • Magic wall

  • Learning content

  • Workflows

For who are variables for?

  • Users

  • Buddies

  • Direct and indirect managers

  • Everyone and anyone, really!

๐Ÿ“š List of available variables

๐Ÿ‘ค User information

Variable

Description

{{event.user.first_name}}

First name of the user the message is about

{{event.user.get_full_name}}

Full name of the user the message is about

{{event.user.last_name}}

Last name of the user the message is about

{{event.user.username}}

Username/login of the user the message is about

{{event.user}}

Shortcut for full name of the user the message is about

๐Ÿ—“๏ธ Contract information

Variable

Description

{{event.user.profile.contract_start_date}}

Start date of the user's contract

{{event.user.profile.contract_end_date}}

End date of the user's contract

๐Ÿค Buddy Information

Variable

Description

{{event.user.profile.buddy.first_name}}

Buddyโ€™s first name (linked to the user the message is about)

{{event.user.profile.buddy.get_full_name}}

Full name of the buddy

{{event.user.profile.buddy.last_name}}

Last name of the buddy

โœ๏ธ Manager information

Variable

Description

{{manager.first_name}}

First name of the manager (often the receiver of the message)

{{manager.get_full_name}}

Full name of the manager

{{manager.last_name}}

Last name of the manager

{{manager.username}}

Username of the manager

๐Ÿ“ฅ Receiver information

Variable

Description

{{receiver.first_name}}

First name of the message recipient

{{receiver.get_full_name}}

Full name of the message recipient

{{receiver.last_name}}

Last name of the message recipient

{{receiver.username}}

Username of the message recipient

๐Ÿ“ค Sender information

Variable

Description

{{sender.first_name}}

First name of the sender (person or system)

{{sender.get_full_name}}

Full name of the sender

{{sender.last_name}}

Last name of the sender

{{sender.username}}

Username of the sender

๐Ÿง  Grading & learning events

Variable

Description

{{event.module.title}}

Title of the learning module

{{event.graded_by.get_full_name}}

Full name of the person who graded the module

{{event.grade_description}}

Descriptive label for the grade (e.g., โ€œExcellentโ€)

{{event.grade_comment}}

Comment or feedback left by the grader

๐Ÿ“… Event

Variable

Description

{{event.recorded_at}}

Date and time when the event was logged

๐Ÿ”— Actionable Links

Variable

Description

<a href="/#/reporting/user-detail/{{event.user.pk}}/">Click here to grade the activity.</a>

Direct link to the reporting page of the user the message is about

๐Ÿ’ก Good to know!

The way variables behave can differ slightly depending on whether you're working with platform notifications or email notifications. For instance:

  • For platform messages, you could add a greeting and explicit mention of the user involved.

  • For email messages, they automatically include greetings, so you can skip "Hi {{...}}".

  • The recipient ({{receiver}}) is any user, it depends on the setup/reason for your notification/email

Did this answer your question?