Documentation Updates

Our documentation is continually updated with new topics, and corrections or clarifications made to existing content. Check back every now and then, to see what is new!
Also, visit the Change Log to know more about the major Symphony updates.
Since November 2021, the developer portal is not divided in release versions any more and it contains latest information on a single environment. The change logs are gathered as subpages of each impacted product so that developers still have access to its history and know which features are introduced in their new version of any Symphony product impacting the developer journey.
Please note that our REST API reference documentation is still divided into release versions, and you can navigate through these to have the adhoc endpoints request/payload rules to your deployed Agent/SBE version.
In this page, you will find the main updates/announcements of the developers portal documentation changes, as well as the historical changes corresponding to each version from our old documentation system.
Documentation Updates
2022
February 2022
Extension Apps: removed documentation of addMenuItem() method in modules service after deprecation of client 1.5, as this method is not anymore supported in the client 2.0.
January 2022
New design of the REST API reference. From now on,
APIs are grouped as subsections of various different topics like Messages, Streams, Datafeed, etc.
Each API reference will be presented on a single and separated page from the other APIs,
You will be able to dynamically generate code in real time and in your preferred language thanks to the parameters presented at the bottom of each API reference page,
Please note that some links you have saved might be broken, due to the apis being referenced as pages instead of sections from the restapi doc (i.e.: https://developers.symphony.com/restapi/reference#messages-v4 becomes https://developers.symphony.com/restapi/reference/messages-v4).
Please note that this new design is mainly supported on 20.13 and later versions.
2021
November 2021
Rework of the Messages documentation for it to be clearer for developers. It is now divided in MessageML and PresentationML; MessageML contains the following sections: MessageML Basics, Interactive Elements Forms, Extensibility UI Actions, and Entities; each of these subsections contains the corresponding specifications and examples helping our developer community to construct messages.
The developer portal has been updated to a single environment: it is not divided in release versions any more and the change logs are now divided by products.
Historical general updates
Removed the limitation of DLP scanning formReplies on the Overview of Symphony Elements​
Added the information that only PKCS8 format is allowed for the key of the UserKeyRequest Object​
New Agent Performance Tuning guide available.
Added limitations on the Overview of Symphony Elements:
The form is reset when the page is refreshed and the enduser is able to send a new reply.
New Elements features are generally not supported by pods running an older client version than the one where they have been introduced (i.e. for XPod use cases)
Added a section "Versions and Compatibility" on each Available Element documentation, which gathers the versions in which main features of the considered Element were introduced, and which outcome can be expected from it in previous Client version, for the purpose of using it in XPod use-cases for example.
Updated <ul> and <ol> tags documentation under Message Format - MessageML​
Added a description of Datafeed 2.0 (versus its previous version Datafeed 1.0) and its support in the agent. See Introduction to datafeed​
​Agent 2.X and above installation has been updated to fix the threaddump endpoint path
API Reference updates:
​Stream Members - updates for example and xPod use case
​Create Company Certificate - example for 200 payload updated
​SBE x Agent compatibility matrix is now mentioned and linked for all agent endpoints from the API reference for more clarity
​Create Protocol - example for 200 payload updated
​V3 Message Violations - example for 200 payload updated
​Update Room v3 - attributes information panel were updated
​Create Message v4 - updated attachment limits
Updated the User Attributes Object and therefore its impacts on the endpoints Create User v2 / Update User v2 / Search Users​
The endpoint Subscribers documentation has been updated to highlight both default and maximum values for the parameter "limit"
Historical Documentation Changes
Changes introduced in 20.12
This section contains the main changes that occurred in the v20.12 version of the documentation.
New tutorial pages, overviews, and guides
No tutorial pages, overviews, nor guides have been added to the Symphony Platform documentation for v20.12.
API References
The following list shows the endpoints that have been updated or added to the API Reference documentation to include the changes according to the Change Log:
Updated: 
​Suppress Message endpoint
​POST and GET Message Search endpoints
Deprecated:
​Health Check v2 endpoint was deprecated.
Firehose v2 endpoints were removed.
Other Changes
Updated Extension App Documentation to add the specification of adding default value to the share service​
Updated MessageML Format to highlight the message size limit
Added the documentation of three new Elements: Date Picker, Time Picker, and Timezone Picker​
Changes introduced in 20.10
​
This section contains the main changes that occurred in the v20.10 version of the documentation.
New tutorial pages, overviews, and guides
No tutorial pages, overviews, nor guides have been added to the Symphony Platform documentation for v20.10.
API References
The following list shows the endpoints that have been updated or added to the API Reference documentation.
​Get Message IDs by Timestamp has been moved to deprecated endpoints starting with version 20.10.
Other Changes
Updated Extension App Documentation to add the specification for openIM in the UI Service​
Updated element count limitation (increased up to 50) for Checkbox and Radio Button​
Changes introduced in 20.9 (1.62)
This section contains the main changes that occurred in the v20.9 version of the documentation.
New tutorial pages, overviews, and guides
No tutorial pages, overviews, nor guides have been added to the Symphony Platform documentation for v20.9.
API References
The following list shows the endpoints that have been updated or added to the API Reference documentation.
​Blast Message - added
​Follow User - added
​Unfollow User - added
​List User Followers - added
​List Users Followed - added
​User Attributes Object - some attributes were added (impacts on the endpoints Create User v2 / Update User v2 / Search Users)
Other Changes
Updated Overview of Symphony Elements documentation for the examples to use Client 2.0 rendering instead of Client 1.5.
Updated Text Field, Masked Text Field, Text Area, Person Selector, and Dropdown Menu documentation in order to guide on how to use label and title attributes.
Updated MessageML Format guide on how to use the expandable-card tag in messageML.
Changes introduced in 20.7 (1.61)
This section contains the main changes that occurred in the v20.7 version of the documentation.
New tutorial pages, overviews, and guides
No tutorial pages, overviews, nor guides have been added to the Symphony Platform documentation for v20.7.
API References
The following list shows the endpoints that have been updated or added to the API Reference documentation.
​Users Lookup and Search Users documentation have been updated to add a note regarding information not returned in case of cross-pod search.
​Read Messages/Events Stream under Datafeed: added a note regarding the use of emojis' shortcode.
​Suspend User Account: documentation has been added for this new endpoint.
General updates
There was no other page update for v20.7.
Changes introduced in 20.6 (1.60)
General updates
The following list shows the pages that have been updated:
Symphony Elements:
Elements: added information about using Elements with cards.
Text Field, Text Area and Masked Text Field: added the new pattern and pattern-error-messageattributes. Also, the gif images have been updated in order to show the new design of the error messages.
Buttons: added the new class attribute which allows bot developers to use the new palette of colors primary, secondary, tertiary and destructive. The classes primary-destructive and secondary-destructive are however deprecated.
​Regular Expressions - Regex: new page added in order to help bot developers to securely validate input data. This page describes what a regular expression is (shortened as regex) and how to add the validation to Symphony Elements.
API References
Updates on our API Reference documentation.
​Update User Avatar: added a note stating that this API allows the current user also to update its own avatar.
​User Lookup: added the new active parameter.
​Demote Owner: changed the API payload sample.
​Datafeed 2.0: added documentation regarding Datafeed 2.0 including a small introduction and the endpoints added in the agent to support it.
Changes introduced in 20.5 (1.59)
This section contains the main changes that occurred in the v20.5 version of the documentation.
General updates
The following list shows the pages that have been updated:
Line breaks ('\n') are now allowed in the Text Area Element.
The Change Log page has been moved from the REST API Guide to the Developer Guide.
The Documentation Updates page has been moved from the REST API Guide to the Developer Guide.
The RSA Bot Authentication Workflow page has been moved from the REST API Guide to the Developer Guide.
The Bot Authentication Workflow page has been moved from the REST API Guide to the Developer Guide.
PresentationML Live Renderer Tool: fixed an issue that when clearing the rendering of the live preview was returning the chosen theme (dark) to the default status (light).
Changes introduced in 20.4 (1.58)
This section contains the main changes that occurred in the v20.4 version of the documentation.
API References
The following list shows the endpoints that have been updated or added to the API Reference documentation.
​Share v3: the description of the publishDate field now states that the article publish date in unix timestamp is in seconds.
​Users Lookup v3: added a note saying that the department and location fields are returned only if the user is an internal user of the current pod.
​List IB Groups: added a note showing that the API returns only IB Groups that have at least one policy associated with it.
​Message Metadata: now the endpoint does not show null fields returned in the response sample.
General updates
The following list shows the pages that have been updated:
​Symphony Elements - Buttons: the description of the type attribute has changed. Now, it says that the reset button resets the form-data to its initial values.
​Suppress Message: Added suppressed message examples.
​PresentationML Live Renderer Tool: corrections performed on the rendering of cards and in the live preview.
Changes introduced in 20.3 (1.57)
This section contains the main changes that occurred in the v20.3.x (1.57) version of the documentation.
New tutorial pages, overviews, and guides
The following list shows tutorial pages, overviews, and guides that have been added to the Symphony Platform documentation:
​SBE x Agent Compatibilities: page created in order to show the compatibility between the Agent and SBE versions.
API References
The following list shows the endpoints that have been updated or added to the API Reference documentation.
​Users Lookup v3: the accountType field has been added to the response sample.
​Search Users: the accountType field has been added to the response sample.
​Create Room v3: The following note has been added: "viewHistory, discoverable and membersCanInvite attributes cannot be false if public=true.
​Message Search - POST: Added a note stating that search terms cannot contain the following reserved characters: colon :, parentheses ( ), and whitespaces.
​Message Search - GET: The following information has been added to the text argument: Multi-word search is allowed. Syntax: text:"Hello world".
​Health Check v3 and Health Check Extended v3: New endpoints.
​Create Application, Create Application with an RSA Public Key, Update Application and Update Application with an RSA Public Key: The notification object has been added to the APIs.
​Create Connection: The following information has been added to the API page: "Only one connection request is allowed between two users. When this limit is exceeded, no more connections requests are allowed. A new connection request will be allowed only if the user that received the connection request declines it."
​Add Member: The following recommendation has been added: "For rooms with more than 500 users, members should be added/deleted 1 member every "3 seconds" to allow key management functions time to process."
​Search Rooms v3:
The description of the active and private body parameters has changed.
The multilateralRoom parameter has been added to the response sample.
​Malware Scanner APIs: The following APIs have been added:
​File Malware Scanner State.
​Update File Malware Scanner State.
​Customer Malware Scanner APIs: The following APIs have been added:
​Malware Scanner Health.
​File Malware Scanner.
​Suppress Message: Added suppressed message examples.
General updates
The following list shows the pages that have been updated:
​Agent 2.X and above Installation:
The Enforce TLS 1.2 option has been added to the Modify Startup Script Configuration.
Added a table containing flags showing the available actuator endpoints for the Agent application.
​Real Time Events: added the User Requested to Join Room event.
​Symphony Elements Action: the event payload returned by the Datafeed has changed. The attribute actionStream has been removed and the formStream attribute has been renamed to stream.
​Permissions: the following list shows what has changed on the Permissions page:
The ACCESS_ADMIN_API and the VIEW_PRIVILEGED_USER_AUDIT_TRAIL privileges have been added to the Audit Trail Management role.
The Cep Visibility Group Management role with the MANAGE_CEP_VISIBILITY_GROUPS permission has been added to the page.
The VIEW_USER_DETAIL privilege has been added to the following roles:
Administrator
Compliance Officer
Content Management
EF Policy Management
Key Manager
L1 Support
L2 Support
Scope Management
Super Administrator
Super Compliance Officer
Symphony Admin
User Provisioning
Symphony Elements
​Text Fields: the following information has been added: "The text field cannot have children tags but it can have a default text (initial value) between the tags".
​Overview of Symphony Elements: new information related to Symphony Elements GA has been added to the Availability & known limitations section. We also added more information about the limitation with read-only rooms.
Client 2.0 - 20.4
Next - Admin Guides
API Change Management
Last modified 4mo ago
Copy link
Contents
Documentation Updates
2022
2021
Historical general updates
Historical Documentation Changes
Changes introduced in 20.12
Changes introduced in 20.10
Changes introduced in 20.9 (1.62)
Changes introduced in 20.7 (1.61)
Changes introduced in 20.6 (1.60)
Changes introduced in 20.5 (1.59)
Changes introduced in 20.4 (1.58)
Changes introduced in 20.3 (1.57)