Skip to main content

ConfirmationEvent

This is an object representing when an appointment was confirmed.

actorstringnullablerequired

The actor that initiated the confirmation (user ID or bearer token ID).

end_at objectrequired

An object describing a date/time in local time (naive) and in UTC.

localstringrequired

The local date/time in ISO-8601 format (without time zone information).

Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

Example: 2025-03-01T10:00:00
objectstringrequired

String representing the object's type.

Possible values: [zoned_date_time]

time_zonestringrequired

The time zone of the local time (IANA format).

Example: America/New_York
unix_tsintegerrequired

The UTC date/time in Unix timestamp format (seconds).

Example: 1736461200
utcstring<date-time>required

The UTC date/time in ISO-8601 format (with time zone information).

Example: 2025-03-01T03:00:00Z
initiated_bystringrequired

The entity that initiated the confirmation.

Possible values: [user, client]

objectstringrequired

Possible values: [confirmation_event]

occurred_atstring<datetime>required

The time at which the confirmation occurred (ISO-8601 format).

sourcestringrequired

The source of the confirmation event.

Possible values: [client_ui, dashboard, api]

start_at objectrequired

An object describing a date/time in local time (naive) and in UTC.

localstringrequired

The local date/time in ISO-8601 format (without time zone information).

Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

Example: 2025-03-01T10:00:00
objectstringrequired

String representing the object's type.

Possible values: [zoned_date_time]

time_zonestringrequired

The time zone of the local time (IANA format).

Example: America/New_York
unix_tsintegerrequired

The UTC date/time in Unix timestamp format (seconds).

Example: 1736461200
utcstring<date-time>required

The UTC date/time in ISO-8601 format (with time zone information).

Example: 2025-03-01T03:00:00Z
ConfirmationEvent
{
  "actor": null,
  "end_at": {
    "local": "2023-01-01T01:00:00",
    "object": "zoned_date_time",
    "time_zone": "America/New_York",
    "unix_ts": 1736464800,
    "utc": "2023-01-01T04:00:00Z"
  },
  "initiated_by": "client",
  "object": "confirmation_event",
  "occurred_at": "2023-01-01T03:00:00Z",
  "source": "client_ui",
  "start_at": {
    "local": "2023-01-01T00:00:00",
    "object": "zoned_date_time",
    "time_zone": "America/New_York",
    "unix_ts": 1736461200,
    "utc": "2023-01-01T03:00:00Z"
  }
}