Disclosures extension

1Introduction

Some notices matter to the User whatever else a message says, such as an allergen warning or a regulatory notice. With this extension, a Company marks them as disclosures, apart from the rest of the message, so the Personal Agent can tell them from ordinary text.

This page defines version 1 of the disclosures extension. It uses the terms in the specification.

2Advertising support

A Company that sends disclosures lists the extension in extensions in its poppy.json (spec 3.3):

"extensions": {
  "disclosures": [{ "version": "1" }]
}

A Personal Agent that can show them declares it in Poppy-Extensions (spec 3.4):

Poppy-Extensions: "disclosures";v="1"

The Company sends disclosures only in response to a request that declares this version (spec 8.4). A Personal Agent that doesn't declare it gets the notice in text.

3Disclosures in messages

A Company message carries its disclosures in extensions.disclosures (spec 8.4):

{
  "id": "msg_p7Rt",
  "role": "company",
  "author": { "type": "agent" },
  "text": "The trail bar comes in boxes of 12 for $18.",
  "extensions": {
    "disclosures": {
      "items": [{ "text": "Contains peanuts. Made in a facility that also processes tree nuts." }]
    }
  }
}

Only Company messages carry disclosures. The JSON Schema is disclosures-content.schema.json.

The Personal Agent decides whether and how to show each disclosure, as it does for the rest of the message. Disclosures are content from the Company (spec 10.1). The guides describe when to show them.