Export Query with Format with Metabase API on New Upcoming Event Alert from Google Calendar API

Pipedream makes it easy to connect APIs for Metabase, Google Calendar and 3,000+ other apps remarkably fast.

Trigger workflow on

New Upcoming Event Alert from the Google Calendar API

Next, do this

Export Query with Format with the Metabase 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 Google Calendar trigger and Metabase action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Upcoming Event Alert trigger
1. Connect your Google Calendar account
2. Configure Pipedream API Key
3. Optional- Select a Calendar ID
4. Optional- Select one or more Event Types
5. Configure Minutes Before
Configure the Export Query with Format action
1. Connect your Metabase account
2. Select a Card ID
3. Select a Export Format
4. Optional- Configure Format Rows
5. Optional- Configure Pivot Results
6. Optional- Configure Parameters
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 Upcoming Event Alert on Google Calendar

Description:Emit new event based on a time interval before an upcoming event in the calendar.

Version:0.1.0

Key:google_calendar-upcoming-event-alert

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.

Trigger Code#

import googleCalendar from "../../google_calendar.app.mjs";
import taskScheduler from "../common/taskScheduler.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "google_calendar-upcoming-event-alert",
  name: "New Upcoming Event Alert",
  description: "Emit new event based on a time interval before an upcoming event in the calendar.",
  version: "0.1.0",
  type: "source",
  props: {
    googleCalendar,
    db: "$.service.db",
    http: "$.interface.http",
    pipedreamApiKey: {
      type: "string",
      label: "Pipedream API Key",
      description: "[Click here to find your Pipedream API key](https://pipedream.com/settings/user)",
      secret: true,
    },
    calendarId: {
      propDefinition: [
        googleCalendar,
        "calendarId",
      ],
    },
    eventTypes: {
      propDefinition: [
        googleCalendar,
        "eventTypes",
      ],
    },
    time: {
      type: "integer",
      label: "Minutes Before",
      description: "Number of minutes to trigger before the start of the calendar event.",
      min: 0,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.time > 0) {
      props.timer = {
        type: "$.interface.timer",
        description: "Poll the API to schedule alerts for any newly created events",
        default: {
          intervalSeconds: 60 * this.time,
        },
      };
    }
    return props;
  },
  hooks: {
    async deactivate() {
      const ids = this._getScheduledEventIds();
      if (!ids?.length) {
        return;
      }
      for (const id of ids) {
        if (await this.deleteScheduledEvent({
          body: {
            id,
          },
        }, this.pipedreamApiKey)) {
          console.log("Cancelled scheduled event");
        }
      }
      this._setScheduledEventIds();
    },
  },
  methods: {
    ...taskScheduler.methods,
    _getScheduledEventIds() {
      return this.db.get("scheduledEventIds");
    },
    _setScheduledEventIds(ids) {
      this.db.set("scheduledEventIds", ids);
    },
    _getScheduledCalendarEventIds() {
      return this.db.get("scheduledCalendarEventIds");
    },
    _setScheduledCalendarEventIds(ids) {
      this.db.set("scheduledCalendarEventIds", ids);
    },
    _hasDeployed() {
      const result = this.db.get("hasDeployed");
      this.db.set("hasDeployed", true);
      return result;
    },
    subtractMinutes(date, minutes) {
      return date.getTime() - minutes * 60000;
    },
    async getCalendarEvents() {
      const calendarEvents = [];
      const params = {
        returnOnlyData: false,
        calendarId: this.calendarId,
        eventTypes: this.eventTypes,
      };
      do {
        const {
          data: {
            items, nextPageToken,
          },
        } = await this.googleCalendar.listEvents(params);
        if (items?.length) {
          calendarEvents.push(...items);
        }
        params.pageToken = nextPageToken;
      } while (params.pageToken);
      return calendarEvents;
    },
  },
  async run(event) {
    // self subscribe only on the first time
    if (!this._hasDeployed()) {
      await this.selfSubscribe(this.pipedreamApiKey);
    }

    const scheduledEventIds = this._getScheduledEventIds() || [];

    // incoming scheduled event
    if (event.$channel === this.selfChannel()) {
      const remainingScheduledEventIds = scheduledEventIds.filter((id) => id !== event["$id"]);
      this._setScheduledEventIds(remainingScheduledEventIds);
      this.emitEvent(event, `Upcoming ${event.summary
        ? event.summary + " "
        : ""}event`);
      return;
    }

    // schedule new events
    const scheduledCalendarEventIds = this._getScheduledCalendarEventIds() || {};
    const calendarEvents = await this.getCalendarEvents();

    for (const calendarEvent of calendarEvents) {
      const startTime = calendarEvent.start
        ? (new Date(calendarEvent.start.dateTime || calendarEvent.start.date))
        : null;
      if (!startTime
        || startTime.getTime() < Date.now()
        || scheduledCalendarEventIds[calendarEvent.id])
      {
        continue;
      }
      const later = new Date(this.subtractMinutes(startTime, this.time));

      const scheduledEventId = this.emitScheduleEvent(calendarEvent, later);
      scheduledEventIds.push(scheduledEventId);
      scheduledCalendarEventIds[calendarEvent.id] = true;
    }
    this._setScheduledEventIds(scheduledEventIds);
    this._setScheduledCalendarEventIds(scheduledCalendarEventIds);
  },
  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
Google Calendar	`googleCalendar`	`app`	This component uses the Google Calendar 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.
Pipedream API Key	`pipedreamApiKey`	`string`	Click here to find your Pipedream API key
Calendar ID	`calendarId`	`string`	Select a value from the drop down menu.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu:`defaultfocusTimeoutOfOfficeworkingLocation`
Minutes Before	`time`	`integer`	Number of minutes to trigger before the start of the calendar event.

Trigger 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.

Action#

Export Query with Format on Metabase

Description:Execute a saved question/card with parameters and export results in the specified format (CSV, JSON, XLSX, or API). [See the documentation](https://www.metabase.com/docs/latest/api#tag/apicard/post/api/card/%7Bcard-id%7D/query).

Version:0.0.1

Key:metabase-export-query-with-format

View on GitHub

Metabase Overview#

The Metabase API opens a gateway to interact with Metabase programmatically, enabling you to automate reporting, dashboards, and data analysis operations. With Pipedream, you can harness this API to trigger workflows, manipulate data, and integrate with various other apps to create a seamless data ecosystem. Think of syncing Metabase insights with other tools, automating report generation, or reacting to events within your Metabase instance in real-time.

Action Code#

import app from "../../metabase.app.mjs";

export default {
  key: "metabase-export-query-with-format",
  name: "Export Query with Format",
  description: "Execute a saved question/card with parameters and export results in the specified format (CSV, JSON, XLSX, or API). [See the documentation](https://www.metabase.com/docs/latest/api#tag/apicard/post/api/card/%7Bcard-id%7D/query).",
  version: "0.0.1",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    app,
    cardId: {
      propDefinition: [
        app,
        "cardId",
      ],
    },
    exportFormat: {
      type: "string",
      label: "Export Format",
      description: "The format to export the query results in",
      options: [
        {
          label: "CSV",
          value: "csv",
        },
        {
          label: "JSON",
          value: "json",
        },
        {
          label: "XLSX",
          value: "xlsx",
        },
        {
          label: "API",
          value: "api",
        },
      ],
    },
    formatRows: {
      type: "boolean",
      label: "Format Rows",
      description: "Whether to format rows for display",
      optional: true,
      default: false,
    },
    pivotResults: {
      type: "boolean",
      label: "Pivot Results",
      description: "Whether to pivot the results",
      optional: true,
      default: false,
    },
    parameters: {
      type: "string[]",
      label: "Parameters",
      description: "Query parameters as JSON objects. Each parameter should be a JSON string with the parameter properties. Example: `{\"type\": \"category\", \"target\": [\"variable\", [\"template-tag\", \"parameter_name\"]], \"value\": \"your_value\"}`",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      app,
      cardId,
      exportFormat,
      formatRows,
      pivotResults,
      parameters,
    } = this;

    // Parse parameters from JSON strings to objects
    const parsedParameters = parameters?.map((param, index) => {
      if (typeof param === "string") {
        try {
          return JSON.parse(param);
        } catch (error) {
          throw new Error(`Invalid JSON in parameter at index ${index}: ${error.message}`);
        }
      }
      return param;
    });

    const response = await app.exportCardQuery({
      $,
      cardId,
      exportFormat,
      data: {
        format_rows: formatRows,
        pivot_results: pivotResults,
        ...(parsedParameters && parsedParameters.length > 0 && {
          parameters: parsedParameters,
        }),
      },
    });

    $.export("$summary", `Successfully exported query results as ${exportFormat.toUpperCase()}`);

    return response;
  },
};

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
Metabase	`app`	`app`	This component uses the Metabase app.
Card ID	`cardId`	`integer`	Select a value from the drop down menu.
Export Format	`exportFormat`	`string`	Select a value from the drop down menu:`{ "label": "CSV", "value": "csv" }{ "label": "JSON", "value": "json" }{ "label": "XLSX", "value": "xlsx" }{ "label": "API", "value": "api" }`
Format Rows	`formatRows`	`boolean`	Whether to format rows for display
Pivot Results	`pivotResults`	`boolean`	Whether to pivot the results
Parameters	`parameters`	`string[]`	Query parameters as JSON objects. Each parameter should be a JSON string with the parameter properties. Example: `{"type": "category", "target": ["variable", ["template-tag", "parameter_name"]], "value": "your_value"}`

Action Authentication#

Metabase uses API keys for authentication. When you connect your Metabase account, Pipedream securely stores the keys so you can easily authenticate to Metabase APIs in both code and no-code steps.

About Metabase#

Fast analytics with the friendly UX and integrated tooling to let your company explore data on their own.

More Ways to Connect Metabase + Google Calendar#

Other Popular Integrations#

Get Dashboard with Metabase API on New Cancelled Event from Google Calendar API

Google Calendar + Metabase

Export Query with Format with Metabase API on New Upcoming Event Alert from Google Calendar API

Pipedream makes it easy to connect APIs for Metabase, Google Calendar and 3,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular