Actions

  • This document outlines the schema for defining Actions within a project, including custom actions, engagement mechanisms, and supporting features.

  • Actions can be customized by mapping intents to specific functionalities and configuring engagement features like push notifications and daily updates.

  • Engagement features allow users to subscribe to updates and are controlled through settings like titles and notification preferences.

  • Assistant Links enable deep linking into specific actions, providing a streamlined user experience.

  • The schema utilizes YAML for representation and provides detailed descriptions for each field and its purpose.

Represents the list of Actions defined in a project.

YAML representation 
custom: 
  string: object (CustomAction)
Fields
custom

map (key: string, value: object (CustomAction))

Map from intents to custom Actions to configure invocation for the project. The invocation intents could either be system or custom intents defined in the "custom/intents/" package. All intents defined here (system intents & custom intents) must have a corresponding intent file in the "custom/global/" package.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CustomAction

Details regarding a custom action.

YAML representation 
engagement: 
  object (Engagement)
Fields
engagement

object (Engagement)

Engagement mechanisms associated with the action to help end users subscribe to push notifications and daily updates. Note that the intent name specified in daily updates/push notifications slot config needs to match the intent corresponding to this action for end users to subscribe to these updates.

Engagement

Defines the engagement mechanisms associated with this action. This allows end users to subscribe to push notification and daily update.

YAML representation 
title: string
pushNotification: 
  object (PushNotification)
actionLink: 
  object (ActionLink)
assistantLink: 
  object (AssistantLink)
dailyUpdate: 
  object (DailyUpdate)
Fields
title

string

The title of the engagement that will be sent to end users asking for their permission to receive updates. The prompt sent to end users for daily updates will look like "What time would you like me to send your daily {title}" and for push notifications will look like "Is it ok if I send push notifications for {title}". This field is localizable.
pushNotification

object (PushNotification)

Push notification settings that this engagement supports.
dailyUpdate

object (DailyUpdate)

Daily update settings that this engagement supports.

PushNotification

Defines push notification settings that this engagement supports.

DailyUpdate

Defines daily update settings that this engagement supports.