Appointment Created

POST

Sent when an appointment is booked.

Authorizations

• apiKey

Request Body^required

Media typeapplication/json

object

id

required

Unique identifier for this event delivery.

string

name

required

The name of the event, in resource.action format.

string

Allowed value: appointment.create

createdAt

required

When the event was recorded by Upvio.

string format: date-time

business

required

The business the event belongs to.

object

id

required

Unique identifier across the Upvio platform.

string

data

required

An appointment and the resources it is linked to.

object

id

required

Unique identifier across the Upvio platform.

string

createdAt

required

ISO 8601 timestamp.

string format: date-time

updatedAt

required

ISO 8601 timestamp.

string format: date-time

date

required

When the appointment starts, in UTC.

string format: date-time

originalDate

Any of:

string

ISO 8601 timestamp.

string format: date-time

null

null

duration

required

Duration in minutes.

number

currency

string | null

price

number | null

approved

required

boolean

cancelled

required

boolean

businessId

required

Unique identifier across the Upvio platform.

string

serviceId

required

Unique identifier across the Upvio platform.

string

service

required

object

id

required

Unique identifier across the Upvio platform.

string

name

required

string

alias

string | null

links

Deprecated. Use links instead.

object

book

required

Absolute URL.

string format: uri

key

additional properties

key

additional properties

adHocServiceId

Any of:

string

Unique identifier across the Upvio platform.

string

null

null

staffId

required

Unique identifier across the Upvio platform.

string

staff

required

object

id

required

Unique identifier across the Upvio platform.

string

name

required

string

email

string | null

links

Deprecated. Use links instead.

object

book

required

Absolute URL.

string format: uri

key

additional properties

key

additional properties

staffName

Deprecated. Use staff.name.

string | null

additionalStaffIds

required

Array<string>

default:

patientId

required

Unique identifier across the Upvio platform.

string

patient

required

object

id

required

Unique identifier across the Upvio platform.

string

name

string | null

email

string | null

phone

string | null

key

additional properties

patientName

Deprecated. Use patient.name.

string | null

patientTimezone

string | null

location

Any of:

object

object

id

required

Unique identifier across the Upvio platform.

string

name

required

string

address

string | null

key

additional properties

null

null

locationType

string | null

locationValue

string | null

hangoutLink

string | null

answers

Any of:

Array<object>

Array<object>

object

id

required

string

question

string | null

answer

Any of:

unknown

null

null

variableName

string | null

key

additional properties

null

null

custom

Any of:

object

object

key

additional properties

null

null

paymentProvider

string | null

paymentId

string | null

transactionUrl

Any of:

string

Absolute URL.

string format: uri

null

null

groupBookingId

Any of:

string

Unique identifier across the Upvio platform.

string

null

null

recurringAppointmentId

Any of:

string

Unique identifier across the Upvio platform.

string

null

null

recurrence

Any of:

unknown

null

null

rrule

string | null

links

required

object

reschedule

required

Absolute URL.

string format: uri

cancel

required

Absolute URL.

string format: uri

key

additional properties

rescheduleUrl

required

Deprecated. Use links.reschedule.

string format: uri

cancelUrl

required

Deprecated. Use links.cancel.

string format: uri

previousAttributes

Any of:

object

object

key

additional properties

null

null

key

additional properties

Responses

200

Return any 2xx status code to acknowledge the delivery.