Runtime configuration

Configure runtime settings in Tiptap Collaboration to manage your collaboration environment directly via the REST API.

These settings let you modify secrets, webhook URLs, and more, particularly when adapting to changes in your project requirements or security protocols, without restarting your application.

Settings overview

Several settings can be adjusted dynamically:

Key	Description
`secret`	JWT token secret, auto-generated on the first launch
`api_secret`	API secret to use in the Authorization header, auto-generated on the first launch
`allowed_origins`	Validates `Origin` headers against the provided values (comma separated), e.g., `https://test.tiptap.dev,https://prod.tiptap.dev`; If not set, validation is disabled
`authentication_disabled`	Set to `1` to disable authentication, `0` to enable (default: `0`)
`webhook_url`	URL for receiving webhook callbacks
`webhook_version`	Version of the webhook
`webhook_awareness`	Enable awareness webhooks for user activity, tracking `user.connected` and `user.disconnected` events (`1` for enabled, `0` for disabled)
`webhook_log_errors_only`	Log only webhook errors; successful webhook logs are disabled
`default_auto_versioning`	Set to `1` to enable auto versioning, `0` to disable (default: `0`)
`default_auto_versioning_interval`	Interval for auto versioning in seconds (default: `30` seconds)
`name`	Instance name for identification

Managing settings via API

The collaboration platform offers a straightforward API for managing these settings. Replace :key with the setting key you wish to update.

Create or overwrite settings

Use this call to add or update settings:

curl --location --request PUT 'https://YOUR_APP_ID.collab.tiptap.cloud/api/admin/settings/:key' \
--header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA' --header 'Content-Type: text/plain' \
-d 'your value'

List current settings

Use this call to retrieve a list of all current settings:

curl --location 'https://YOUR_APP_ID.collab.tiptap.cloud/api/admin/settings' \
--header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA'

Retrieve a specific setting

Use this call to retrieve the value of a particular setting:

curl --location 'https://YOUR_APP_ID.collab.tiptap.cloud/api/admin/settings/:key' \
--header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA'

Delete a setting

Use this call to delete a setting:

curl --location --request DELETE 'https://YOUR_APP_ID.collab.tiptap.cloud/api/admin/settings/:key' \
--header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA'

Server performance metrics

Use the /api/statistics endpoint to gather server performance data, including total document count, peak concurrent connections, total connections over the last 30 days, and lifetime connection counts. Review the metrics page for additional information.

curl --location 'https://YOUR_APP_ID.collab.tiptap.cloud/api/statistics' \
--header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA'