Skip to main content

Hint

Hint is the message template for a hint message.

Basic usage​

Hint renders centred and understated in the chat interface. It is typically used for a change of system state, a confirmation, or a supporting note.

warning

Limitation: Hint does not support quickReplies. Setting them has no effect.

Template structure​

JSON​

{
  "type": "HINT",
  "text": "Switched to Taipei Xinxin Showtime"
}

Properties​

type (required)​

The message template's type, always "HINT".

text (required)​

The hint's text. Keep it short and plain.

Examples​

To send a hint from Push Message:

  1. Choose Expression in the Template field's dropdown.
  2. Enter the following JavaScript in the editor.

A change of system state​

(() => {
  return {
    type: 'HINT',
    text: 'Switched to the Taipei Xinyi store',
  };
})()

Confirming an action​

(() => {
  return {
    type: 'HINT',
    text: 'Your order has been created',
  };
})()

A change of session state​

(() => {
  return {
    type: 'HINT',
    text: 'Connected to a human agent',
  };
})()

Introducing a capability​

(() => {
  return {
    type: 'HINT',
    text: 'You can send an image and I will analyse it for you',
  };
})()