List Events with Google Calendar API on New Appointment (Instant) from Acuity Scheduling API

Pipedream makes it easy to connect APIs for Google Calendar, Acuity Scheduling and 2,900+ other apps remarkably fast.

Trigger workflow on

New Appointment (Instant) from the Acuity Scheduling API

Next, do this

List Events with the Google Calendar API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Acuity Scheduling trigger and Google Calendar action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Appointment (Instant) trigger
1. Connect your Acuity Scheduling account
Configure the List Events action
1. Connect your Google Calendar account
2. Optional- Select a Calendar ID
3. Optional- Configure iCal UID
4. Optional- Configure Max Attendees
5. Optional- Configure Max Results
6. Optional- Select a Order By
7. Optional- Configure Private extended property
8. Optional- Configure Query
9. Optional- Configure Shared Extended Property
10. Optional- Configure Show Deleted
11. Optional- Configure Show Hidden Invitations
12. Optional- Configure Single Events
13. Optional- Configure Max Time
14. Optional- Configure Min time
15. Optional- Select a Time Zone
16. Optional- Configure Minimum Updated Time
17. Optional- Select one or more Event Types
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Appointment (Instant) on Acuity Scheduling

Description:Emit new event when an appointment is scheduled.

Version:0.0.3

Key:acuity_scheduling-new-appointment-instant

View on GitHub

Acuity Scheduling Overview#

Acuity Scheduling API allows you to tap into the functionality of Acuity Scheduling, a cloud-based appointment scheduling software. With this API on Pipedream, you can automate appointment creation, modifications, and cancellations, as well as sync customer data across your tech stack. The API lets you fetch detailed information about schedules, available time slots, and calendar events. Create dynamic, real-time integrations with CRMs, email marketing platforms, or payment gateways to streamline your scheduling and business processes.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "acuity_scheduling-new-appointment-instant",
  name: "New Appointment (Instant)",
  description: "Emit new event when an appointment is scheduled.",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEvent() {
      return "appointment.scheduled";
    },
    getSummary(details) {
      return `New appointment scheduled with Id: ${details.id}`;
    },
  },
  sampleEmit,
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Acuity Scheduling	`acuityScheduling`	`app`	This component uses the Acuity Scheduling app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.

Trigger Authentication#

Acuity Scheduling uses OAuth authentication. When you connect your Acuity Scheduling account, Pipedream will open a popup window where you can sign into Acuity Scheduling and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Acuity Scheduling API.

Pipedream requests the following authorization scopes when you connect your account:

api-v1

About Acuity Scheduling#

Online Appointment Scheduling

Action#

List Events on Google Calendar

Description:Retrieve a list of event from the Google Calendar. [See the documentation](https://developers.google.com/calendar/api/v3/reference/events/list)

Version:0.0.9

Key:google_calendar-list-events

View on GitHub

Google Calendar Overview#

The Google Calendar API lets you dip into the powerhouse of scheduling, allowing for the reading, creation, and manipulation of events and calendars directly from your applications. Through Pipedream, you can seamlessly integrate Google Calendar into a myriad of workflows, automating event management, syncing with other services, setting up custom reminders, or even collating data for reporting. The key here is to streamline your calendar-related processes, ensuring that your time management is as efficient and automated as possible.

Action Code#

import googleCalendar from "../../google_calendar.app.mjs";
import utils from "../../common/utils.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "google_calendar-list-events",
  name: "List Events",
  description: "Retrieve a list of event from the Google Calendar. [See the documentation](https://developers.google.com/calendar/api/v3/reference/events/list)",
  version: "0.0.9",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    googleCalendar,
    calendarId: {
      propDefinition: [
        googleCalendar,
        "calendarId",
      ],
    },
    iCalUID: {
      propDefinition: [
        googleCalendar,
        "iCalUID",
      ],
    },
    maxAttendees: {
      propDefinition: [
        googleCalendar,
        "maxAttendees",
      ],
    },
    maxResults: {
      propDefinition: [
        googleCalendar,
        "maxResults",
      ],
    },
    orderBy: {
      propDefinition: [
        googleCalendar,
        "orderBy",
      ],
      default: "",
    },
    privateExtendedProperty: {
      propDefinition: [
        googleCalendar,
        "privateExtendedProperty",
      ],
    },
    q: {
      propDefinition: [
        googleCalendar,
        "q",
      ],
    },
    sharedExtendedProperty: {
      propDefinition: [
        googleCalendar,
        "sharedExtendedProperty",
      ],
    },
    showDeleted: {
      propDefinition: [
        googleCalendar,
        "showDeleted",
      ],
    },
    showHiddenInvitations: {
      propDefinition: [
        googleCalendar,
        "showHiddenInvitations",
      ],
    },
    singleEvents: {
      propDefinition: [
        googleCalendar,
        "singleEvents",
      ],
    },
    timeMax: {
      propDefinition: [
        googleCalendar,
        "timeMax",
      ],
    },
    timeMin: {
      propDefinition: [
        googleCalendar,
        "timeMin",
      ],
    },
    timeZone: {
      propDefinition: [
        googleCalendar,
        "timeZone",
      ],
    },
    updatedMin: {
      propDefinition: [
        googleCalendar,
        "updatedMin",
      ],
    },
    eventTypes: {
      propDefinition: [
        googleCalendar,
        "eventTypes",
      ],
    },
  },
  async run({ $ }) {
    if (this.orderBy === "startTime" && !this.singleEvents) {
      throw new ConfigurationError("Single Events must be `true` to order by `startTime`");
    }

    const args = utils.filterEmptyValues({
      calendarId: this.calendarId,
      iCalUID: this.iCalUID,
      maxAttendees: this.maxAttendees,
      orderBy: this.orderBy || undefined,
      privateExtendedProperty: this.privateExtendedProperty,
      q: this.q,
      sharedExtendedProperty: this.sharedExtendedProperty,
      showDeleted: this.showDeleted,
      showHiddenInvitations: this.showHiddenInvitations,
      singleEvents: this.singleEvents,
      timeMax: this.timeMax,
      timeMin: this.timeMin,
      timeZone: this.timeZone,
      updatedMin: this.updatedMin,
      eventTypes: this.eventTypes,
    });

    const events = [];
    do {
      const {
        items, nextPageToken,
      } = await this.googleCalendar.listEvents(args);
      events.push(...items);
      args.pageToken = nextPageToken;
    } while (args.pageToken && (!this.maxResults || events.length < this.maxResults));
    if (events.length > this.maxResults) {
      events.length = this.maxResults;
    }

    $.export("$summary", `Successfully retrieved ${events.length} event${events.length === 1
      ? ""
      : "s"}`);

    return events;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Google Calendar	`googleCalendar`	`app`	This component uses the Google Calendar app.
Calendar ID	`calendarId`	`string`	Select a value from the drop down menu.
iCal UID	`iCalUID`	`string`	Specifies event ID in the iCalendar format to be included in the response. Optional.
Max Attendees	`maxAttendees`	`integer`	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.
Max Results	`maxResults`	`integer`	Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
Order By	`orderBy`	`string`	Select a value from the drop down menu:`{ "label": "startTime", "value": "startTime" }{ "label": "updated", "value": "updated" }`
Private extended property	`privateExtendedProperty`	`string`	Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.
Query	`q`	`string`	Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
Shared Extended Property	`sharedExtendedProperty`	`string`	Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.
Show Deleted	`showDeleted`	`boolean`	Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
Show Hidden Invitations	`showHiddenInvitations`	`boolean`	Whether to include hidden invitations in the result. Optional. The default is False.
Single Events	`singleEvents`	`boolean`	Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
Max Time	`timeMax`	`string`	Upper bound (exclusive) for an event's time to filter by. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. Must be greater than Min Time.
Min time	`timeMin`	`string`	Lower bound (exclusive) for an event's time to filter by. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. Must be smaller than Max Time.
Time Zone	`timeZone`	`string`	Select a value from the drop down menu.
Minimum Updated Time	`updatedMin`	`string`	Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu:`defaultfocusTimeoutOfOfficeworkingLocation`

Action Authentication#

Google Calendar uses OAuth authentication. When you connect your Google Calendar account, Pipedream will open a popup window where you can sign into Google Calendar and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Calendar API.

Pipedream requests the following authorization scopes when you connect your account:

https://www.googleapis.com/auth/calendar.eventshttps://www.googleapis.com/auth/calendar.readonlyhttps://www.googleapis.com/auth/calendar.settings.readonlyemailprofile

About Google Calendar#

With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.

More Ways to Connect Google Calendar + Acuity Scheduling#

Other Popular Integrations#

Delete an Event with Google Calendar API on New Appointment (Instant) from Acuity Scheduling API

Acuity Scheduling + Google Calendar

List Events with Google Calendar API on New Appointment (Instant) from Acuity Scheduling API

Pipedream makes it easy to connect APIs for Google Calendar, Acuity Scheduling and 2,900+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,900+apps by most popular

1
-
24
of
2,900+
apps by most popular