v0.1 — production API

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

Configuration Events

The Cirrus Insight platform provides events to audit the change history for your company's configuration and settings. These events can be used to meet compliance requirements around configuration and change management.

organization.setting.changed

This eventmodel is sent when an organization setting is modified in the Cirrus Insight admin panel. The event provides information about the previous setting values, the modified setting values, the setting metadata, and the user who made the change.

The data payload contains a change-historymodel object as well as an organization-settingmodel object, where the previous and current properties include the setting value and override flag:

{
  "current": {
    "value": "",
    "allowUserOverride": true
  },
  "previous": {
    "value": "",
    "allowUserOverride": true
  },
  "setting": {
    "module": "",
    "name": "",
    "default": "",
    "title": "",
    "helpText": ""
  },
  "modifiedBy": {
    "userId": "",
    "username": "",
    "firstName": "",
    "lastName": ""
  }
}

organization.profile.changed

This eventmodel is sent when your company profile is updated in the Cirrus Insight admin panel. The event provides information about the previous profile values, the modified profile values, and the user who made the change to the organization profile.

The data payload contains a change-historymodel object, in which the previous and current properties are instances of an organization-profilemodel record.

{
    "previous": {
        "companyName": "",
        "webAddress": "",
        "logoUrl": ""
    },
    "current": {
        "companyName": "",
        "webAddress": "",
        "logoUrl": ""
    },
    "modifiedBy": {
        "userId": "",
        "username": "",
        "firstName": "",
        "lastName": ""
    }
}

organization.service_account.changed

This eventmodel is sent when a service account configuration is modified in the Cirrus Insight admin panel. The event provides information about the previous service account configuration, the modified configuration, and the user who made the change.

The data payload contains a change-historymodel object, where the previous and current properties are instances of an organization-service-accountmodel object:

{
  "current": {
    "name": "",
    "domains": ["", ""],
    "credentials": "unchanged"
  },
  "previous": {
    "name": "",
    "domains": ["", ""]
  },
  "modifiedBy": {
    "userId": "",
    "username": "",
    "firstName": "",
    "lastName": ""
  }
}

When a service account is being added, previous will be null. When a service account is being removed, current will be null.

Note: For security reasons, actual credential values (tokens, usernames, passwords) are never included in webhook payloads. The credentials field in the current object only indicates if credentials were modified in this change (changed or unchanged).

organization.domains.changed

This eventmodel is sent when your organization's domains are modified in the Cirrus Insight admin panel. The event provides information about the previous domain list, the modified domain list, and the user who made the change.

The data payload contains a change-historymodel object, where the previous and current properties are lists of the domains associated with your organization. Each item in the list represents a domain that has been added to your organization for use throughout the organization settings.

{
  "current": {
    "value": ["", ""]
  },
  "previous": {
    "value": [""]
  },
  "modifiedBy": {
    "userId": "",
    "username": "",
    "firstName": "",
    "lastName": ""
  }
}