Create Appointment with Microsoft Bookings API on Custom Interval from Schedule API

Pipedream makes it easy to connect APIs for Microsoft Bookings, Schedule and 3,000+ other apps remarkably fast.

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Create Appointment with the Microsoft Bookings 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 Schedule trigger and Microsoft Bookings action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Appointment action
1. Connect your Microsoft Bookings account
2. Select a Business
3. Select a Service
4. Select a Customer ID
5. Optional- Configure Customer Name
6. Optional- Configure Customer Email Address
7. Optional- Configure Customer Time Zone
8. Configure Start Date Time
9. Configure End Date Time
10. Configure Time Zone
11. Optional- Configure Customer Phone
12. Optional- Configure Customer Notes
13. Optional- Configure Is Location Online
14. Optional- Select one or more Staff Member IDs
15. Optional- Configure SMS Notifications Enabled
16. Optional- Configure Price
17. Optional- Select a Price Type
18. Optional- Configure Duration
19. Optional- Configure Maximum Attendees Count
20. Optional- Configure Pre-Buffer
21. Optional- Configure Post-Buffer
22. Optional- Configure Service Notes
23. Optional- Configure Additional Information
24. Optional- Configure Customer Can Manage Booking
25. Optional- Configure Opt Out of Customer Email
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#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

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

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create Appointment on Microsoft Bookings

Description:Creates a new appointment in a Microsoft Bookings business. [See the documentation](https://learn.microsoft.com/en-us/graph/api/bookingbusiness-post-appointments?view=graph-rest-1.0)

Version:0.0.1

Key:microsoft_bookings-create-appointment

View on GitHub

Action Code#

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

export default {
  key: "microsoft_bookings-create-appointment",
  name: "Create Appointment",
  description: "Creates a new appointment in a Microsoft Bookings business. [See the documentation](https://learn.microsoft.com/en-us/graph/api/bookingbusiness-post-appointments?view=graph-rest-1.0)",
  version: "0.0.1",
  type: "action",
  annotations: {
    readOnlyHint: false,
    destructiveHint: false,
    openWorldHint: true,
  },
  props: {
    app,
    businessId: {
      propDefinition: [
        app,
        "businessId",
      ],
    },
    serviceId: {
      propDefinition: [
        app,
        "serviceId",
        ({ businessId }) => ({
          businessId,
        }),
      ],
    },
    customerId: {
      propDefinition: [
        app,
        "staffMemberId",
        ({ businessId }) => ({
          businessId,
        }),
      ],
      label: "Customer ID",
      description: "Select an existing customer. **Important**: Customers must exist in the system before booking appointments.",
    },
    customerName: {
      type: "string",
      label: "Customer Name",
      description: "The name of the customer",
      optional: true,
    },
    customerEmailAddress: {
      type: "string",
      label: "Customer Email Address",
      description: "The SMTP address of the customer",
      optional: true,
    },
    customerTimeZone: {
      type: "string",
      label: "Customer Time Zone",
      description: "The customer's time zone (e.g., America/Chicago, UTC)",
      optional: true,
    },
    startDateTime: {
      type: "string",
      label: "Start Date Time",
      description: "The date and time when the appointment begins in ISO 8601 format (e.g., 2024-05-01T12:00:00)",
    },
    endDateTime: {
      type: "string",
      label: "End Date Time",
      description: "The date and time when the appointment ends in ISO 8601 format (e.g., 2024-05-01T13:00:00)",
    },
    timeZone: {
      type: "string",
      label: "Time Zone",
      description: "The time zone for the appointment (e.g., UTC, America/Chicago)",
    },
    customerPhone: {
      type: "string",
      label: "Customer Phone",
      description: "The phone number of the customer",
      optional: true,
    },
    customerNotes: {
      type: "string",
      label: "Customer Notes",
      description: "Notes from the customer associated with this appointment",
      optional: true,
    },
    isLocationOnline: {
      type: "boolean",
      label: "Is Location Online",
      description: "True indicates that the appointment will be held online",
      optional: true,
    },
    staffMemberIds: {
      type: "string[]",
      label: "Staff Member IDs",
      description: "The IDs of each staff member who is scheduled in this appointment",
      optional: true,
      propDefinition: [
        app,
        "staffMemberId",
        ({ businessId }) => ({
          businessId,
        }),
      ],
    },
    smsNotificationsEnabled: {
      type: "boolean",
      label: "SMS Notifications Enabled",
      description: "If SMS notifications will be sent to the customers for the appointment",
      optional: true,
    },
    price: {
      type: "string",
      label: "Price",
      description: "The regular price for the appointment",
      optional: true,
    },
    priceType: {
      type: "string",
      label: "Price Type",
      description: "The pricing structure for the appointment",
      optional: true,
      options: [
        "undefined",
        "fixedPrice",
        "startingAt",
        "hourly",
        "free",
        "priceVaries",
        "callUs",
        "notSet",
      ],
    },
    duration: {
      type: "string",
      label: "Duration",
      description: "The length of the appointment in ISO 8601 format (e.g., PT1H for 1 hour, PT30M for 30 minutes). If not specified, calculated from start/end times.",
      optional: true,
    },
    maximumAttendeesCount: {
      type: "integer",
      label: "Maximum Attendees Count",
      description: "The maximum number of customers allowed in this appointment",
      optional: true,
    },
    preBuffer: {
      type: "string",
      label: "Pre-Buffer",
      description: "Time to reserve before the appointment in ISO 8601 format (e.g., PT15M for 15 minutes)",
      optional: true,
    },
    postBuffer: {
      type: "string",
      label: "Post-Buffer",
      description: "Time to reserve after the appointment in ISO 8601 format (e.g., PT15M for 15 minutes)",
      optional: true,
    },
    serviceNotes: {
      type: "string",
      label: "Service Notes",
      description: "Notes from the staff member about this appointment",
      optional: true,
    },
    additionalInformation: {
      type: "string",
      label: "Additional Information",
      description: "Additional information sent to the customer when the appointment is confirmed",
      optional: true,
    },
    isCustomerAllowedToManageBooking: {
      type: "boolean",
      label: "Customer Can Manage Booking",
      description: "Indicates that the customer can manage bookings created by the staff",
      optional: true,
    },
    optOutOfCustomerEmail: {
      type: "boolean",
      label: "Opt Out of Customer Email",
      description: "If true, the customer doesn't wish to receive a confirmation for this appointment",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      app,
      businessId,
      serviceId,
      customerId,
      customerName,
      customerEmailAddress,
      customerTimeZone,
      startDateTime,
      endDateTime,
      timeZone,
      customerPhone,
      customerNotes,
      isLocationOnline,
      staffMemberIds,
      smsNotificationsEnabled,
      price,
      priceType,
      duration,
      maximumAttendeesCount,
      preBuffer,
      postBuffer,
      serviceNotes,
      additionalInformation,
      isCustomerAllowedToManageBooking,
      optOutOfCustomerEmail,
    } = this;

    if (!customerId) {
      throw new Error("Customer ID is required. Please select an existing customer.");
    }

    const content = {
      "@odata.type": "#microsoft.graph.bookingAppointment",
      "serviceId": serviceId,
      "customerTimeZone": customerTimeZone || timeZone,
      "startDateTime": {
        "@odata.type": "#microsoft.graph.dateTimeTimeZone",
        "dateTime": startDateTime,
        "timeZone": timeZone,
      },
      "endDateTime": {
        "@odata.type": "#microsoft.graph.dateTimeTimeZone",
        "dateTime": endDateTime,
        "timeZone": timeZone,
      },
      "customers": [
        {
          "@odata.type": "#microsoft.graph.bookingCustomerInformation",
          "customerId": customerId,
          ...(customerName && {
            "name": customerName,
          }),
          ...(customerEmailAddress && {
            "emailAddress": customerEmailAddress,
          }),
          ...(customerPhone && {
            "phone": customerPhone,
          }),
          "timeZone": customerTimeZone || timeZone,
        },
      ],
    };

    if (customerNotes) content.customerNotes = customerNotes;
    if (isLocationOnline !== undefined) {
      content.isLocationOnline = isLocationOnline;
    }
    if (staffMemberIds?.length > 0) content.staffMemberIds = staffMemberIds;
    if (smsNotificationsEnabled !== undefined) {
      content.smsNotificationsEnabled = smsNotificationsEnabled;
    }
    if (price) content.price = parseFloat(price);
    if (priceType) content.priceType = priceType;
    if (duration) content.duration = duration;
    if (maximumAttendeesCount) content.maximumAttendeesCount = maximumAttendeesCount;
    if (preBuffer) content.preBuffer = preBuffer;
    if (postBuffer) content.postBuffer = postBuffer;
    if (serviceNotes) content.serviceNotes = serviceNotes;
    if (additionalInformation) content.additionalInformation = additionalInformation;
    if (isCustomerAllowedToManageBooking !== undefined) {
      content.isCustomerAllowedToManageBooking = isCustomerAllowedToManageBooking;
    }
    if (optOutOfCustomerEmail !== undefined) {
      content.optOutOfCustomerEmail = optOutOfCustomerEmail;
    }

    try {
      const response = await app.createAppointment({
        businessId,
        content,
      });

      $.export("$summary", `Successfully created appointment for ${customerName}`);

      return response;
    } catch (error) {
      console.error("Error creating appointment:", error);
      console.error("Request payload:", JSON.stringify(content, null, 2));
      throw new Error(`Failed to create appointment: ${error.message || error.toString()}`);
    }
  },
};

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 Bookings	`app`	`app`	This component uses the Microsoft Bookings app.
Business	`businessId`	`string`	Select a value from the drop down menu.
Service	`serviceId`	`string`	Select a value from the drop down menu.
Customer ID	`customerId`	`string`	Select a value from the drop down menu.
Customer Name	`customerName`	`string`	The name of the customer
Customer Email Address	`customerEmailAddress`	`string`	The SMTP address of the customer
Customer Time Zone	`customerTimeZone`	`string`	The customer's time zone (e.g., America/Chicago, UTC)
Start Date Time	`startDateTime`	`string`	The date and time when the appointment begins in ISO 8601 format (e.g., 2024-05-01T12:00:00)
End Date Time	`endDateTime`	`string`	The date and time when the appointment ends in ISO 8601 format (e.g., 2024-05-01T13:00:00)
Time Zone	`timeZone`	`string`	The time zone for the appointment (e.g., UTC, America/Chicago)
Customer Phone	`customerPhone`	`string`	The phone number of the customer
Customer Notes	`customerNotes`	`string`	Notes from the customer associated with this appointment
Is Location Online	`isLocationOnline`	`boolean`	True indicates that the appointment will be held online
Staff Member IDs	`staffMemberIds`	`string[]`	Select a value from the drop down menu.
SMS Notifications Enabled	`smsNotificationsEnabled`	`boolean`	If SMS notifications will be sent to the customers for the appointment
Price	`price`	`string`	The regular price for the appointment
Price Type	`priceType`	`string`	Select a value from the drop down menu:`undefinedfixedPricestartingAthourlyfreepriceVariescallUsnotSet`
Duration	`duration`	`string`	The length of the appointment in ISO 8601 format (e.g., PT1H for 1 hour, PT30M for 30 minutes). If not specified, calculated from start/end times.
Maximum Attendees Count	`maximumAttendeesCount`	`integer`	The maximum number of customers allowed in this appointment
Pre-Buffer	`preBuffer`	`string`	Time to reserve before the appointment in ISO 8601 format (e.g., PT15M for 15 minutes)
Post-Buffer	`postBuffer`	`string`	Time to reserve after the appointment in ISO 8601 format (e.g., PT15M for 15 minutes)
Service Notes	`serviceNotes`	`string`	Notes from the staff member about this appointment
Additional Information	`additionalInformation`	`string`	Additional information sent to the customer when the appointment is confirmed
Customer Can Manage Booking	`isCustomerAllowedToManageBooking`	`boolean`	Indicates that the customer can manage bookings created by the staff
Opt Out of Customer Email	`optOutOfCustomerEmail`	`boolean`	If true, the customer doesn't wish to receive a confirmation for this appointment

Action Authentication#

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

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

emailoffline_accessopenidprofileBookings.Manage.AllBookings.Read.AllBookings.ReadWrite.AllBookingsAppointment.ReadWrite.All