List Events with Microsoft Outlook Calendar API on New Booking with State from Timekit API

Pipedream makes it easy to connect APIs for Microsoft Outlook Calendar, Timekit and 2,800+ other apps remarkably fast.

Trigger workflow on

New Booking with State from the Timekit API

Next, do this

List Events with the Microsoft Outlook 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 Timekit trigger and Microsoft Outlook 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 Booking with State trigger
1. Connect your Timekit account
2. Select a Graph Type
3. Select a Booking State
4. Optional- Configure Secret
Configure the List Events action
1. Connect your Microsoft Outlook Calendar account
2. Optional- Configure Filter
3. Optional- Configure Order By
4. Optional- Configure Max Results
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 Booking with State on Timekit

Description:Emit new event when a booking has a specific state. [See the docs](https://developers.timekit.io/reference/graphs).

Version:0.0.1

Key:timekit-booking-with-state

View on GitHub

Timekit Overview#

Timekit is a flexible booking and resource management API that enables developers to create and manage appointments and calendars. With Timekit, you can automate the scheduling process, sync calendars, manage bookings, and craft customized booking experiences. Using Pipedream, you can leverage Timekit to create efficient workflows that automate scheduling-related tasks, trigger actions based on calendar events, and integrate with various other services for a seamless operational ecosystem.

Trigger Code#

import timekit from "../../timekit.app.mjs";
import crypto from "crypto";

const docLink = "https://developers.timekit.io/reference/graphs";

export default {
  key: "timekit-booking-with-state",
  name: "New Booking with State",
  description: `Emit new event when a booking has a specific state. [See the docs](${docLink}).`,
  version: "0.0.1",
  type: "source",
  props: {
    timekit,
    db: "$.service.db",
    http: "$.interface.http",
    graph: {
      propDefinition: [
        timekit,
        "graph",
      ],
    },
    state: {
      propDefinition: [
        timekit,
        "state",
        (c) => ({
          graph: c.graph,
        }),
      ],
    },
    secret: {
      type: "string",
      label: "Secret",
      description: "Configured secret to verify webhook events. If left blank, no verification will be done. Navigate to API Settings > Keys and look for the last card on the page. The secret shown there is the key you'll use",
      secret: true,
      optional: true,
    },
  },
  hooks: {
    async activate() {
      console.log("Creating webhook...");
      const response = await this.timekit.createWebhook({
        data: {
          url: this.http.endpoint,
          graph: this.graph,
          state: this.state,
          method: "post",
        },
      });
      const id = response.meta.message.split("id ")[1];
      this._setWebhookId(id);
    },
    async deactivate() {
      const id = this._getWebhookId();
      await this.timekit.deleteWebhook({
        id,
      });
      console.log(`Webhook ${id} was deleted successfully`);
    },
  },
  methods: {
    _getWebhookId() {
      return this.db.get("webhookId");
    },
    _setWebhookId(id) {
      this.db.set("webhookId", id);
    },
    verifySecret(payload, header) {
      if (this.secret) {
        const hash = crypto
          .createHmac("sha256", this.secret)
          .update(payload)
          .digest("hex");
        return hash === header;
      }
      return true;
    },
  },
  async run(event) {
    if (!this.verifySecret(event.bodyRaw, event.headers["x-timekit-signature"])) {
      console.log("Secret verification has failed for the incoming event. Skipping...");
      return;
    }

    const {
      id,
      description,
      updated_at: ts,
    } = event.body;

    this.$emit(event.body, {
      id,
      summary: `New ${this.graph} booking ${this.state}: ${description}`,
      ts,
    });
  },
};

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
Timekit	`timekit`	`app`	This component uses the Timekit 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.
Graph Type	`graph`	`string`	Select a value from the drop down menu:`instantinstant_paymentconfirm_declinegroup_ownergroup_customergroup_customer_paymentreservation`
Booking State	`state`	`string`	Select a value from the drop down menu.
Secret	`secret`	`string`	Configured secret to verify webhook events. If left blank, no verification will be done. Navigate to API Settings > Keys and look for the last card on the page. The secret shown there is the key you'll use

Trigger Authentication#

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

You can find your app's API key in the Admin Dashboard under "API settings".

About Timekit#

Timekit lets you build scalable and flexible booking experiences and scheduling flows that grow your business.

Action#

List Events on Microsoft Outlook Calendar

Description:Get a list of event objects in the user's mailbox. [See the documentation](https://learn.microsoft.com/en-us/graph/api/user-list-events)

Version:0.0.3

Key:microsoft_outlook_calendar-list-events

View on GitHub

Microsoft Outlook Calendar Overview#

The Microsoft Outlook Calendar API provides programmatic access to a user's calendar events, allowing for the creation, retrieval, update, and deletion of events within Outlook calendars. With Pipedream, you can integrate these calendar operations into workflows that automate tasks involving scheduling, event management, and coordination with other services. Whether it's triggering actions when new events are created, syncing calendar events with other scheduling tools, or managing attendees, Pipedream's serverless platform enables you to build custom automations with minimal overhead.

Action Code#

import microsoftOutlook from "../../microsoft_outlook_calendar.app.mjs";

export default {
  key: "microsoft_outlook_calendar-list-events",
  name: "List Events",
  description: "Get a list of event objects in the user's mailbox. [See the documentation](https://learn.microsoft.com/en-us/graph/api/user-list-events)",
  version: "0.0.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    microsoftOutlook,
    filter: {
      type: "string",
      label: "Filter",
      description: "Filters results. For example, `contains(subject, 'meet for lunch?')` will include events whose title contains ‘meet for lunch?’. [See documentation](https://learn.microsoft.com/en-us/graph/filter-query-parameter) for the full list of operations.",
      optional: true,
    },
    orderBy: {
      type: "string",
      label: "Order By",
      description: "Orders results. For example, `displayName desc` will sort the results by Display Name in decending order.",
      default: "createdDateTime desc",
      optional: true,
    },
    maxResults: {
      type: "integer",
      label: "Max Results",
      description: "The maximum number of results to return",
      optional: true,
    },
  },
  async run({ $ }) {
    const { value = [] } = await this.microsoftOutlook.listCalendarEvents({
      $,
      params: {
        "$orderby": this.orderBy,
        "$filter": this.filter,
        "$top": this.maxResults,
      },
    });

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

    return value;
  },
};

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
Microsoft Outlook Calendar	`microsoftOutlook`	`app`	This component uses the Microsoft Outlook Calendar app.
Filter	`filter`	`string`	Filters results. For example, `contains(subject, 'meet for lunch?')` will include events whose title contains ‘meet for lunch?’. See documentation for the full list of operations.
Order By	`orderBy`	`string`	Orders results. For example, `displayName desc` will sort the results by Display Name in decending order.
Max Results	`maxResults`	`integer`	The maximum number of results to return

Action Authentication#

Microsoft Outlook Calendar uses OAuth authentication. When you connect your Microsoft Outlook Calendar account, Pipedream will open a popup window where you can sign into Microsoft Outlook 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 Microsoft Outlook Calendar API.

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

User.Reademailoffline_accessopenidprofileCalendars.ReadWrite

About Microsoft Outlook Calendar#

The calendar and scheduling component of Outlook that is fully integrated with email, contacts, and other features

More Ways to Connect Microsoft Outlook Calendar + Timekit#

Other Popular Integrations#

Create Calendar Event with Microsoft Outlook Calendar API on New Booking with State from Timekit API

Timekit + Microsoft Outlook Calendar

Try it

Delete Calendar Event with Microsoft Outlook Calendar API on New Booking with State from Timekit API

Timekit + Microsoft Outlook Calendar

Try it

Update Calendar Event with Microsoft Outlook Calendar API on New Booking with State from Timekit API

Timekit + Microsoft Outlook Calendar

Try it

Get Free/Busy Schedule with Microsoft Outlook Calendar API on New Booking with State from Timekit API

Timekit + Microsoft Outlook Calendar

Try it

Popular Triggers#

New Booking with State from the Timekit API

Emit new event when a booking has a specific state. See the docs

Try it

New Calendar Event (Instant) from the Microsoft Outlook Calendar API

Emit new event when a new Calendar event is created

Try it

New Calendar Event Update (Instant) from the Microsoft Outlook Calendar API

Emit new event when a Calendar event is updated

Try it

New Upcoming Calendar Event from the Microsoft Outlook Calendar API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it

Popular Actions#

Create Calendar Event with the Microsoft Outlook Calendar API

Create an event in the user's default calendar. See the documentation

Try it

Delete Calendar Event with the Microsoft Outlook Calendar API

Delete an event in the user's default calendar. See the documentation

Try it

Get Free/Busy Schedule with the Microsoft Outlook Calendar API

Get the free/busy availability information for a collection of users, distributions lists, or resources (rooms or equipment) for a specified time period. See the documentation

Try it

List Events with the Microsoft Outlook Calendar API

Get a list of event objects in the user's mailbox. See the documentation

Try it

Update Calendar Event with the Microsoft Outlook Calendar API

Update an event in the user's default calendar. See the documentation

Try it