OpeningCreatedEventData

This is an object representing data for the opening created event.

object objectrequired

An opening is a one-off range of available time for a provider, sitting alongside their recurring schedules.

created_atdatetimerequired

When the opening was created.

datedaterequired

The date of the opening.

end_timestringrequired

The end time of the opening (24-hour clock, e.g. 17:00).

idstringrequired

Unique identifier for the object.

Possible values: Value must match regular expression ^opn_\w{12}$

objectstringrequired

String representing the object's type.

Possible values: [opening]

provider_idstringrequired

The ID of the provider the opening belongs to.

start_timestringrequired

The start time of the opening (24-hour clock, e.g. 09:00).

time_zonestringrequired

The IANA time zone the opening's times are authored in.

titlestringnullablerequired

An optional display title for the opening.

updated_atdatetimerequired

When the opening was last updated.

typestringrequired

The event type.

Possible values: [opening.created]

OpeningCreatedEventData

{
  "object": {
    "created_at": "2025-02-17T17:49:19Z",
    "date": "2025-06-15",
    "end_time": "17:00",
    "id": "opn_d025a96ac0c6",
    "object": "opening",
    "provider_id": "prov_d025a96ac0c6",
    "start_time": "09:00",
    "time_zone": "America/New_York",
    "title": "Extra clinic hours",
    "updated_at": "2025-02-17T17:49:19Z"
  },
  "type": "opening.created"
}