diff --git a/images/incoming-webhook-example.png b/images/incoming-webhook-example.png new file mode 100644 index 0000000..b40f71e Binary files /dev/null and b/images/incoming-webhook-example.png differ diff --git a/index.html b/index.html index 7c152e8..c678c7d 100755 --- a/index.html +++ b/index.html @@ -134,7 +134,7 @@
node.js JavaScript library

REST API

RESTful API
-

Best suited for bots or server-side web application. No WebRTC support. Webhooks for events coming soon.

+

Best suited for bots or server-side web application. No WebRTC support.

diff --git a/jssdk-interactiveforms.html b/jssdk-interactiveforms.html new file mode 100644 index 0000000..ec0827a --- /dev/null +++ b/jssdk-interactiveforms.html @@ -0,0 +1,72 @@ + + + + + + + + + + Circuit API Examples + + + + + + +
+ + + + + +
+
+ +
+
+

Interactive Forms

+

+ Using the JS SDK, iOS SDK or Rest API, you can add interactive forms to a Circuit conversation.
+ With forms, you can add buttons or radio and input fields to your messages.
+
+ Interactive Form Example +

+ Whether you are developing a bot or an app, you can display the form to the conversation and collect the answers from one or several participants.
+ You can then decide to update the message based on the user's feedback.
+

+

+ The documentation on interactive forms can be found on github. +

+
+
+ +
+
+ +
+ + + + + + + + + + diff --git a/jssdk.html b/jssdk.html index d18d60d..0d95cdd 100755 --- a/jssdk.html +++ b/jssdk.html @@ -31,7 +31,7 @@

JavaScript SDK

When running the examples you will be asked to sign in with a Circuit sandbox account.

- API Documentation + API Documentation GitHub

Example to logon and fetch conversations:

@@ -96,6 +96,28 @@ 
Plunker examples
+ +
+
+

Stackblitz examples

+

Short examples demonstrating one or more particular APIs. You can view the source, or fork your own stackblitz. A sandbox account is required to run the live examples.

+ + + + + + + + + + + + + + +
Live ExampleDescription
Export conversations to filevuejs app to export all conversation messages to a file.
+
+
diff --git a/oauth.html b/oauth.html index 868ed8e..3109ae5 100644 --- a/oauth.html +++ b/oauth.html @@ -116,6 +116,22 @@
Step 1: Application Requests Authorization Code
Any string Provides any state that might be useful to your application upon receipt of the response. The Circuit Server roundtrips this parameter, so your application receives the same value it sent. To mitigate against cross-site request forgery (CSRF), it is strongly recommended to include an anti-forgery token in the state, and confirm it in the response. This parameter is not required but strongly recommended for above mentioned security reasons. + + login_hint + email + Optional. If your application knows which user is trying to authenticate, it can use this parameter to provide a hint to the Circuit Authentication Server. The server uses the hint to simplify the login flow by prefilling the email field in the sign-in form. + + + prompt + comma delimited string + Optional. A comma-delimited (no spaces), case-sensitive list of options for the oauth window. + + + @@ -270,6 +286,22 @@
Step 1: Application Requests Authorization Code
Any string Provides any state that might be useful to your application upon receipt of the response. The Circuit Server roundtrips this parameter, so your application receives the same value it sent. To mitigate against cross-site request forgery (CSRF), it is strongly recommended to include an anti-forgery token in the state, and confirm it in the response. + + login_hint + email + Optional. If your application knows which user is trying to authenticate, it can use this parameter to provide a hint to the Circuit Authentication Server. The server uses the hint to simplify the login flow by prefilling the email field in the sign-in form. + + + prompt + comma delimited string + Optional. A comma-delimited (no spaces), case-sensitive list of options for the oauth window. + + + diff --git a/sidebar.html b/sidebar.html index ec61a74..c9aa763 100644 --- a/sidebar.html +++ b/sidebar.html @@ -20,6 +20,9 @@

Start

Build