Nylas · Schema

Nylas booking.pending notification object

Sent when a guest schedules a pending booking that requires confirmation. This schema describes `data.object` inside the Nylas notification envelope.

CalendarCommunicationsContactsEmailMessagingSchedulingA2A

Properties

Name Type Description
configuration_id string The Scheduler configuration used to create this booking.
booking_id string Unique identifier for the booking.
booking_ref string A human-readable booking reference string.
booking_type string The confirmation type for this booking.
booking_info object Details about the pending booking.
View JSON Schema on GitHub

JSON Schema

nylas-booking-pending.schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nylas/refs/heads/main/json-schema/nylas-booking-pending.schema.json",
  "title": "Nylas booking.pending notification object",
  "description": "Sent when a guest schedules a pending booking that requires confirmation. This schema describes `data.object` inside the Nylas notification envelope.",
  "type": "object",
  "properties": {
    "configuration_id": {
      "type": "string",
      "description": "The Scheduler configuration used to create this booking."
    },
    "booking_id": {
      "type": "string",
      "description": "Unique identifier for the booking."
    },
    "booking_ref": {
      "type": "string",
      "description": "A human-readable booking reference string."
    },
    "booking_type": {
      "type": "string",
      "description": "The confirmation type for this booking.",
      "enum": [
        "organizer-confirmation"
      ]
    },
    "booking_info": {
      "type": "object",
      "description": "Details about the pending booking.",
      "properties": {
        "event_id": {
          "type": "string",
          "description": "The calendar event ID created for this booking."
        },
        "start_time": {
          "type": "integer",
          "description": "Unix timestamp for the event start."
        },
        "end_time": {
          "type": "integer",
          "description": "Unix timestamp for the event end."
        },
        "participants": {
          "type": "array",
          "description": "List of booking participants. May be `null` when no participants are set.",
          "items": {
            "type": "object",
            "properties": {
              "email": {
                "type": "string",
                "format": "email",
                "description": "Participant email address."
              },
              "name": {
                "type": "string",
                "description": "Participant display name."
              }
            }
          },
          "nullable": true
        },
        "additional_fields": {
          "type": "object",
          "description": "Custom fields collected from the guest during booking. May be `null` if no custom fields were provided.",
          "additionalProperties": {
            "type": "string"
          },
          "nullable": true
        },
        "hide_cancellation_options": {
          "type": "boolean",
          "description": "Whether cancellation options are hidden from the guest."
        },
        "hide_rescheduling_options": {
          "type": "boolean",
          "description": "Whether rescheduling options are hidden from the guest."
        },
        "participant_rescheduling_url": {
          "type": "string",
          "description": "URL the guest can use to reschedule the booking."
        },
        "participant_cancellation_url": {
          "type": "string",
          "description": "URL the guest can use to cancel the booking."
        },
        "host_language": {
          "type": "string",
          "description": "Locale code for the host's language."
        },
        "guest_language": {
          "type": "string",
          "description": "Locale code for the guest's language."
        },
        "title": {
          "type": "string",
          "description": "Title of the booked event."
        },
        "duration": {
          "type": "integer",
          "description": "Event duration in minutes."
        },
        "location": {
          "type": "string",
          "description": "Meeting location or conferencing link."
        },
        "organizer_timezone": {
          "type": "string",
          "description": "IANA timezone of the organizer."
        },
        "guest_timezone": {
          "type": "string",
          "description": "IANA timezone of the guest."
        },
        "is_group_event": {
          "type": "boolean",
          "description": "Whether this is a group event with multiple attendees."
        },
        "organizer_calendar_id": {
          "type": "string",
          "description": "Calendar ID where the event was created."
        },
        "event_description": {
          "type": "string",
          "description": "Description text of the calendar event."
        },
        "event_html_link": {
          "type": "string",
          "description": "Link to view the event in the provider's calendar UI."
        },
        "ical_uid": {
          "type": "string",
          "description": "The iCalendar UID of the event."
        },
        "host_confirmation_url": {
          "type": "string",
          "description": "URL for the host to confirm a pending booking. Only present for bookings that require host confirmation."
        },
        "notetaker_id": {
          "type": "string",
          "description": "Notetaker bot ID if Notetaker is attached to this booking. Omitted when not applicable."
        }
      }
    }
  },
  "required": [
    "configuration_id",
    "booking_id",
    "booking_type",
    "booking_info"
  ],
  "x-nylas-trigger": "booking.pending",
  "x-nylas-category": "Scheduler",
  "x-provenance": {
    "method": "authored",
    "publisher": "Nylas",
    "source": "https://developer.nylas.com/docs/reference/notifications/scheduler/booking-pending/",
    "derived_from": "nylas/developer.nylas.com@a7995fb6:src/_component-data/notification-schemas.json",
    "generated": "2026-09-28"
  },
  "examples": [
    {
      "configuration_id": "<CONFIGURATION_ID>",
      "booking_id": "<BOOKING_ID>",
      "booking_ref": "<BOOKING_REFERENCE>",
      "booking_type": "organizer-confirmation",
      "booking_info": {
        "event_id": "<EVENT_ID>",
        "start_time": 1719842400,
        "end_time": 1719846000,
        "participants": [
          {
            "email": "john.doe@example.com",
            "name": "John Doe"
          },
          {
            "email": "jane.smith@example.com",
            "name": "Jane Smith"
          }
        ],
        "additional_fields": {
          "phone": "+1-415-555-0199",
          "company": "Acme Corp"
        },
        "hide_cancellation_options": false,
        "hide_rescheduling_options": false,
        "participant_rescheduling_url": "https://example.com/reschedule/<BOOKING_REFERENCE>",
        "participant_cancellation_url": "https://example.com/cancel/<BOOKING_REFERENCE>",
        "host_language": "en",
        "guest_language": "en",
        "title": "[PENDING] Project sync",
        "duration": 60,
        "location": "https://meet.google.com/abc-defg-hij",
        "organizer_timezone": "America/New_York",
        "guest_timezone": "America/New_York",
        "is_group_event": false,
        "organizer_calendar_id": "primary",
        "event_description": "Let's discuss the project details",
        "event_html_link": "https://calendar.google.com/event?eid=abc123",
        "ical_uid": "040000008200E00074C5B7101A82E0080000000000000000000000000000000000",
        "host_confirmation_url": "https://example.com/confirm/<BOOKING_REFERENCE>"
      }
    }
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/nylas-booking-pending.schema"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.