Welcome
Guest
FAQ Forum Developers Sign In

Adding a bot app in a domain

Last updated:

A bot is a server-side app designed to interact with Circuit users via conversation and is built using Circuit APIs.

Prerequisites:
  • You are the administrator of the domain or a user with developer read/write access rights.

  • You have enabled the OAuth Apps - Create/Edit capability feature in Circuit Labs.

  • There bot app limit has not been reached. You can see the limit and the already created apps in OAuth Apps tab.

As a domain administrator, you can add a bot app in the domain and create the bot user associated with it. Circuit uses OAuth 2.0 for authentication and authorization and supports most common OAuth 2.0 scenarios.

  1. On the web client and Desktop App, click your user name, and then click Administration.
  2. Click the OAuth Apps tab.
  3. Click Create.
  4. In the window that pops up, click on the arrow in the Bot frame for client credentials.
    Note:

    If the maximum number of bots has been reached, the option to create a bot app is disabled.

  5. In the Create Bot window enter necessary information for Bot name, Description, Bot email address, Scopes, and Time to live.

    In Scopes you can specify the various permission levels the app can request. The default value is All.

    Time to live is the maximum time that the access token remains valid. The default value is Forever.

  6. When you finish entering information, click Add.

After creation, a screen appears with the Client ID, the unique identifier of the app that should be provided to the application developer.

This screen contains also the Client secret, the secret key for the app.The client secret is securely stored in server side and cannot be revealed.
Note:

The client secret appears the first time in this screen. If you go back to the app list and return later to this screen, the client secret is not shown.

7 people found this useful.
Me too / Not at all