Custom user and event properties

The message builder includes predefined properties that you can use to customize your message content. These properties include the first and last name of the recipient or sender of a notification, a recipient's web login, localized date and time information about when an event began, and the event ID. You cannot modify these property types; when a notification is sent that includes these properties, xMatters replaces them with the appropriate value.

Personalize notifications with recipient and sender properties

Use the recipient and sender properties to personalize your messages with the first and last names of the users that either sent or will receive the notification.

When a notification is sent, xMatters replaces the sender property variables with values that match the message initiator, and the recipient property variables with values that match the recipient.

Provide the recipient with information on why they were notified

Users can receive notifications from multiple paths in xMatters, and may not always know why they're being notified. Use the Alert Context property in your message content to give the recipient an indication of why they were notified.

When the message is sent, xMatters replaces the property with the actual notification path.

Here are examples of what the recipient will see:

  • If the recipient was targeted directly (their target name was included in the list of recipients), the message displays "Direct Notification".
  • If the recipient was targeted as a member of a group (or a subgroup or dynamic team in the group), the message displays the path xMatters took in deciding to target that recipient, including the shift (for example, "Antares Service Support > Weekday AM" or "Antares Service Support > Weekend > Backup Support Group > Default").
  • If the recipient was targeted because they are subscribed to events, the message displays the subscription that caused them to be notified, including group and shift information if they were subscribed as part of a group (for example, "MIM Stakeholder Subscription > IR Team > Weekends").

Provide login information for new users

You can add a user's web login ID to your messages. This is useful if you want to send a personalized message to new users with instructions on how they can log into the system, and include the username they can use to log in. When the notification is sent, xMatters replaces this property with the recipient's web login ID. For companies with SAML enabled, the web login field displays the user's name identifier that they can use to log in to their Single Sign On application.

Include information about the event

Localized time and date information about the event

You can add event time and date properties to your message to inform recipients of the exact time an event started in xMatters. This is useful to let users know how long ago an incident occurred, especially if they were not on-call to receive the original event notification. When the notification is sent, xMatters replaces the date and time variables with values that match the event's starting time and date, in the recipient's local time zone.

Event ID

You can include the Event ID so that users can look up more information about the event in the Events Report. When the notification is sent, xMatters replaces the Event ID variable with the event's ID.

The following example displays a message built using a combination of the form, recipient, sender, event, and conference property types available in the message editor:

The resulting email message would look similar to the following:

Recipient, sender, and event properties are available in each message editor (email, text, and voice). You can add them to your messages by dragging them from the side panel to the desired location in the message editor. You can even add these properties to the Subject field of email notifications.

When you preview a message that includes event date and time properties, they are replaced with date and time values from when the preview was generated; these values are replaced with the actual start date and time of the event when it is initiated.