{"_id":"55883030eb5f2421003f9a2f","user":"543568c135740020002a1c10","parentDoc":null,"project":"5435693035740020002a1c1c","__v":7,"version":{"_id":"5435693035740020002a1c1f","__v":14,"project":"5435693035740020002a1c1c","createdAt":"2014-10-08T16:41:20.702Z","releaseDate":"2014-10-08T16:41:20.702Z","categories":["5435693035740020002a1c20","551c03c1ff892b3700d1c57a","551ca3927405910d00900a59","551cac6448564a2f0024d89e","551cb4d848564a2f0024d8a3","551cb52db7a32b3b00d1ef78","5526e2064a7ac121004c6073","5526e5147d4a4417009516b3","5526e9877d4a4417009516bb","5528362cd9e1db2d00cd924d","5580240ebe698419008f2ba2","5580a7dabe698419008f2db6","568161799de23c0d00c54750","5866c905a2cbb31900f6f1aa"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"551ca3927405910d00900a59","pages":["551ca655b7a32b3b00d1ef6a","551cb8f35de8de3900d8db0d","551cb97f5de8de3900d8db0f","55293316a15e530d00af3cb3","55882c89eb5f2421003f9a1c","55883030eb5f2421003f9a2f"],"project":"5435693035740020002a1c1c","version":"5435693035740020002a1c1f","__v":6,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-04-02T02:04:02.634Z","from_sync":false,"order":2,"slug":"api-resources","title":"API Resources"},"updates":["58ffa7d419945f0f00a2c81e","58ffa8a919945f0f00a2c824"],"next":{"pages":[],"description":""},"createdAt":"2015-06-22T15:56:32.728Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"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](doc:space) through Robin.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Breaking Changes\",\n  \"body\": \"There are a few upcoming breaking changes to the Event entity:\\n\\n- The `next_event` and `current_event` properties currently returned in the Event model are deprecated and will be removed in a future release. Use the `state` sub-resource instead.\\n- The `started_at` and `ended_at` properties are deprecated. Use `start` and `end` instead.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Properties\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`id`\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"The ID of the event.\",\n    \"1-0\": \"`title`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"The title of the event.\",\n    \"5-0\": \"`organizer_id`\",\n    \"5-1\": \"Integer\",\n    \"5-2\": \"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](doc:user).\",\n    \"6-0\": \"`organizer_email`\",\n    \"6-1\": \"String\",\n    \"6-2\": \"The email address of the event organizer.\",\n    \"19-0\": \"`recurrence_id`\",\n    \"19-1\": \"String\",\n    \"19-2\": \"The iCal recurrence ID of the event, if it is part of a series.\",\n    \"7-0\": \"`creator_id`\",\n    \"7-1\": \"Integer\",\n    \"7-2\": \"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](doc:user).\",\n    \"8-0\": \"`creator_email`\",\n    \"8-1\": \"String\",\n    \"8-2\": \"The email address of the event creator.\",\n    \"9-0\": \"`space_id`\",\n    \"9-1\": \"Integer\",\n    \"9-2\": \"The ID of the [Space](doc:space) that the event is booked in.\",\n    \"11-0\": \"`remote_event_id`\",\n    \"11-1\": \"String\",\n    \"11-2\": \"The external ID of the event if it exists on an external calendar service.\",\n    \"12-0\": \"`remote_type`\",\n    \"12-1\": \"String\",\n    \"12-2\": \"If the event exists on an external calendar service, this will be an enum that identifies the service. (eg. \\\"google\\\")\",\n    \"13-0\": \"`creation_type`\",\n    \"13-1\": \"String\",\n    \"13-2\": \"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.\",\n    \"10-0\": \"`invitees`\",\n    \"10-1\": \"Array\",\n    \"10-2\": \"An array of people invited to the event.\",\n    \"14-0\": \"`is_all_day`\",\n    \"14-1\": \"Boolean\",\n    \"14-2\": \"Flags an event as an \\\"all day\\\" event.\",\n    \"2-0\": \"`description`\",\n    \"2-1\": \"String\",\n    \"2-2\": \"The event description.\",\n    \"16-0\": \"`uid`\",\n    \"16-1\": \"String\",\n    \"16-2\": \"Event unique identifier as defined in RFC5545. It is used to uniquely identify events across calendaring systems.\\n\\nNote 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.\",\n    \"17-0\": \"`recurrence`\",\n    \"17-1\": \"Array\",\n    \"17-2\": \"List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545.\",\n    \"15-0\": \"`visibility`\",\n    \"15-1\": \"String\",\n    \"15-2\": \"The visibility type for the event. May be `default`, `public`, `private`, `personal` or `confidential`.\",\n    \"3-0\": \"`start`\",\n    \"3-1\": \"DateTimeZone\",\n    \"3-2\": \"The start of the event.\",\n    \"4-0\": \"`end`\",\n    \"4-2\": \"The end of the event.\",\n    \"4-1\": \"DateTimeZone\",\n    \"18-0\": \"`series_id`\",\n    \"18-1\": \"String\",\n    \"18-2\": \"The ID of the series that the event is a part of, if the event is a recurring instance.\"\n  },\n  \"cols\": 3,\n  \"rows\": 20\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"23481829\\\",\\n  \\\"organizer_id\\\": 42,\\n  \\\"organizer_email\\\": \\\"brian:::at:::robinpowered.com\\\",\\n  \\\"creator_id\\\": 42,\\n  \\\"creator_email\\\": \\\"brian@robinpowered.com\\\",\\n  \\\"space_id\\\": 48,\\n  \\\"title\\\": \\\"Weekly Round-Up\\\",\\n  \\\"description\\\": \\\"Discuss the progress made during the week.\\\",\\n  \\\"location\\\": \\\"Conference Room\\\",\\n  \\\"remote_event_id\\\": \\\"jsdopi342kf2309fj203_20170106T060000Z\\\",\\n  \\\"remote_type\\\": \\\"google\\\",\\n  \\\"creation_type\\\": \\\"manual\\\",\\n  \\\"uid\\\": \\\"jsdopi342kf2309fj203@google.com\\\",\\n  \\\"started_at\\\": \\\"2017-01-06T01:00:00-0500\\\",\\n  \\\"ended_at\\\": \\\"2017-01-06T02:00:00-0500\\\",\\n  \\\"start\\\": {\\n    \\\"date_time\\\": \\\"2017-01-06T01:00:00-0500\\\",\\n    \\\"time_zone\\\": \\\"America/New_York\\\"\\n  },\\n  \\\"end\\\": {\\n    \\\"date_time\\\": \\\"2017-01-06T02:00:00-0500\\\",\\n    \\\"time_zone\\\": \\\"America/New_York\\\"\\n  },\\n  \\\"series_id\\\": null,\\n  \\\"recurrence_id\\\": null,\\n  \\\"status\\\": \\\"confirmed\\\",\\n  \\\"recurrence\\\": [\\n  \\t\\\"RRULE:FREQ=WEEKLY;UNTIL=20170127T170000Z\\\"\\n  ],\\n  \\\"is_all_day\\\": false,\\n  \\\"visibility\\\": \\\"default\\\",\\n  \\\"invitees\\\": [\\n    {\\n      \\\"id\\\": 108209227,\\n      \\\"event_id\\\": \\\"23481829\\\",\\n      \\\"user_id\\\": 42,\\n      \\\"email\\\": \\\"example1@robinpowered.com\\\",\\n      \\\"display_name\\\": \\\"Brian Muse\\\",\\n      \\\"response_status\\\": \\\"accepted\\\",\\n      \\\"is_organizer\\\": false,\\n      \\\"is_resource\\\": false,\\n      \\\"updated_at\\\": \\\"2016-12-30T20:22:36+0000\\\",\\n      \\\"created_at\\\": \\\"2016-12-30T20:22:36+0000\\\"\\n    },\\n    {\\n      \\\"id\\\": 108209228,\\n      \\\"event_id\\\": \\\"23481829\\\",\\n      \\\"user_id\\\": null,\\n      \\\"email\\\": \\\"example2@robinpowered.com\\\",\\n      \\\"display_name\\\": null,\\n      \\\"response_status\\\": \\\"not_responded\\\",\\n      \\\"is_organizer\\\": false,\\n      \\\"is_resource\\\": false,\\n      \\\"updated_at\\\": \\\"2016-12-30T20:22:36+0000\\\",\\n      \\\"created_at\\\": \\\"2016-12-30T20:22:36+0000\\\"\\n    },\\n    {\\n      \\\"id\\\": 108209229,\\n      \\\"event_id\\\": \\\"23481829\\\",\\n      \\\"user_id\\\": null,\\n      \\\"email\\\": \\\"example3@robinpowered.com\\\",\\n      \\\"display_name\\\": null,\\n      \\\"response_status\\\": \\\"not_responded\\\",\\n      \\\"is_organizer\\\": false,\\n      \\\"is_resource\\\": false,\\n      \\\"updated_at\\\": \\\"2016-12-30T20:22:36+0000\\\",\\n      \\\"created_at\\\": \\\"2016-12-30T20:22:36+0000\\\"\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"A meeting or reservation, booked in a space.","slug":"event","type":"basic","title":"Event"}

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](doc:space) through Robin. [block:callout] { "type": "danger", "title": "Breaking Changes", "body": "There are a few upcoming breaking changes to the Event entity:\n\n- The `next_event` and `current_event` properties currently returned in the Event model are deprecated and will be removed in a future release. Use the `state` sub-resource instead.\n- The `started_at` and `ended_at` properties are deprecated. Use `start` and `end` instead." } [/block] [block:api-header] { "type": "basic", "title": "Properties" } [/block] [block:parameters] { "data": { "0-0": "`id`", "0-1": "Integer", "0-2": "The ID of the event.", "1-0": "`title`", "1-1": "String", "1-2": "The title of the event.", "5-0": "`organizer_id`", "5-1": "Integer", "5-2": "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](doc:user).", "6-0": "`organizer_email`", "6-1": "String", "6-2": "The email address of the event organizer.", "19-0": "`recurrence_id`", "19-1": "String", "19-2": "The iCal recurrence ID of the event, if it is part of a series.", "7-0": "`creator_id`", "7-1": "Integer", "7-2": "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](doc:user).", "8-0": "`creator_email`", "8-1": "String", "8-2": "The email address of the event creator.", "9-0": "`space_id`", "9-1": "Integer", "9-2": "The ID of the [Space](doc:space) that the event is booked in.", "11-0": "`remote_event_id`", "11-1": "String", "11-2": "The external ID of the event if it exists on an external calendar service.", "12-0": "`remote_type`", "12-1": "String", "12-2": "If the event exists on an external calendar service, this will be an enum that identifies the service. (eg. \"google\")", "13-0": "`creation_type`", "13-1": "String", "13-2": "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.", "10-0": "`invitees`", "10-1": "Array", "10-2": "An array of people invited to the event.", "14-0": "`is_all_day`", "14-1": "Boolean", "14-2": "Flags an event as an \"all day\" event.", "2-0": "`description`", "2-1": "String", "2-2": "The event description.", "16-0": "`uid`", "16-1": "String", "16-2": "Event unique identifier as defined in RFC5545. It is used to uniquely identify events across calendaring systems.\n\nNote 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.", "17-0": "`recurrence`", "17-1": "Array", "17-2": "List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545.", "15-0": "`visibility`", "15-1": "String", "15-2": "The visibility type for the event. May be `default`, `public`, `private`, `personal` or `confidential`.", "3-0": "`start`", "3-1": "DateTimeZone", "3-2": "The start of the event.", "4-0": "`end`", "4-2": "The end of the event.", "4-1": "DateTimeZone", "18-0": "`series_id`", "18-1": "String", "18-2": "The ID of the series that the event is a part of, if the event is a recurring instance." }, "cols": 3, "rows": 20 } [/block] [block:api-header] { "type": "basic", "title": "Example" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"23481829\",\n \"organizer_id\": 42,\n \"organizer_email\": \"brian@robinpowered.com\",\n \"creator_id\": 42,\n \"creator_email\": \"brian@robinpowered.com\",\n \"space_id\": 48,\n \"title\": \"Weekly Round-Up\",\n \"description\": \"Discuss the progress made during the week.\",\n \"location\": \"Conference Room\",\n \"remote_event_id\": \"jsdopi342kf2309fj203_20170106T060000Z\",\n \"remote_type\": \"google\",\n \"creation_type\": \"manual\",\n \"uid\": \"jsdopi342kf2309fj203@google.com\",\n \"started_at\": \"2017-01-06T01:00:00-0500\",\n \"ended_at\": \"2017-01-06T02:00:00-0500\",\n \"start\": {\n \"date_time\": \"2017-01-06T01:00:00-0500\",\n \"time_zone\": \"America/New_York\"\n },\n \"end\": {\n \"date_time\": \"2017-01-06T02:00:00-0500\",\n \"time_zone\": \"America/New_York\"\n },\n \"series_id\": null,\n \"recurrence_id\": null,\n \"status\": \"confirmed\",\n \"recurrence\": [\n \t\"RRULE:FREQ=WEEKLY;UNTIL=20170127T170000Z\"\n ],\n \"is_all_day\": false,\n \"visibility\": \"default\",\n \"invitees\": [\n {\n \"id\": 108209227,\n \"event_id\": \"23481829\",\n \"user_id\": 42,\n \"email\": \"example1@robinpowered.com\",\n \"display_name\": \"Brian Muse\",\n \"response_status\": \"accepted\",\n \"is_organizer\": false,\n \"is_resource\": false,\n \"updated_at\": \"2016-12-30T20:22:36+0000\",\n \"created_at\": \"2016-12-30T20:22:36+0000\"\n },\n {\n \"id\": 108209228,\n \"event_id\": \"23481829\",\n \"user_id\": null,\n \"email\": \"example2@robinpowered.com\",\n \"display_name\": null,\n \"response_status\": \"not_responded\",\n \"is_organizer\": false,\n \"is_resource\": false,\n \"updated_at\": \"2016-12-30T20:22:36+0000\",\n \"created_at\": \"2016-12-30T20:22:36+0000\"\n },\n {\n \"id\": 108209229,\n \"event_id\": \"23481829\",\n \"user_id\": null,\n \"email\": \"example3@robinpowered.com\",\n \"display_name\": null,\n \"response_status\": \"not_responded\",\n \"is_organizer\": false,\n \"is_resource\": false,\n \"updated_at\": \"2016-12-30T20:22:36+0000\",\n \"created_at\": \"2016-12-30T20:22:36+0000\"\n }\n ]\n}", "language": "json" } ] } [/block]