Google: Creates an event
Google calendarEvents.calendarEventsInsert: arguments, response, policy and SDK examples.
← calendar_events operations · Get started · OpenAPI downloads
Contract 2026-10-27 · Operation google.calendar_events_insert
Provider route: POST /calendar/v3/calendars/{calendarId}/events. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/google with npm, or alter-sdk-google with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { GoogleIntegration } from "@alter-ai/google";
async function execute(input: Parameters<GoogleIntegration["calendarEvents"]["calendarEventsInsert"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new GoogleIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.calendarEvents.calendarEventsInsert(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_google import GoogleIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = GoogleIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.calendar_events.calendar_events_insert(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.calendarId | string | Required within parent | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the “primary” keyword. |
query | object | Optional | Additional keys: not allowed |
query.fields | string | Optional | Selector specifying which fields to include in a partial response. |
query.prettyPrint | boolean | Optional | Returns response with indentations and line breaks. Default: true |
query.quotaUser | string | Optional | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
query.userIp | string | Optional | Deprecated. Please use quotaUser instead. |
query.conferenceDataVersion | integer | Optional | Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event’s body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. Format: int32 Maximum: 1 Minimum: 0 |
query.eventLabelVersion | integer | Optional | Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event’s body. In this case, the colorId field is ignored. The default is 0. Format: int32 Maximum: 1 Minimum: 0 |
query.maxAttendees | integer | Optional | The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. Format: int32 Minimum: 1 |
query.sendNotifications | boolean | Optional | Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false. |
query.sendUpdates | string | Optional | Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false. One of: all, externalOnly, none |
query.supportsAttachments | boolean | Optional | Whether API client performing operation supports event attachments. Optional. The default is False. |
body | Model | Required within parent | Expand Creates an event — request body — body |
Referenced models: Creates an event — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Creates an event — response body |
Referenced models: Creates an event — response body
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: google.calendar_events_insert. Catalog operation: calendar.events.insert. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.events", "https://www.googleapis.com/auth/calendar.events.owned"]