Create Client Application

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.

SecurityoAuthClient

Request

Request Body schema: application/json

name required	string [ 1 .. 255 ] characters Unique name for client application
description	string [ 1 .. 1023 ] characters
active	boolean Default: true
required	Array of objects (Role) [ 1 .. 7 ] items

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/clientapplications

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"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"
}
}
]
}

Response samples

application/json

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