Skip to content
Nappai Documentation

Calendar

Calendar is a tool that lets you manage your Microsoft Outlook calendar directly from the Nappai dashboard.
With it you can look up events, add new ones, change or delete existing events, and even create or modify whole calendars.

How it Works

When you use the Calendar component, Nappai talks to the Microsoft Outlook Calendar API.
It sends your request (for example, “create an event”) to Outlook, receives the response, and then passes that data back into your workflow.
All the heavy lifting—authenticating with Outlook, formatting dates, handling time zones—is handled for you.

Operations

This component offers several operations that you can select based on what you need to do. You can only use one operation at a time:

  • Get Calendar Events: Find events that match a date range or search query.
  • Create Event: Add a new event to a calendar.
  • Update Event: Change details of an existing event.
  • Delete Event: Remove an event from a calendar.
  • Get Event by ID: Retrieve a single event using its unique ID.
  • Get Calendars: List all calendars you have access to.
  • Create Calendar: Make a new calendar.
  • Update Calendar: Rename or modify an existing calendar.
  • Delete Calendar: Remove a calendar.
  • Get Calendar by ID: Get details of a specific calendar.

To use the component, first select the operation you need in the Operation field.

Inputs

Mapping Mode

This component has a special mode called Mapping Mode. When you enable this mode using the toggle switch, an additional input called Mapping Data is activated, and each input field offers you three different ways to provide data:

  • Fixed: You type the value directly into the field.
  • Mapped: You connect the output of another component to use its result as the value.
  • Javascript: You write Javascript code to dynamically calculate the value.

This flexibility allows you to create more dynamic and connected workflows.

Input Fields

The following fields are available to configure this component. Each field may be visible in different operations:

  • Search End Time: The last date and time to look for events.

    • Visible in: Get Calendar Events, Create Event, Update Event

  • Search Start Time: The first date and time to look for events.

    • Visible in: Get Calendar Events, Create Event, Update Event

  • Operation: Choose what you want the component to do, such as creating or deleting an event.

    • Visible in: Get Calendar Events, Create Event, Update Event, Delete Event, Get Event by ID, Get Calendars, Create Calendar, Update Calendar, Delete Calendar, Get Calendar by ID

  • Attendees: Comma‑separated list of email addresses that should be invited to the event.

    • Visible in: Create Event

  • Event Body: The detailed description or notes for the event.

    • Visible in: Create Event, Update Event

  • Calendar ID: The unique ID of the calendar you want to work with.

    • Visible in: Update Calendar, Delete Calendar, Get Calendar by ID

  • Calendar Name: The name you want to give to a new calendar or change an existing one.

    • Visible in: Create Calendar, Update Calendar

  • Calendar: Select which Outlook calendar to use for the operation.

    • Visible in: Get Calendar Events, Create Event, Update Event, Delete Event, Get Event by ID

  • Event ID: The unique ID of the event you want to modify or delete.

    • Visible in: Update Event, Delete Event, Get Event by ID

  • Is Online Meeting: Check this if the event will be an online meeting (like Teams).

    • Visible in: Create Event

  • Location: Where the event will take place, or the link for an online meeting.

    • Visible in: Create Event, Update Event

  • Mapping Mode: Enable mapping mode to process multiple data records in batch.

    • Visible in: Get Calendar Events, Create Event, Update Event, Delete Event, Get Event by ID, Get Calendars, Create Calendar, Update Calendar, Delete Calendar, Get Calendar by ID

  • Mode: Choose between a simplified setup with default options or full control with advanced settings.

    • Visible in: Get Calendar Events, Create Event, Update Event, Get Calendar by ID

  • Search Query: A keyword or phrase to filter events by subject or content.

    • Visible in: Get Calendar Events

  • Event Subject: The title of the event.

    • Visible in: Create Event, Update Event

  • Time Zone: The time zone for the event, e.g., ‘UTC’ or ‘America/New_York’.

    • Visible in: Create Event, Update Event

  • Event Type: Choose whether the event is a regular event or an online meeting.

    • Visible in: Create Event

  • Tool Name: The name of the tool that will be shown to the agent when this component is used as a tool.

    • Visible in: Get Calendar Events, Create Event, Update Event, Delete Event, Get Event by ID, Get Calendars, Create Calendar, Update Calendar, Delete Calendar, Get Calendar by ID

  • Tool Description: A detailed description of what this tool does, helping the agent decide when to use it.

    • Visible in: Get Calendar Events, Create Event, Update Event, Delete Event, Get Event by ID, Get Calendars, Create Calendar, Update Calendar, Delete Calendar, Get Calendar by ID

  • Tools arguments metadata: Defines the arguments metadata for the tools.

    • Visible in: Get Calendar Events, Create Event, Update Event, Delete Event, Get Event by ID, Get Calendars, Create Calendar, Update Calendar, Delete Calendar, Get Calendar by ID

Credential
This component requires a Microsoft Outlook credential.

  1. Go to the Credentials section of Nappai and create a new Microsoft Outlook credential.
  2. In the component, select that credential from the Credential dropdown.
    (The credential fields such as Client ID, Client Secret, Tenant ID, and Microsoft Outlook Access are handled automatically and do not appear in the input list.)

Outputs

  • Data: The raw data returned from Outlook (e.g., event details, calendar list).
  • Tool: A formatted tool object that can be used by an AI agent.

Usage Example

Creating a New Event

  1. Drag the Calendar component onto the canvas.
  2. Set Operation to Create Event.
  3. Choose a Calendar from the dropdown.
  4. Fill in Event Subject, Event Body, Location, and Attendees.
  5. Set Time Zone to your local zone (e.g., America/New_York).
  6. (Optional) Check Is Online Meeting if it’s a virtual meeting.
  7. Click Run.
    The component will create the event in Outlook and return the event details in the Data output.

Getting Events in a Date Range

  1. Set Operation to Get Calendar Events.
  2. Choose a Calendar.
  3. Enter Search Start Time and Search End Time (e.g., 2024-10-01T09:00:00 to 2024-10-01T17:00:00).
  4. (Optional) Add a Search Query like team meeting.
  5. Run the component.
    The Data output will contain all events that match the criteria.
  • OutlookMailComponent – Send and manage Outlook emails.
  • OutlookContactComponent – Manage Outlook contacts.
  • GoogleCalendarComponent – Similar calendar operations for Google Calendar.

Tips and Best Practices

  • Use Mapping Mode when you need to process many events at once (e.g., batch‑creating events from a spreadsheet).
  • Always set the Time Zone to avoid confusion when scheduling across regions.
  • Use Search Query to quickly filter events by keywords.
  • Keep your Microsoft Outlook credential secure; it contains sensitive tokens.
  • When creating online meetings, check Is Online Meeting and Event Type to ensure the meeting link is generated.

Security Considerations

  • Credentials are stored encrypted in Nappai and never exposed in logs.
  • The component only sends the data you provide to Outlook; no additional data is transmitted.
  • Use the Mapping Mode carefully to avoid unintentionally exposing sensitive information in batch operations.