Symphony BDK core package
Symphony BDK Reference Documentation#
This reference guide provides detailed information about the Symphony BDK. It provides a comprehensive documentation for all features and abstractions made on top of the Symphony REST API.
If you are just getting started with Symphony Bot developments, you may want to begin reading the Getting Started guide.
The reference documentation consists of the following sections:
Getting Started: Introducing Symphony BDK for beginners
Migration guide: Migrating from BDK 1.x to BDK 2.0
Configuration: Configuration structure, formats, how to load from code
Authentication: RSA authentication, OBO authentication
Datafeed: Listening and reacting to real-time events
Activity API: Abstraction on top of the datafeed loop to ease consumption of datafeed events
Message service: Sending or searching messages, usage of templates
Stream service: Creating, searching streams, manage stream membership
Connection service: Managing connections between users
Signal service: Managing signals, subscribing/unsubscribing to signals
Presence service: Reacting and managing presences
Extending the BDK: How to use or develop BDK extensions
Information on how we generate client side code from swagger specs in the Generated API page.
Information about logging and logging configuration can be found in the Production Readiness page.