From 37c3b493f34e3b723da0c3f7eae19e72a9805f3c Mon Sep 17 00:00:00 2001 From: Jeremy LaCivita Date: Mon, 4 Dec 2023 13:36:59 -0500 Subject: [PATCH] added example message --- requirements/specifications/intents/index.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/requirements/specifications/intents/index.md b/requirements/specifications/intents/index.md index 6636c5804..c98dce3f6 100644 --- a/requirements/specifications/intents/index.md +++ b/requirements/specifications/intents/index.md @@ -68,6 +68,24 @@ When an intent is sent to a Firebolt device from some other system, e.g. a cloud An intent message **MUST** have an `intent` object property that is the intent being passed. +An example intent message: + +```json +{ + "type": "xrn:firebolt:intent:app:launch", + "appId": "Netflix", + "intent": { + "action": "launch", + "context": { + "source": "voice" + } + }, + "metadata": { + "foo": "bar" + } +} +``` + ### 6.1. App Intent Message If an intent is targeting a specific app, then the intent message **MUST** have an `appId` string property with the appId of the targeted app.