HydraCore
API by router

Google calendar

POST
/internal/v1/instances/{instance_id}/calendar/deeplink

Path Parameters

instance_id*Instance Id
Formatuuid

Request Body

application/json
  1. body
attendees?array<string>|

Email addresses of attendees

calendar_id?Calendar Id

Calendar ID (default: primary)

Default"primary"
description?|

Event description/notes

end_time*End Time

Event end (ISO 8601)

Formatdate-time
location?|null
start_time*Start Time

Event start (ISO 8601)

Formatdate-time
summary*Summary

Event title

Lengthlength <= 500

Response Body

Successful Response

application/json
  1. response
ics_url?string|null
url*Url
Example Request
curl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/calendar/deeplink' \  -H 'Content-Type: application/json' \  -d '{  "end_time": "2019-08-24T14:15:22Z",  "start_time": "2019-08-24T14:15:22Z",  "summary": "string"}'
Example Response
{  "ics_url": "string",  "url": "string"}

List Calendar Events

GET
/internal/v1/instances/{instance_id}/calendar/events

Path Parameters

instance_id*Instance Id
Formatuuid

Query Parameters

calendar_id?Calendar Id
Default"primary"
connection_name?|

Specific calendar connection name (for multi-calendar)

time_min?|

Start of time range (default: now)

time_max?|

End of time range (default: now + 7 days)

max_results?Max Results
Range1 <= value <= 100
Default20

Response Body

Successful Response

application/json
  1. response
count*Count
events*array<>
Example Request
curl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/calendar/events'
Example Response
{  "count": 0,  "events": [    {      "end": "string",      "html_link": "string",      "id": "string",      "location": "string",      "start": "string",      "status": "string",      "summary": "string"    }  ]}

Create Calendar Event

POST
/internal/v1/instances/{instance_id}/calendar/events

Path Parameters

instance_id*Instance Id
Formatuuid

Query Parameters

connection_name?string|null

Request Body

application/json
  1. body
attendees?array<string>|

Email addresses of attendees

calendar_id?Calendar Id

Calendar ID (default: primary)

Default"primary"
description?|

Event description/notes

end_time*End Time

Event end (ISO 8601)

Formatdate-time
location?|null
start_time*Start Time

Event start (ISO 8601)

Formatdate-time
summary*Summary

Event title

Lengthlength <= 500

Response Body

Successful Response

application/json
  1. response
end*End
html_link?string|null
id*Id
location?string|null
start*Start
status?string|null
summary*Summary
Example Request
curl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/calendar/events' \  -H 'Content-Type: application/json' \  -d '{  "end_time": "2019-08-24T14:15:22Z",  "start_time": "2019-08-24T14:15:22Z",  "summary": "string"}'
Example Response
{  "end": "string",  "html_link": "string",  "id": "string",  "location": "string",  "start": "string",  "status": "string",  "summary": "string"}

Check Freebusy

GET
/internal/v1/instances/{instance_id}/calendar/freebusy

Path Parameters

instance_id*Instance Id
Formatuuid

Query Parameters

calendar_id?Calendar Id
Default"primary"
connection_name?string|null
time_min*Time Min
Formatdate-time
time_max*Time Max
Formatdate-time

Response Body

Successful Response

application/json
  1. response
busy_periods*array<>
calendar_id*Calendar Id
Example Request
curl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/calendar/freebusy?time_min=2019-08-24T14%3A15%3A22Z&time_max=2019-08-24T14%3A15%3A22Z'
Example Response
{  "busy_periods": [    {}  ],  "calendar_id": "string"}