Event Types

Event types play a crucial role in the functionality of Cirrus Insight webhooks.

Webhooks are a way for applications to receive real-time notifications when certain events occur. In the context of Cirrus Insight, these events can include actions like meeting scheduled, meeting rescheduled, and meeting canceled.

By understanding the different event types available, developers can effectively configure their webhook endpoints to receive specific notifications based on their application's needs. This allows for seamless integration with Cirrus Insight, enabling developers to build powerful and customized workflows.

Each event type provides detailed information about the payload structure, including the data that is sent when a particular event occurs.

Developer Events

---

developer.webhook.test

This eventmodel is sent when a webhook endpoint configuration is being validated. In order for Cirrus Insight to begin sending any other events to an endpoint, the developer.webhook.test event must first be handled successfully.

The data payload for the test event is a simple object containing two fields:

{
    "webhookEndpoint": "",
    "username": ""
}

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": {
    "type": "",
    "name": "",
    "domains": ["", ""],
    "credentials": "unchanged"
  },
  "previous": {
    "type": "",
    "name": "",
    "domains": ["", ""]
  },
  "modifiedBy": {
    "userId": "",
    "username": "",
    "firstName": "",
    "lastName": ""
  }
}

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.

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 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": ""
  }
}

Scheduling Events

Smart Scheduler

scheduling.smartscheduler.scheduled

This eventmodel is sent when a meeting is successfully scheduled using the Smart Scheduler feature in Cirrus Insight. Developers can use this event to trigger specific actions or notifications in their application.

The data payload contains a meetingmodel object.

scheduling.smartscheduler.rescheduled

This eventmodel is sent when a previously scheduled meeting is rescheduled using the Smart Scheduler feature in Cirrus Insight. Developers can use this event to update their application with the new meeting details or trigger any necessary actions.

The data payload contains a meetingmodel object.

scheduling.smartscheduler.canceled

This eventmodel is sent when a scheduled meeting is canceled using the Smart Scheduler feature in Cirrus Insight. Developers can use this event to update their application accordingly or trigger any necessary actions in response to the cancellation.

The data payload contains a meetingmodel object.