Please see the full REST API documentation for API implementation details.
Resource: Meeting Source
A meeting source identifies an event in another application from which a Lucid meeting was created; for example, an event in a calendar application that integrates with Lucid Meetings. A one-to-one mapping is expected. The meeting source can then be used to look up a Lucid meeting based on the source event.
For example, the Lucid Meetings Chrome extension creates meetings based on Google calendar events, using the string "google_event" for the source_type and using Google's event ID for the source_id property.
It is expected that applications will have use for only their own meeting sources. If your application doesn't create meeting sources, you can safely ignore them.
- Properties
- Getting a List of Meeting Sources
- Getting the Meeting Source for a Meeting
- Getting a Single Meeting Source
- Creating a New Meeting Source
- Updating a Meeting Source via PATCH
- Deleting a Meeting Source
Properties
#| Field | Type | Notes |
|---|---|---|
| meeting_source_id | integer | |
| member_id | integer | Identifies the Lucid member who created the meeting source |
| source_type | plain text (20) | An identifier for the source application. Typically an application that creates meeting sources will use the same source_type for all of them. |
| source_id | plain text (255) | An identifier for the source event (typically). The
combination of source_type
and source_id must be unique.
|
| source_data | string, number, array, object, or NULL | Arbitrary data uploaded by the API user (application) for later reference. |
| meeting_id | integer | Identifies a meeting |
| create_ts | timestamp | |
| update_ts | timestamp |
Getting a List of My Meeting Sources
#GET /lucid/api/v1/meeting_sources (must be logged in)
| Query parameter | Notes |
|---|---|
| source_type | Restrict to meeting sources with the specified source_type |
| source_id | Restrict to meeting sources with the specified source_id |
| page | Page number, starting from 0 |
| per_page | Any integer between 0 and 100, inclusive.
Default: 10. |
| sort | One of: create_ts , -create_ts |
| fields | See Field Filtering |
| envelope | See Enveloping |
Sample Request
GET /lucid/api/v1/meeting_sources?source_type=test_source&fields=meeting_source_id,source_type,source_id,meeting_id,member_id
Content-Type: application/json; charset=utf-8 Content-Length: 306 X-Page-Num: 0 X-Per-Page: 10 X-Rate-Limit-Limit: 100 X-Rate-Limit-Remaining: 96 X-Rate-Limit-Reset: 41 X-Rate-Limit-Used: 2 X-Requestor: afarrell@secondrise.com X-Total-Count: 2 X-Total-Pages: 1
[
{
"meeting_source_id": 700,
"source_type": "test_source",
"source_id": "test_source_id_2",
"meeting_id": 5732
},
{
"meeting_source_id": 694,
"source_type": "test_source",
"source_id": "test_source_id",
"meeting_id": 5701
}
]
Getting the Meeting Source for a Meeting
#The meeting sources collection for a meeting will contain zero or one items.
GET /lucid/api/v1/meetings/:meeting_id/meeting_sources
Sample Request
GET /lucid/api/v1/meetings/5701/meeting_sources
Content-Type: application/json; charset=utf-8 Content-Length: 873
[
{
"id": 694,
"resource_url": "https://site.lucidmeetings.com/lucid/api/v1/meeting_sources/694",
"meeting_source_id": 694,
"source_type": "test_source",
"source_id": "test_source_id",
"source_data": false,
"meeting_id": 5701,
"member_id": 302,
"create_ts": {
"value": 1571947762,
"iso_8601": "2019-10-24T20:09:22Z",
"pretty": {
"time": "1:09 PM",
"date": "October 24, 2019",
"timezone": "Los Angeles"
}
},
"update_ts": {
"value": 1571947762,
"iso_8601": "2019-10-24T20:09:22Z",
"pretty": {
"time": "1:09 PM",
"date": "October 24, 2019",
"timezone": "Los Angeles"
}
}
}
]
Getting a Single Meeting Source
#GET /lucid/api/v1/meeting_sources/:meeting_source_id
| Query parameter | Notes |
|---|---|
| fields | See Field Filtering |
| envelope | See Enveloping |
Sample Request
GET /lucid/api/v1/meeting_sources/694
Content-Type: application/json; charset=utf-8 Content-Length: 731 X-Rate-Limit-Limit: 100 X-Rate-Limit-Remaining: 99 X-Rate-Limit-Reset: 60 X-Rate-Limit-Used: 1 X-Requestor: afarrell@secondrise.com
{
"id": 694,
"resource_url": "https://site.lucidmeetings.com/lucid/api/v1/meeting_sources/694",
"meeting_source_id": 694,
"source_type": "test_source",
"source_id": "test_source_id",
"meeting_id": 5701,
"member_id": 302,
"create_ts": {
"value": 1571947762,
"iso_8601": "2019-10-24T20:09:22Z",
"pretty": {
"time": "1:09 PM",
"date": "October 24, 2019",
"timezone": "Los Angeles"
}
},
"update_ts": {
"value": 1571947762,
"iso_8601": "2019-10-24T20:09:22Z",
"pretty": {
"time": "1:09 PM",
"date": "October 24, 2019",
"timezone": "Los Angeles"
}
}
}
Creating a New Meeting Source
#POST /lucid/api/v1/meetings/:meeting_id/meeting_sources
| Field | Required | Notes |
|---|---|---|
| source_type | yes | |
| source_id | yes | |
| source_data | no |
Sample Request
POST /lucid/api/v1/meetings/5732/meeting_sources Content-Type: application/json
{
"source_type": "test_source",
"source_id": "test_source_id_2"
}
201 Created Location: https://site.lucidmeetings.com/lucid/api/v1/meetings/5732/meeting_sources/700 Content-Type: application/json
{
"id": 700,
"resource_url": "https:/site.lucidmeetings.com/lucid/api/v1/meeting_sources/700",
"meeting_source_id": 700,
"source_type": "test_source",
"source_id": "test_source_id_2",
"meeting_id": 5732,
"member_id": 302,
"create_ts": {
"value": 1572649708,
"iso_8601": "2019-11-01T23:08:28Z",
"pretty": {
"time": "4:08 PM",
"date": "November 1, 2019",
"timezone": "Los Angeles"
}
},
"update_ts": {
"value": 1572649708,
"iso_8601": "2019-11-01T23:08:28Z",
"pretty": {
"time": "4:08 PM",
"date": "November 1, 2019",
"timezone": "Los Angeles"
}
}
}
Updating a Meeting Source via PATCH
#PATCH /lucid/api/v1/meeting_sources/:meeting_source_id
| Field | Required | Notes |
|---|---|---|
| source_type | no | |
| source_id | no | |
| source_data | no |
Sample Request
PATCH /lucid/api/v1/meeting_sources/694 Content-Type: application/json
{
"source_id": "test_source_6005",
"source_data": {
"last_updated": 1575940855,
"updated_by": "Jane Doe"
}
}
200 OK Content-Type: application/json
{
"id": 694,
"resource_url": "https://site.lucidmeetings.com/lucid/api/v1/meeting_sources/694",
"meeting_source_id": 694,
"source_type": "test_source",
"source_id": "test_source_6005",
"source_data": {
"last_updated": 1575940855,
"updated_by": "Jane Doe"
},
"meeting_id": 5701,
"member_id": 302,
"create_ts": {
"value": 1571947762,
"iso_8601": "2019-10-24T20:09:22Z",
"pretty": {
"time": "1:09 PM",
"date": "October 24, 2019",
"timezone": "Los Angeles"
}
},
"update_ts": {
"value": 1576019583,
"iso_8601": "2019-12-10T23:13:03Z",
"pretty": {
"time": "3:13 PM",
"date": "December 10, 2019",
"timezone": "Los Angeles"
}
}
}
Deleting a Meeting Source
#DELETE /lucid/api/v1/meeting_sources/:meeting_source_id
Sample Request
DELETE /lucid/api/v1/meeting_sources/700
204 No Content