Get event - Automate.ax

googleCalendar.getEvent returns an event’s schedule, attendees, conferencing, recurrence, and metadata by ID or Calendar URL.

Example

import { automation, onDashboardRun } from "automate.ax"
import { googleCalendar } from "automate.ax/google-calendar"

export default automation("Load a planning event", () => {
  onDashboardRun({ title: "Load a planning event" })

  googleCalendar.getEvent({
    calendar: "Team Calendar",
    event: "https://calendar.google.com/calendar/event?eid=...",
    timeZone: "America/Los_Angeles",
  })
})

Inputs

Property	Type	Required	Default	Description
`event`	`string`	Yes	None	Immutable event ID or standard Google Calendar event URL.
`calendar`	`string`	No	`"primary"`	Exact visible calendar title or ID containing the event.
`maxAttendees`	`number`	No	Provider default	Maximum attendees returned.
`timeZone`	`string`	No	Calendar default	Response time zone from the `IANA` database.
Second argument: `{ account }`	`string \| IntegrationAccountReference<"google">`	No	Project default	Google Account binding to use.

Every action input accepts a compatible Signal.

Output

Returns a Signal<CalendarEvent>:

interface CalendarEvent {
  id: string
  calendarId: string
  summary: string
  description?: string
  location?: string
  status: "confirmed" | "tentative" | "cancelled"
  start?: { date?: string; dateTime?: string; timeZone?: string }
  end?: { date?: string; dateTime?: string; timeZone?: string }
  attendees: Array<{
    email: string
    displayName?: string
    responseStatus?: "needsAction" | "declined" | "tentative" | "accepted"
    optional?: boolean
    resource?: boolean
    organizer: boolean
    self: boolean
  }>
  attendeesOmitted: boolean
  attachments: Array<{
    fileUrl: string
    fileId?: string
    title?: string
    mimeType?: string
    iconLink?: string
  }>
  conference?: {
    conferenceId?: string
    creationStatus?: "pending" | "success" | "failure"
    name?: string
    entryPoints: Array<{
      type: string
      uri: string
      label?: string
      passcode?: string
    }>
  }
  hangoutLink?: string
  htmlLink?: string
  creator?: { email?: string; displayName?: string; self: boolean }
  organizer?: { email?: string; displayName?: string; self: boolean }
  recurrence: string[]
  recurringEventId?: string
  originalStart?: { date?: string; dateTime?: string; timeZone?: string }
  reminders: {
    useDefault: boolean
    overrides: Array<{ method: "email" | "popup"; minutes: number }>
  }
  extendedProperties: {
    private: Record<string, string>
    shared: Record<string, string>
  }
  colorId?: string
  createdAt?: string
  updatedAt?: string
  iCalUID?: string
  sequence: number
  transparency: "opaque" | "transparent"
  visibility: "default" | "public" | "private" | "confidential"
  type:
    | "birthday"
    | "default"
    | "focusTime"
    | "fromGmail"
    | "outOfOffice"
    | "workingLocation"
  guestsCanInviteOthers: boolean
  guestsCanModify: boolean
  guestsCanSeeOtherGuests: boolean
}

All-day events populate start.date and end.date, with an exclusive end date. attendeesOmitted is true when Google returns a partial attendee list, such as when you set maxAttendees. The action decodes a URL to its provider event ID. Unrelated URLs fail.