Tokens in Proactive Prompts

  • Release version: Zurich
  • Updated July 31, 2025
  • 1 minute to read

    • Token placeholders indicate the data that will be replaced during runtime.

    When creating a signal, the message displayed to the user is written in the Single record display and Multiple record display fields. Use tokens in these messages to indicate data that will be replaced dynamically during runtime. For example, the message "Hey ${receiving_user}, looks like ${user_count} members in your team haven't taken PTO in the last quarter" will be displayed as "Hey Abel Tuter, looks like 2 members in your team haven't taken PTO in the last quarter".

    Types of Tokens

    • receiving_user: Name of the recipient of the prompt.
    • user_name: Name of the employee.
      Note:
      If the recipient is the manager and only one employee under that manager qualifies for the signal, use the employee's name directly with this token.
    • user_count: Count of employees under the manager that qualify for the signal.
    • item_count: Count of records belonging to the employee that qualified the signal.
    • item: If only one record belongs to the employee that qualifies the signal, the value in the Display field of the data source is stored in this token.
    • score: The score used in the threshold evaluation.
    Note:
    * indicates that tokens can only be used when the Collect records field is selected.
    Table 1. Tokens for prompt templates
    Data source type Persona Tokens (Single record) Tokens (Multiple records)
    Simple Manager None receiving_user, user_count
    Aggregate as count Manager receiving_user,item_count, user_name receiving_user, user_count
    Aggregate as none Manager receiving_user,item_count, user_name receiving_user, user_count
    Script Manager receiving_user,item_count*, user_name receiving_user, user_count
    Performance Analytics Indicator Manager receiving_user,score, item_count*,user_name receiving_user, user_count
    Simple Employee
    Aggregate as count Employee receiving_user,score, item* receiving_user, item_count
    Aggregate as none Employee receiving_user, score, item* receiving_user, item_count
    Script Employee receiving_user, score, item* receiving_user, item_count*
    Performance Analytics Indicator Employee receiving_user, score, item* receiving_user, item_count*