Overview of Symphony Elements

Symphony Elements lets you reuse our standard UX component libraries to create rich workflows for your bots, without having to worry about complicated code and UI design.

Send bot messages that contain interactive forms with pre-designed text fields, dropdown menus, person selectors, buttons and more. Interactive forms allow messages to evolve in response to actions by users.

Elements provides developers with out-of-the-box tools to easily create interactive bot messages that look and feel like they belong in Symphony.


Availability & known limitations

General Limitations

  • User replies are not processed by DLP (Data Loss Prevention).
  • In read-only rooms, only the owners of the room are able to interact with Symphony Elements. For non-owner users, messages with Elements will be disabled.

Symphony Elements GA (General Availability)

  • It is only available on pods that have been updated to 20.3.1 and running an Agent 20.3.1 (2.57.0) or above.
  • It is allowed to be displayed in cross-pod rooms.
  • Forms and their responses are exported in Content Export.
  • Our iOS application (versions 1.56.0 and above) fully supports Symphony Elements.
  • Our Android application fully supports Symphony Elements with Agent version 2.57.0 and above.

Symphony Elements Beta

  • It is only available on pods that have been updated to 1.55.3 and running an Agent 2.55.9 or above.
  • It cannot be sent cross-pod.
  • Responses are not captured in Content Export.

Note: These limitations are temporary ā€“ they may change in the future.

The Elements

Symphony Elements is a library of pre-designed reusable UX components (text fields, dropdown menus, person selectors, buttons and more). You can use the Elements to create forms that enable Symphony users to interact graphically with bot messages.

The Available Elements guide describes each UX component, how to use them, and provides examples.

Symphony Elements x SDKs

With the upgrade to Symphony v20.3, any bot or application that utilizes Elements requires that customers have the Agent upgraded to 2.57.x, and also to confirm the SDK used to build the bot or application supports the new Elements payload. The Symphony-supported SDK versions are:

ā€¢ Java SDK 1.1.1 or later
ā€¢ Python SDK 1.1.0 or later
ā€¢ NodeJS 1.1.1 or later

For customers who have developed their own SDK or have incorporated a third-party SDK, you must ensure that the SDK supports the modified JSON payload response. This is detailed in the Symphony API Specification located here https://github.com/symphonyoss/symphony-api-spec/blob/20.3.1/agent/agent-api-public.yaml#L3643.

Symphony Elements with Cards

With Symphony v20.5, the usage of cards with Symphony Elements became possible. For more information, refer to Available Elements.

Updated 2 months ago

Overview of Symphony Elements

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.