Embed FAQs
1. Do we save the data of third-party applications that embed viaSocket?
No, viaSocket only saves the data that is necessary for debugging purposes. This includes:
Authentication tokens: We store user authentication tokens to ensure proper functionality and secure connections with third-party applications.
Flow logs: These are saved temporarily to track and troubleshoot any issues. However, this feature can be disabled if you prefer not to store flow logs.
We do not retain any unnecessary data beyond what is required for proper operation and debugging.
2. Is there an SDK or API available for the integration?
Yes, viaSocket provides both an SDK and an API for integration. You can access the necessary script and API directly through the embed configuration, allowing seamless integration with your application. The script and API are designed to give you full flexibility in embedding and customizing workflows.
3. Are there specific requirements or dependencies (e.g., libraries or frameworks) for integrating ViaSocket?
Yes, viaSocket requires a JWT-based token for integration. To handle authentication and manage token security, you'll need libraries or frameworks that support JWT (JSON Web Tokens). These libraries will help you generate, verify, and manage tokens for secure communication between your app and viaSocket. You can use popular JWT libraries like jsonwebtoken for Node.js or PyJWT for Python, depending on your technology stack.
4. Can viaSocket be embedded in different ways (e.g., widgets, iframes, API-based)?
Currently, viaSocket can only be embedded using an iframe. We provide a script for easy integration of the iframe into your application.
Additionally, viaSocket offers APIs for listing flows, apps, and their actions on the UI. These APIs allow you to directly create flows or direct users to previous flows, providing flexibility in how you manage and control the user experience within your app.
5. How is user authentication managed when embedding viaSocket (OAuth, SSO, custom authentication)?
When integrating viaSocket, user authentication is managed using a JWT-based token. The client (the service embedding viaSocket) passes this token as part of the embed settings. The token includes essential user-specific details such as:
user_id
email (optional)
name (optional)
Any custom metadata you wish to include
viaSocket verifies the JWT token using a shared secret to ensure its authenticity. Once the token is verified, the user is automatically logged in, eliminating the need for a separate login process. This provides a seamless, secure, and SSO-like experience for the user within the embedded viaSocket environment.
