AlphaAlpha Docs
API Reference

Calendar Connections

API for managing external calendar connections

Get Google OAuth authorization URL

GET
/crm/calendar/connections/google/authorize

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/calendar/connections/google/authorize"
{
  "property1": "string",
  "property2": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Handle Google OAuth callback

GET
/crm/calendar/connections/google/callback

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

code*string
state*string

Response Body

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/calendar/connections/google/callback?code=string&state=string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get Outlook OAuth authorization URL

GET
/crm/calendar/connections/outlook/authorize

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/calendar/connections/outlook/authorize"
{
  "property1": "string",
  "property2": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Handle Outlook OAuth callback

GET
/crm/calendar/connections/outlook/callback

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

code*string
state*string

Response Body

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/calendar/connections/outlook/callback?code=string&state=string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get connection statuses

GET
/crm/calendar/connections/status

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/calendar/connections/status"
[
  {
    "calendarId": "string",
    "connected": true,
    "lastSyncAt": "2019-08-24T14:15:22Z",
    "lastSyncError": "string",
    "lastSyncStatus": "PENDING",
    "provider": "GOOGLE"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Sync all connected providers if last sync was more than 5 minutes ago

POST
/crm/calendar/connections/sync-if-stale

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/crm/calendar/connections/sync-if-stale"
[
  {
    "error": "string",
    "eventsCreated": 0,
    "eventsDeleted": 0,
    "eventsPushed": 0,
    "eventsUpdated": 0,
    "provider": "GOOGLE",
    "success": true
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Disconnect a calendar provider

DELETE
/crm/calendar/connections/{provider}/disconnect

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

provider*string
Value in"GOOGLE" | "OUTLOOK"

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/crm/calendar/connections/GOOGLE/disconnect"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Trigger manual sync

POST
/crm/calendar/connections/{provider}/sync

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

provider*string
Value in"GOOGLE" | "OUTLOOK"

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/crm/calendar/connections/GOOGLE/sync"
{
  "error": "string",
  "eventsCreated": 0,
  "eventsDeleted": 0,
  "eventsPushed": 0,
  "eventsUpdated": 0,
  "provider": "GOOGLE",
  "success": true
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Brochure Widget Config

Previous Page

Calendar Events

Next Page