Skip to content
Conversation APIs
/
Conversation Manager
/
/Client Application

Client Application

Use this API to register external client applications where we send and receive messages.

Operations

Create Client Application

Request

Overview

API to register new Client Applications that can integrate with the Conversation Hub. Client applications are used to send and receive messages. New Account API process flow: Authenticiation > Client Application > Participant > Channel > Orchestration > Account

Scope

Client application must have 'app.conversation.conversationmgr.manage' scope assigned.

Security
oAuthClient(Required scopes:
https://api.egain.cloud/auth/.de...
)
Bodyapplication/json

Register new client application

namestring, [ 1 .. 255 ] charactersrequired

Unique name for client application

descriptionstring, [ 1 .. 1023 ] characters
activeboolean
Default:true
rolesArray of objects, [ 1 .. 7 ] items(Role)required
POST
/clientapplications
curl -i -X POST \
  https://api.egain.cloud/conversation/conversationmgr/v3/clientapplications \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "custom_bot_client_application_1",
    "description": "Client app for Eva bot",
    "active": true,
    "roles": [
      {
        "name": "custom_bot",
        "version": "v3",
        "callback": "https://example.support.com/messaging/customBot",
        "notificationEmail": "client_app_admin@example.com",
        "headers": [
          {
            "name": "X-custom-header",
            "value": "xyz"
          }
        ],
        "authentication": {
          "id": "34fbb53f-ed7f-48d4-b545-e26cc95e075d"
        }
      }
    ]
  }'

Responses

Created

Bodyapplication/json
idstring, = 36 characters

UUID generated for the object.

Response
{
  "id": "9e1d7993-cc82-4d5f-a193-0d6b0d48a959"
}