# ing.opn.booking.eventType

> Something someone can book: a meeting, an appointment, a consultation. The record key is the slug in its booking link, such as intro in /alice.example.com/intro, so any valid record key works. Changing the link means a new record.

- Kind: record
- Record key: any
- Authority: booking.opn.ing
- Lexicon: 1
- Published by [opn.ing](https://lexicon.garden/identity/did:plc:fd7yovynbzbli5i7m6tu76cl), the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:fd7yovynbzbli5i7m6tu76cl/ing.opn.booking.eventType)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:fd7yovynbzbli5i7m6tu76cl/ing.opn.booking.eventType/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:fd7yovynbzbli5i7m6tu76cl/ing.opn.booking.eventType/analytics)

## Record (`ing.opn.booking.eventType`)

Type: record · key any

### Properties

- `allowPastReschedule` (boolean): Bookings that are over can still be rescheduled.
- `allowRescheduleCancelled` (boolean): A cancelled booking's reschedule link books a new time. Without it, the link shows the cancelled booking.
- `bookingLimits` (ref): The most bookings of this event type in a day, week, month or year.
  - Reference: `#periodLimits`
- `bookingWindow` (union): How far ahead it can be booked. Without one, 60 days.
  - One of: `#rolling`, `#dateRange`, `#unlimited`
- `bufferAfter` (integer): Minutes kept free after.
  - Constraints: minimum: 0, maximum: 1440
- `bufferBefore` (integer): Minutes kept free before.
  - Constraints: minimum: 0, maximum: 1440
- `cancellationReason` (string): Who must give a reason to cancel a booking. Without one, a reason is optional for everyone.
  - Constraints: maxLength: 16, knownValues: host | guest | both
- `createdAt` (string · datetime, required)
- `defaultDuration` (integer): Minutes. One of durations.
  - Constraints: minimum: 1, maximum: 1440
- `description` (string)
  - Constraints: maxLength: 20000, maxGraphemes: 2000
- `descriptionFacets` (array): Bold, italic and links in the description.
  - Constraints: maxLength: 200
  - `items` (ref)
    - Reference: `ing.opn.richtext.facet`
- `disableCancelling` (string): Who cannot cancel bookings: the host and guests, or guests only. Without one, everyone can.
  - Constraints: maxLength: 16, knownValues: everyone | guest
- `disableRescheduling` (ref): Who cannot reschedule bookings, and when. Without one, everyone can.
  - Reference: `#reschedulingLock`
- `durationLimits` (ref): The most minutes of this event type booked in a day, week, month or year.
  - Reference: `#periodLimits`
- `durations` (array, required): Minutes. One value means the guest has no choice.
  - Constraints: minLength: 1, maxLength: 12
  - `items` (integer)
    - Constraints: minimum: 1, maximum: 1440
- `eventName` (string): The title of each booking, with variables such as {scheduler} filled in. Without one, '{link_title} between {organiser} and {scheduler}'.
  - Constraints: maxLength: 2000, maxGraphemes: 200
- `fields` (ref): How the questions every booking asks are shown. Without them, as Opning words them.
  - Reference: `#fields`
- `firstSlotOnly` (boolean): Offer only the earliest open time of each day.
- `listed` (boolean): Shown on the booking page. An unlisted event type is still a public record.
- `locations` (array): Where it happens. With more than one, the guest chooses.
  - Constraints: maxLength: 10
  - `items` (union)
    - One of: `#videoCall`, `#phone`, `#inPerson`, `#link`
- `maxBookingsPerBooker` (integer): The most upcoming bookings one guest email can hold through this event type.
  - Constraints: minimum: 1, maximum: 1000
- `minimumNotice` (integer): Minutes between now and the earliest bookable time.
  - Constraints: minimum: 0
- `order` (array): Field names (name, email, notes, guests, rescheduleReason) and question keys in the order the booking page asks them. Any left out follow in the usual order.
  - Constraints: maxLength: 25
  - `items` (string)
    - Constraints: maxLength: 64
- `questions` (array): Asked in the order of `order`. Without one, after name, email, notes and guests, in this order.
  - Constraints: maxLength: 20
  - `items` (ref)
    - Reference: `#question`
- `requiresConfirmation` (boolean): Bookings wait for the host to accept them.
- `schedule` (string · at-uri): The ing.opn.availability.schedule to book against. Without one, the profile's default.
- `slotInterval` (integer): Minutes between possible start times. Without one, the duration.
  - Constraints: minimum: 5, maximum: 1440
- `title` (string, required)
  - Constraints: minLength: 1, maxLength: 1000, maxGraphemes: 100
- `weekStart` (string): The first day of the week in the booking page's calendar. Without one, the profile's.
  - Constraints: maxLength: 16, knownValues: monday | tuesday | wednesday | thursday | friday | saturday | sunday

## #dateRange (`ing.opn.booking.eventType#dateRange`)

Type: object

Only between two dates, inclusive.

### Properties

- `end` (string, required): A calendar date, YYYY-MM-DD.
  - Constraints: minLength: 10, maxLength: 10
- `start` (string, required): A calendar date, YYYY-MM-DD.
  - Constraints: minLength: 10, maxLength: 10

## #field (`ing.opn.booking.eventType#field`)

Type: object

### Properties

- `disableOnPrefill` (boolean)
- `hidden` (boolean)
- `label` (string)
  - Constraints: maxLength: 2000, maxGraphemes: 200
- `placeholder` (string)
  - Constraints: maxLength: 2000, maxGraphemes: 200
- `required` (boolean)

## #fields (`ing.opn.booking.eventType#fields`)

Type: object

The questions every booking asks. Name and email are always asked and required.

### Properties

- `email` (ref)
  - Reference: `#field`
- `guests` (ref)
  - Reference: `#field`
- `name` (ref)
  - Reference: `#field`
- `notes` (ref)
  - Reference: `#field`
- `rescheduleReason` (ref)
  - Reference: `#field`

## #inPerson (`ing.opn.booking.eventType#inPerson`)

Type: object

In person, at a public address.

### Properties

- `address` (ref, required)
  - Reference: `community.lexicon.location.address`

## #link (`ing.opn.booking.eventType#link`)

Type: object

A fixed link the host chooses to publish.

### Properties

- `label` (string)
  - Constraints: maxLength: 640, maxGraphemes: 64
- `uri` (string · uri, required)

## #periodLimits (`ing.opn.booking.eventType#periodLimits`)

Type: object

A limit for each period it names.

### Properties

- `day` (integer)
  - Constraints: minimum: 1, maximum: 100000
- `month` (integer)
  - Constraints: minimum: 1, maximum: 100000
- `week` (integer)
  - Constraints: minimum: 1, maximum: 100000
- `year` (integer)
  - Constraints: minimum: 1, maximum: 100000

## #phone (`ing.opn.booking.eventType#phone`)

Type: object

A phone call.

### Properties

- `caller` (string, required): Who calls. The host's number is kept by the app, the guest's is asked when booking.
  - Constraints: maxLength: 16, knownValues: host | guest

## #question (`ing.opn.booking.eventType#question`)

Type: object

### Properties

- `disableOnPrefill` (boolean): The answer cannot be changed when the booking link fills it in, as ?key=value.
- `excludeEmails` (array): For email: the answer must contain none of these.
  - Constraints: maxLength: 50
  - `items` (string)
    - Constraints: maxLength: 253
- `hidden` (boolean): Left off the booking page, keeping its settings.
- `key` (string, required): Stable within the event type, so answers survive a relabel.
  - Constraints: minLength: 1, maxLength: 64
- `kind` (string, required): multiselect is a group of checkboxes, radio a group of radio buttons, and checkbox a single yes or no.
  - Constraints: maxLength: 16, knownValues: text | longText | number | email | phone | url | select | multiselect | radio | checkbox
- `label` (string, required)
  - Constraints: minLength: 1, maxLength: 2000, maxGraphemes: 200
- `options` (array): The choices, for select, multiselect and radio.
  - Constraints: maxLength: 50
  - `items` (string)
    - Constraints: maxLength: 1000, maxGraphemes: 100
- `placeholder` (string)
  - Constraints: maxLength: 2000, maxGraphemes: 200
- `requireEmails` (array): For email: the answer must contain one of these, such as a domain.
  - Constraints: maxLength: 50
  - `items` (string)
    - Constraints: maxLength: 253
- `required` (boolean)

## #reschedulingLock (`ing.opn.booking.eventType#reschedulingLock`)

Type: object

Who cannot reschedule bookings, and when.

### Properties

- `appliesTo` (string, required)
  - Constraints: maxLength: 16, knownValues: everyone | guest
- `minutesBefore` (integer): Rescheduling stops this many minutes before the start. Without it, always.
  - Constraints: minimum: 1, maximum: 100000

## #rolling (`ing.opn.booking.eventType#rolling`)

Type: object

Up to a number of days from today.

### Properties

- `businessDays` (boolean): Count only Monday to Friday.
- `days` (integer, required)
  - Constraints: minimum: 1, maximum: 3650
- `excludeUnavailable` (boolean): Count only days with open hours, so that many days can always be booked.

## #unlimited (`ing.opn.booking.eventType#unlimited`)

Type: object

Any time in the future.

### Properties


## #videoCall (`ing.opn.booking.eventType#videoCall`)

Type: object

A video call.

### Properties

- `provider` (string, required): Where the call happens. A fixed meeting link is kept by the app, not on the record.
  - Constraints: maxLength: 64, knownValues: googleMeet | zoom | link

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "dateRange": {
      "description": "Only between two dates, inclusive.",
      "properties": {
        "end": {
          "description": "A calendar date, YYYY-MM-DD.",
          "maxLength": 10,
          "minLength": 10,
          "type": "string"
        },
        "start": {
          "description": "A calendar date, YYYY-MM-DD.",
          "maxLength": 10,
          "minLength": 10,
          "type": "string"
        }
      },
      "required": [
        "start",
        "end"
      ],
      "type": "object"
    },
    "field": {
      "properties": {
        "disableOnPrefill": {
          "type": "boolean"
        },
        "hidden": {
          "type": "boolean"
        },
        "label": {
          "maxGraphemes": 200,
          "maxLength": 2000,
          "type": "string"
        },
        "placeholder": {
          "maxGraphemes": 200,
          "maxLength": 2000,
          "type": "string"
        },
        "required": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "fields": {
      "description": "The questions every booking asks. Name and email are always asked and required.",
      "properties": {
        "email": {
          "ref": "#field",
          "type": "ref"
        },
        "guests": {
          "ref": "#field",
          "type": "ref"
        },
        "name": {
          "ref": "#field",
          "type": "ref"
        },
        "notes": {
          "ref": "#field",
          "type": "ref"
        },
        "rescheduleReason": {
          "ref": "#field",
          "type": "ref"
        }
      },
      "type": "object"
    },
    "inPerson": {
      "description": "In person, at a public address.",
      "properties": {
        "address": {
          "ref": "community.lexicon.location.address",
          "type": "ref"
        }
      },
      "required": [
        "address"
      ],
      "type": "object"
    },
    "link": {
      "description": "A fixed link the host chooses to publish.",
      "properties": {
        "label": {
          "maxGraphemes": 64,
          "maxLength": 640,
          "type": "string"
        },
        "uri": {
          "format": "uri",
          "type": "string"
        }
      },
      "required": [
        "uri"
      ],
      "type": "object"
    },
    "main": {
      "description": "Something someone can book: a meeting, an appointment, a consultation. The record key is the slug in its booking link, such as intro in /alice.example.com/intro, so any valid record key works. Changing the link means a new record.",
      "key": "any",
      "record": {
        "properties": {
          "allowPastReschedule": {
            "description": "Bookings that are over can still be rescheduled.",
            "type": "boolean"
          },
          "allowRescheduleCancelled": {
            "description": "A cancelled booking's reschedule link books a new time. Without it, the link shows the cancelled booking.",
            "type": "boolean"
          },
          "bookingLimits": {
            "description": "The most bookings of this event type in a day, week, month or year.",
            "ref": "#periodLimits",
            "type": "ref"
          },
          "bookingWindow": {
            "description": "How far ahead it can be booked. Without one, 60 days.",
            "refs": [
              "#rolling",
              "#dateRange",
              "#unlimited"
            ],
            "type": "union"
          },
          "bufferAfter": {
            "description": "Minutes kept free after.",
            "maximum": 1440,
            "minimum": 0,
            "type": "integer"
          },
          "bufferBefore": {
            "description": "Minutes kept free before.",
            "maximum": 1440,
            "minimum": 0,
            "type": "integer"
          },
          "cancellationReason": {
            "description": "Who must give a reason to cancel a booking. Without one, a reason is optional for everyone.",
            "knownValues": [
              "host",
              "guest",
              "both"
            ],
            "maxLength": 16,
            "type": "string"
          },
          "createdAt": {
            "format": "datetime",
            "type": "string"
          },
          "defaultDuration": {
            "description": "Minutes. One of durations.",
            "maximum": 1440,
            "minimum": 1,
            "type": "integer"
          },
          "description": {
            "maxGraphemes": 2000,
            "maxLength": 20000,
            "type": "string"
          },
          "descriptionFacets": {
            "description": "Bold, italic and links in the description.",
            "items": {
              "ref": "ing.opn.richtext.facet",
              "type": "ref"
            },
            "maxLength": 200,
            "type": "array"
          },
          "disableCancelling": {
            "description": "Who cannot cancel bookings: the host and guests, or guests only. Without one, everyone can.",
            "knownValues": [
              "everyone",
              "guest"
            ],
            "maxLength": 16,
            "type": "string"
          },
          "disableRescheduling": {
            "description": "Who cannot reschedule bookings, and when. Without one, everyone can.",
            "ref": "#reschedulingLock",
            "type": "ref"
          },
          "durationLimits": {
            "description": "The most minutes of this event type booked in a day, week, month or year.",
            "ref": "#periodLimits",
            "type": "ref"
          },
          "durations": {
            "description": "Minutes. One value means the guest has no choice.",
            "items": {
              "maximum": 1440,
              "minimum": 1,
              "type": "integer"
            },
            "maxLength": 12,
            "minLength": 1,
            "type": "array"
          },
          "eventName": {
            "description": "The title of each booking, with variables such as {scheduler} filled in. Without one, '{link_title} between {organiser} and {scheduler}'.",
            "maxGraphemes": 200,
            "maxLength": 2000,
            "type": "string"
          },
          "fields": {
            "description": "How the questions every booking asks are shown. Without them, as Opning words them.",
            "ref": "#fields",
            "type": "ref"
          },
          "firstSlotOnly": {
            "description": "Offer only the earliest open time of each day.",
            "type": "boolean"
          },
          "listed": {
            "description": "Shown on the booking page. An unlisted event type is still a public record.",
            "type": "boolean"
          },
          "locations": {
            "description": "Where it happens. With more than one, the guest chooses.",
            "items": {
              "refs": [
                "#videoCall",
                "#phone",
                "#inPerson",
                "#link"
              ],
              "type": "union"
            },
            "maxLength": 10,
            "type": "array"
          },
          "maxBookingsPerBooker": {
            "description": "The most upcoming bookings one guest email can hold through this event type.",
            "maximum": 1000,
            "minimum": 1,
            "type": "integer"
          },
          "minimumNotice": {
            "description": "Minutes between now and the earliest bookable time.",
            "minimum": 0,
            "type": "integer"
          },
          "order": {
            "description": "Field names (name, email, notes, guests, rescheduleReason) and question keys in the order the booking page asks them. Any left out follow in the usual order.",
            "items": {
              "maxLength": 64,
              "type": "string"
            },
            "maxLength": 25,
            "type": "array"
          },
          "questions": {
            "description": "Asked in the order of `order`. Without one, after name, email, notes and guests, in this order.",
            "items": {
              "ref": "#question",
              "type": "ref"
            },
            "maxLength": 20,
            "type": "array"
          },
          "requiresConfirmation": {
            "description": "Bookings wait for the host to accept them.",
            "type": "boolean"
          },
          "schedule": {
            "description": "The ing.opn.availability.schedule to book against. Without one, the profile's default.",
            "format": "at-uri",
            "type": "string"
          },
          "slotInterval": {
            "description": "Minutes between possible start times. Without one, the duration.",
            "maximum": 1440,
            "minimum": 5,
            "type": "integer"
          },
          "title": {
            "maxGraphemes": 100,
            "maxLength": 1000,
            "minLength": 1,
            "type": "string"
          },
          "weekStart": {
            "description": "The first day of the week in the booking page's calendar. Without one, the profile's.",
            "knownValues": [
              "monday",
              "tuesday",
              "wednesday",
              "thursday",
              "friday",
              "saturday",
              "sunday"
            ],
            "maxLength": 16,
            "type": "string"
          }
        },
        "required": [
          "title",
          "durations",
          "createdAt"
        ],
        "type": "object"
      },
      "type": "record"
    },
    "periodLimits": {
      "description": "A limit for each period it names.",
      "properties": {
        "day": {
          "maximum": 100000,
          "minimum": 1,
          "type": "integer"
        },
        "month": {
          "maximum": 100000,
          "minimum": 1,
          "type": "integer"
        },
        "week": {
          "maximum": 100000,
          "minimum": 1,
          "type": "integer"
        },
        "year": {
          "maximum": 100000,
          "minimum": 1,
          "type": "integer"
        }
      },
      "type": "object"
    },
    "phone": {
      "description": "A phone call.",
      "properties": {
        "caller": {
          "description": "Who calls. The host's number is kept by the app, the guest's is asked when booking.",
          "knownValues": [
            "host",
            "guest"
          ],
          "maxLength": 16,
          "type": "string"
        }
      },
      "required": [
        "caller"
      ],
      "type": "object"
    },
    "question": {
      "properties": {
        "disableOnPrefill": {
          "description": "The answer cannot be changed when the booking link fills it in, as ?key=value.",
          "type": "boolean"
        },
        "excludeEmails": {
          "description": "For email: the answer must contain none of these.",
          "items": {
            "maxLength": 253,
            "type": "string"
          },
          "maxLength": 50,
          "type": "array"
        },
        "hidden": {
          "description": "Left off the booking page, keeping its settings.",
          "type": "boolean"
        },
        "key": {
          "description": "Stable within the event type, so answers survive a relabel.",
          "maxLength": 64,
          "minLength": 1,
          "type": "string"
        },
        "kind": {
          "description": "multiselect is a group of checkboxes, radio a group of radio buttons, and checkbox a single yes or no.",
          "knownValues": [
            "text",
            "longText",
            "number",
            "email",
            "phone",
            "url",
            "select",
            "multiselect",
            "radio",
            "checkbox"
          ],
          "maxLength": 16,
          "type": "string"
        },
        "label": {
          "maxGraphemes": 200,
          "maxLength": 2000,
          "minLength": 1,
          "type": "string"
        },
        "options": {
          "description": "The choices, for select, multiselect and radio.",
          "items": {
            "maxGraphemes": 100,
            "maxLength": 1000,
            "type": "string"
          },
          "maxLength": 50,
          "type": "array"
        },
        "placeholder": {
          "maxGraphemes": 200,
          "maxLength": 2000,
          "type": "string"
        },
        "requireEmails": {
          "description": "For email: the answer must contain one of these, such as a domain.",
          "items": {
            "maxLength": 253,
            "type": "string"
          },
          "maxLength": 50,
          "type": "array"
        },
        "required": {
          "type": "boolean"
        }
      },
      "required": [
        "key",
        "label",
        "kind"
      ],
      "type": "object"
    },
    "reschedulingLock": {
      "description": "Who cannot reschedule bookings, and when.",
      "properties": {
        "appliesTo": {
          "knownValues": [
            "everyone",
            "guest"
          ],
          "maxLength": 16,
          "type": "string"
        },
        "minutesBefore": {
          "description": "Rescheduling stops this many minutes before the start. Without it, always.",
          "maximum": 100000,
          "minimum": 1,
          "type": "integer"
        }
      },
      "required": [
        "appliesTo"
      ],
      "type": "object"
    },
    "rolling": {
      "description": "Up to a number of days from today.",
      "properties": {
        "businessDays": {
          "description": "Count only Monday to Friday.",
          "type": "boolean"
        },
        "days": {
          "maximum": 3650,
          "minimum": 1,
          "type": "integer"
        },
        "excludeUnavailable": {
          "description": "Count only days with open hours, so that many days can always be booked.",
          "type": "boolean"
        }
      },
      "required": [
        "days"
      ],
      "type": "object"
    },
    "unlimited": {
      "description": "Any time in the future.",
      "properties": {},
      "type": "object"
    },
    "videoCall": {
      "description": "A video call.",
      "properties": {
        "provider": {
          "description": "Where the call happens. A fixed meeting link is kept by the app, not on the record.",
          "knownValues": [
            "googleMeet",
            "zoom",
            "link"
          ],
          "maxLength": 64,
          "type": "string"
        }
      },
      "required": [
        "provider"
      ],
      "type": "object"
    }
  },
  "id": "ing.opn.booking.eventType",
  "lexicon": 1
}
```
