Skip to main content

​
Quick Start

Install the plugin: 
pnpm install @corsair-dev/googlecalendar
Add the Google Calendar plugin to your Corsair instance:
corsair.ts
import { createCorsair } from "corsair";
import { googlecalendar } from "@corsair-dev/googlecalendar";

export const corsair = createCorsair({
    plugins: [
        googlecalendar({
            authType: "oauth_2",
        }),
    ],
});
Once configured, you can access the Google Calendar API through your Corsair instance: 
const events = await corsair.googlecalendar.api.events.getMany({
    calendarId: "primary",
});

​
Authentication

​
Supported Auth Types

The Google Calendar plugin uses OAuth 2.0 authentication exclusively.
  • oauth_2 (default) - OAuth 2.0 authentication

​
OAuth 2.0 Setup

Store your OAuth app credentials, then start the flow: 
pnpm corsair setup --googlecalendar client_id=your-client-id client_secret=your-client-secret
pnpm corsair auth --plugin=googlecalendar
The CLI will print an authorization URL — open it in a browser. Once you approve, tokens are saved automatically. See Get Credentials for step-by-step instructions on setting up OAuth 2.0. See Authentication for details on managing credentials.

​
Options

The Google Calendar plugin accepts the following configuration options:
OptionTypeDescription
authType'oauth_2'Authentication method (defaults to 'oauth_2')
credentialsobjectCredentials object with clientId and clientSecret
hooksobjectEndpoint hooks for custom logic
webhookHooksobjectWebhook hooks for event handling
For complete documentation on getting credentials, see the Plugin Credentials Guide.