Event

A meeting or reservation, booked in a space.

Events are often synchronized from an external calendar service, such as Google Calendar or Office 365. Events may also be created by booking a Space through Robin.

❗️

Breaking Changes

The started_at and ended_at properties are deprecated and will soon be removed. Please use start and end instead.

Properties

id

String

The ID of the event.

title

String

The title of the event.

description

String

The event description.

start

DateTimeZone

The start of the event.

end

DateTimeZone

The end of the event.

organizer_id

Integer

The ID of the user that is the organizer of the event. This value may be null if the organizer is not a Robin User.

organizer_email

String

The email address of the event organizer.

creator_id

Integer

The ID of the user that is the originally created the event. This value may be null if the creator is not a Robin User.

creator_email

String

The email address of the event creator.

space_id

Integer

The ID of the Space that the event is booked in.

invitees

Array

An array of people invited to the event.

remote_event_id

String

The external ID of the event if it exists on an external calendar service.

remote_type

String

If the event exists on an external calendar service, this will be an enum that identifies the service. (eg. "google")

creation_type

String

Either "synced", "manual", or "automatic". Synced implies the event originated on a remote service. A manual event is an explicit through Robin. An automatic event was created by Robin due to presence.

is_all_day

Boolean

Flags an event as an "all day" event.

visibility

String

The visibility type for the event. May be default, public, private, personal or confidential.

uid

String

Event unique identifier as defined in RFC5545. It is used to uniquely identify events across calendaring systems.

Note that the UID and the id are not identical. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same UIDs.

recurrence

Array

List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545.

series_id

String

The ID of the series that the event is a part of, if the event is a recurring instance.

recurrence_id

String

The iCal recurrence ID of the event, if it is part of a series.

Example

{
  "id": "23481829",
  "organizer_id": 42,
  "organizer_email": "[email protected]",
  "creator_id": 42,
  "creator_email": "[email protected]",
  "space_id": 48,
  "title": "Weekly Round-Up",
  "description": "Discuss the progress made during the week.",
  "location": "Conference Room",
  "remote_event_id": "jsdopi342kf2309fj203_20170106T060000Z",
  "remote_type": "google",
  "creation_type": "manual",
  "uid": "[email protected]",
  "started_at": "2017-01-06T01:00:00-0500",
  "ended_at": "2017-01-06T02:00:00-0500",
  "start": {
    "date_time": "2017-01-06T01:00:00-0500",
    "time_zone": "America/New_York"
  },
  "end": {
    "date_time": "2017-01-06T02:00:00-0500",
    "time_zone": "America/New_York"
  },
  "series_id": null,
  "recurrence_id": null,
  "status": "confirmed",
  "recurrence": [
    "RRULE:FREQ=WEEKLY;UNTIL=20170127T170000Z"
  ],
  "is_all_day": false,
  "visibility": "default",
  "invitees": [
    {
      "id": "108209227",
      "event_id": "23481829",
      "user_id": 42,
      "email": "[email protected]",
      "display_name": "Brian Muse",
      "response_status": "accepted",
      "is_organizer": false,
      "is_resource": false,
      "updated_at": "2016-12-30T20:22:36+0000",
      "created_at": "2016-12-30T20:22:36+0000"
    },
    {
      "id": "108209228",
      "event_id": "23481829",
      "user_id": null,
      "email": "[email protected]",
      "display_name": null,
      "response_status": "not_responded",
      "is_organizer": false,
      "is_resource": false,
      "updated_at": "2016-12-30T20:22:36+0000",
      "created_at": "2016-12-30T20:22:36+0000"
    },
    {
      "id": "108209229",
      "event_id": "23481829",
      "user_id": null,
      "email": "[email protected]",
      "display_name": null,
      "response_status": "not_responded",
      "is_organizer": false,
      "is_resource": false,
      "updated_at": "2016-12-30T20:22:36+0000",
      "created_at": "2016-12-30T20:22:36+0000"
    }
  ]
}