Skip to content

v0.1 — production API

This shape backs Cirrus Insight webhooks and integrations in production today. Supported indefinitely.

Organization Setting object ​

The organization-setting object represents a configurable setting within your Cirrus Insight organization. Each setting includes metadata about its purpose, default value, and whether users can override the organization-wide setting. Organization settings are typically managed through the Cirrus Insight admin panel and changes can be tracked through webhooks.

The Organization Setting schema ​

json
{
  "setting": {
    "module": "",
    "name": "",
    "default": "",
    "title": "",
    "helpText": ""
  },
  "value": "",
  "allowUserOverride": true
}

Fields ​


setting object ​

Metadata about the organization setting.

child attributes ​

AttributeTypeDescription
modulestringThe system module this setting belongs to.
namestringThe unique identifier for this setting.
defaultstringThe default value for this setting.
titlestringA human-readable title for the setting.
helpTextstringAdditional description text explaining the setting's purpose.

value string ​

The current value of the setting for your organization.


allowUserOverride boolean ​

A flag indicating whether individual users can override this setting with their own value.


The organization setting is used in the following webhook events:

Raleigh, NC — a Cirruspath, Inc. company