HAhappyscribe
Calendar connections

Get a calendar connect link

The link and its outcome, for when you'd rather not read it from return_url or the webhook.

get/calendar_connect_links/{id}

Request

  • Base URL
    https://www.happyscribe.com/api/v1
  • Auth
    API key in header Authorization

Response

The link.

idstring

Stable typed ID beginning with ccl_.

objectstring

Always calendar_connect_link.

workspace_idstring

Workspace ID, beginning with wks_. Treat it as an opaque string.

member_idstring nullable

The member connecting, or null to create the member from the connected account.

provider'google' | 'microsoft'

The calendar to connect.

  • google: Google Calendar.
  • microsoft: Microsoft Outlook calendar.
return_urlstring

Where the browser returns after consent, with the outcome in the query string.

client_reference_idstring nullable

Your own reference, returned on the redirect.

urlstring nullable

The link to send the user to. null once it can no longer be opened.

expires_atstring date-time

When the link stops working, 24 hours after it was created.

status'open' | 'completed' | 'failed' | 'expired'
  • open: waiting for the user, including after they declined consent.
  • completed: the user connected their calendar; see calendar_connection_id.
  • failed: it could not connect; error says why.
  • expired: 24 hours went by.
calendar_connection_idstring nullable

The connection it made, once status is completed.

created_atstring date-time

When the link was created, in ISO 8601.

Example response

{
  "workspace_id": "wks_01k6a2r9s8x7c2dvq3m5n6p4ab",
  "member_data": {
    "metadata": {
      "gurusup_user_id": "usr_8812"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.