Skip to main content


An application configures the set of ChatKitty resources related by an application ID and API key.

A ChatKitty application is needed to create users, channels, messages, etc. and interact with ChatKitty on behalf of your app.


If you have multiple deploy environments like development, staging, production, etc., we recommened a application per environment to isolate data.


integer <int64>

64-bit integer identifier associated with this resource

string <date-time>

ISO date-time this application was created


Primary API key assigned to this application


Custom properties attached to this application

Array of objects (Link)

Hypermedia control links for this resource


Creating an application

Create an application using the ChatKitty dashboard.

Application OAuth V2 credentials

ChatKitty expects a valid OAuth V2 Bearer access token issued on behalf of an application, using the client credentials flow to be included in all API requests related to the application.

Retrieve the OAuth V2 client ID and client secret needed to issue access tokens from the Dashboard, from the settings page.

Retrieving the authenticated application

To get the application authenticated, use the Platform API:

GET /v1/application
curl -X 'GET' \
'' \
-H 'accept: application/json' \
-H 'Authorization: Bearer ACCESS-TOKEN'

Retrieving application settings

To get the current setting for an application, use the Platform API:

GET /v1/application/settings
curl -X 'GET' \
'' \
-H 'accept: application/json' \
-H 'Authorization: Bearer ACCESS-TOKEN'

Update application settings

You can change your application's configuration by updating the application's settings.

Using the Platform API:

PUT /v1/application/settings
curl -X 'PUT' \
'' \
-H 'accept: application/json' \
-H 'Authorization: Bearer ACCESS-TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"guestUsers": "DISABLED",
"userCreatedChannels": "DISABLED"

Using the Dashboard Dashboard screenshot: update application settings

See also