Meeting object

The meeting object represents a booked meeting that was scheduled through a Smart Schedule, personal scheduling page, or team scheduling page. The object contains a foreign key reference for the meeting in the email server's calendar, meeting meta data, and invitee email information. Also included are the questions and responses entered into the forms when the meeting was booked. The meeting object may be useful for creating accounts, contacts or leads for the booking user, tracking/update meeting based KPIs or other custom workflows important to your organization.

The Meeting schema

{
    "id": "",
    "emailMeetingId": "",
    "zoomMeetingId": null,
    "organizationId": "",
    "meetingStart": "",
    "meetingEnd": "",
    "isCanceled": false,
    "meetingOwner": {
        "userId": "",
        "username": "",
        "lastName": "",
        "firstName": ""
    },
    "meetingInfo": {
        "primaryInviteeName": "",
        "primaryInvitee": "",
        "optionalInvitees": "",
        "meetingName": "",
        "location": "",
        "existingEmailMeetingId": null,
        "calendarUrl": "",
        "organizationPath": "",
        "calendarPath": "",
        "formValues": [
            {
                "question": "",
                "answerText": ""
            }
        ],
        "surveyQuestions": [
            {
                "answer": "",
                "isRequired": false,
                "question": ""
            }
        ],
        "campaign": {
            "utm_id": null,
            "utm_source": null,
            "utm_medium": null,
            "utm_campaign": null,
            "utm_term": null,
            "utm_content": null
        }
    }
}

Fields

---

id string

The Cirrus Insight identifier for this booked meeting.

---

emailMeetingId string

The external system identifier for the event in Office 365, Exchange, or Google Calendar.

---

zoomMeetingId string

(optional) The Zoom meeting identifier.

---

organizationId string

The Cirrus Insight organization identifier.

---

meetingStart string

The meeting start time formatted as an ISO 8601 string in UTC.

---

meetingEnd string

The meeting end time formatted as an ISO 8601 string in UTC.

---

isCanceled boolean

A flag indicating if the meeting was canceled through Cirrus Insight scheduling.

---

meetingOwner object

The Cirrus Insight user on who's calendar the meeting was scheduled.

child attributes

Attribute	Type	Description
userId	string	The Cirrus Insight identifier for the meeting owner's user record.
username	string	The user's username, typically email format.
lastName	string	Last name of the meeting owner.
firstName	string	First name of the meeting owner.

---

meetingInfo object

The meetingInfo object contains information about the meeting, including the primary invitee, organization path, meeting name, and more.

Child attributes

Attribute	Type	Description
primaryInviteeName	string	The name of the main invitee to the meeting; typically the individual who scheduled the meeting.
primaryInvitee	string	The email address of the primaryInvitee.
optionalInvitees	string	A (comma-separated) list of optional invitees for the meeting. Entered by the primaryInvitee when scheduling the meeting.
meetingName	string	The name of the meeting.
location	string	The location of the meeting.
existingEmailMeetingId	string	The external system identifier for the event in Office 365, Exchange, or Google Calendar.
calendarUrl	string	The URL of the calendar scheduling page that was used to schedule the meeting.
organizationPath	string	The vanity partial-path of the organization in the scheduling link.
calendarPath	string	The vanity partial-path of the scheduling page.
formValues	list	(See below) A list of form values entered when the meeting was booked.
surveyQuestions	list	(See below) A list of survey questions associated with the meeting.

---

formValues list

The (optional) formValues list contains the questions and answers from the intial Smart Schedule form that is used for host-matching.

Child attributes

Attribute	Type	Description
question	string	A question used for host matching.
answerText	string	The scheduling user's answer.

---

surveyQuestions list

The (optional) surveyQuestions list contains the questions and answers from form presented at the end of the scheduling flow. The survey contains informational questions and answers that the host wants to collect from the user who is scheduling the meeting.

Child attributes

Attribute	Type	Description
question	string	An informational question asked by the host of the scheduling user.
answer	string	The scheduling user's answer.
isRequired	boolean	A flag indicating if the question is a required field in order to schedule the meeting.

campaign object

(optional) The campaign object contains UTM tracking parameters associated with the meeting booking.

Child attributes

Attribute	Type	Description
utm_id	string	The UTM ID parameter.
utm_source	string	The UTM source parameter identifying the source of traffic.
utm_medium	string	The UTM medium parameter identifying the marketing medium.
utm_campaign	string	The UTM campaign parameter identifying the specific campaign.
utm_term	string	The UTM term parameter for paid search keywords.
utm_content	string	The UTM content parameter for differentiating similar content/ads.