Applications and webhooks
Console client configuration · Response and shared models
Applications belong to the signed-in account. Creation returns appSecret only once. updateConfig replaces the complete config object; read and merge the existing configuration before changing selected fields.
updateWebhook accepts webhookUrl, subscribedEvents, and rotateSecret. A nonempty URL requires at least one event. An empty URL clears the callback and removes its signing secret. webhookSecret is returned only when setting or rotating the secret. See webhooks for events and verification.
apps.list
List applications.
GET /v1/apps
Authentication: tenant Bearer token.
| Language | Call |
|---|---|
| Node.js | c.apps.list() |
| Python | c.apps.list() |
| Java | c.apps.list() |
| Go | c.Apps.List(ctx, &result) |
| PHP | $c->apps->list() |
No request fields.
Returns: AppRecord[]. See shared models for nested fields.
apps.get
Get application.
GET /v1/apps/detail
Authentication: tenant Bearer token.
| Language | Call |
|---|---|
| Node.js | c.apps.get(input) |
| Python | c.apps.get(**input) |
| Java | c.apps.get(input) |
| Go | c.Apps.Get(ctx, input, &result) |
| PHP | $c->apps->get($input) |
Input: AppIdInput. Fields are sent as URL query parameters.
| Field | Required | Type | Description |
|---|---|---|---|
appId | Yes | string | Target application ID |
Returns: AppRecord. See shared models for nested fields.
apps.create
Create application.
POST /v1/apps
Authentication: tenant Bearer token.
| Language | Call |
|---|---|
| Node.js | c.apps.create(input) |
| Python | c.apps.create(**input) |
| Java | c.apps.create(input) |
| Go | c.Apps.Create(ctx, input, &result) |
| PHP | $c->apps->create($input) |
Input: CreateAppPayload. Fields are sent in the JSON body.
| Field | Required | Type | Description |
|---|---|---|---|
name | Yes | string | Application or classroom name |
environment | No | AppEnvironment | undefined | Application environment |
config | No | Record<string, unknown> | undefined | Complete replacement application configuration |
Returns: AppRecord. See shared models for nested fields.
apps.updateConfig
Replace application configuration.
PATCH /v1/apps/config
Authentication: tenant Bearer token.
| Language | Call |
|---|---|
| Node.js | c.apps.updateConfig(input) |
| Python | c.apps.update_config(**input) |
| Java | c.apps.updateConfig(input) |
| Go | c.Apps.UpdateConfig(ctx, input, &result) |
| PHP | $c->apps->updateConfig($input) |
Input: UpdateAppConfigInput. Fields are sent in the JSON body.
| Field | Required | Type | Description |
|---|---|---|---|
config | Yes | Record<string, unknown> | Complete replacement application configuration |
appId | Yes | string | Target application ID |
Returns: AppRecord. See shared models for nested fields.
apps.updateWebhook
Configure webhook and signing secret.
PATCH /v1/apps/webhook
Authentication: tenant Bearer token.
| Language | Call |
|---|---|
| Node.js | c.apps.updateWebhook(input) |
| Python | c.apps.update_webhook(**input) |
| Java | c.apps.updateWebhook(input) |
| Go | c.Apps.UpdateWebhook(ctx, input, &result) |
| PHP | $c->apps->updateWebhook($input) |
Input: UpdateWebhookInput. Fields are sent in the JSON body.
| Field | Required | Type | Description |
|---|---|---|---|
webhookUrl | Yes | string | Webhook URL; empty string clears callback and signing secret |
subscribedEvents | No | string[] | undefined | Subscribed event types |
rotateSecret | No | boolean | undefined | Rotate webhook signing secret |
appId | Yes | string | Target application ID |
Returns: UpdateWebhookResult. See shared models for nested fields.