Microsoft Teams Bot icon

Microsoft Teams Bot

Use Bot Framework conversation and activity APIs for Microsoft Teams bots

Proactive → Get Reference

AI-generated

Summary

Retrieve a stored proactive reference by its key from the internal reference store to facilitate sending proactive messages.

Inputs

  • Reference Key (required) — Key used to look up the stored proactive reference.
  • Execution Options — Optional parameters to control debug output, output data shape, and retry behavior.

Output shape

a single JSON object containing the reference key and the corresponding proactive reference data (empty if key not found).

The operation returns data from a local static store within the workflow environment, not from an external API. If the reference key does not exist, the reference field will be an empty object. Execution Options allow controlling retries and output formatting (pass-through, merge, or response only). No pagination is involved.

Examples

Example 1: Get a proactive reference to use for sending a proactive message later.

Set the 'Reference Key' parameter to the exact key string used when the reference was stored; optionally configure execution options for debug or output mode.

Links

Discussion