Returns the direct-messaging configuration alongside the realtime socket credentials used by the chat client.

Fails with a message asking for an update when the installed Fluent Messaging plugin is too old to expose the config helper.

Endpoint

• Method: GET

• Path: /admin/messaging-setting

• Edition: PRO

• Controller: ProAdminController@getMessagingSettings

• Route source: fluent-community-pro/app/Http/Routes/api.php:21

• Controller source: fluent-community-pro/app/Http/Controllers/ProAdminController.php

• Requires the FluentCommunity community-admin permission (or a WordPress super admin).

• Requires FluentCommunity Pro and the Fluent Messaging plugin.

Live sample

The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.

GET Get Messaging Settings

GET

/admin/messaging-setting

Returns the direct-messaging configuration alongside the realtime socket credentials used by the chat client.

Controller: ProAdminController@getMessagingSettings
Route source: fluent-community-pro/app/Http/Routes/api.php:21

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type

API Key (header: Authorization)

Responses

Successful response

Content-Type

application/json

{

  

"settings": {

  

  

"messaging_email_frequency": "string",

  

  

"messaging_email_status": "string",

  

  

"points_to_initiate_message": 0,

  

  

"realtime_enabled": "string",

  

  

"socket_provider": "string",

  

  

"who_can_initiate_message": "string"

  

},

  

"socket_config": {

  

  

"appId": "string",

  

  

"cluster": "string",

  

  

"is_defined": true,

  

  

"key": "string",

  

  

"options": {

  

  

  

"host": "string",

  

  

  

"port": 0,

  

  

  

"scheme": "string",

  

  

  

"useTLS": true

  

  

},

  

  

"provider": "string",

  

  

"secret": true

  

}

}

GET

/admin/messaging-setting

Playground

Authorization

ApplicationPasswords

Samples

Powered by VitePress OpenAPI