Discourse Configuration

Discourse community forum integration.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns the Discourse configuration

application/json

discourseConnectSecretstringRequired

Discourse Connect secret for SSO authentication

Example: ****

discourseApiKeystringRequired

Discourse API key for managing chat users and channels

Example: ****

betaChatEnabledbooleanRequired

Discourse Chat enabled for beta users

Example: true

chatEnabledbooleanRequired

Discourse Chat enabled

Example: true

chatBaseUrlstringRequired

Discourse base URL

Example: https://chat.example.com

get/tenants/{tenantId}/integrations/discourse

GET /apis/v2/tenants/{tenantId}/integrations/discourse HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Returns the Discourse configuration

{
  "discourseConnectSecret": "****",
  "discourseApiKey": "****",
  "betaChatEnabled": true,
  "chatEnabled": true,
  "chatBaseUrl": "https://chat.example.com",
  "_links": {
    "self": {
      "href": "text"
    }
  }
}

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

discourseConnectSecretstringOptional

Discourse Connect secret for SSO authentication

Example: ****

discourseApiKeystringOptional

Discourse API key for managing chat users and channels

Example: ****

betaChatEnabledbooleanOptional

Discourse Chat enabled for beta users

Example: true

chatEnabledbooleanOptional

Discourse Chat enabled

Example: true

chatBaseUrlstringOptional

Discourse base URL

Example: https://chat.example.com

Responses

200

Returns the updated Discourse configuration

application/json

discourseConnectSecretstringRequired

Discourse Connect secret for SSO authentication

Example: ****

discourseApiKeystringRequired

Discourse API key for managing chat users and channels

Example: ****

betaChatEnabledbooleanRequired

Discourse Chat enabled for beta users

Example: true

chatEnabledbooleanRequired

Discourse Chat enabled

Example: true

chatBaseUrlstringRequired

Discourse base URL

Example: https://chat.example.com

422

Returns an ErrorDto in case of validation errors or failures.

patch/tenants/{tenantId}/integrations/discourse

PATCH /apis/v2/tenants/{tenantId}/integrations/discourse HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "discourseConnectSecret": "****",
  "discourseApiKey": "****",
  "betaChatEnabled": true,
  "chatEnabled": true,
  "chatBaseUrl": "https://chat.example.com"
}

{
  "discourseConnectSecret": "****",
  "discourseApiKey": "****",
  "betaChatEnabled": true,
  "chatEnabled": true,
  "chatBaseUrl": "https://chat.example.com",
  "_links": {
    "self": {
      "href": "text"
    }
  }
}