Jicoo Developer Potal
  1. Webhook Schema
Jicoo Developer Potal
  • Create powerful apps with Jicoo's API
  • Quick start
  • Authentication
  • Errors
  • Versioning
  • Types
  • API Reference Overview
  • Guide
    • How to use webhook
    • How to use Account integration
  • Guide(Japanese)
    • アカウント連携の使い方
    • Webhookの使い方
    • ホストの優先度を更新する方法
  • API Reference
    • Jicoo API
    • Webhook Schema
      • Webhook schema
      • event property
      • createdAt property
      • object property
      • contact property
      • answers property
      • answers items property
      • tracking property
    • Booking
      • List Bookings
      • Get Booking
      • Cancel Booking
      • Reschedule Booking
      • Create Booking
      • Update Booking
      • Get Booking Contacts
    • Schedule
      • Update Schedule
      • Create Schedule
      • List Schedules
      • Delete Schedule
    • Availability
      • List User Availability Calendars
      • Get User Availability Calendar
    • Oraganization
      • User
        • List Organization Users
        • Delete Organization User
        • Get Organization User
        • Update Organization User
      • Invitation
        • Create Organiztion Invitation
        • List Organization Invitations
        • Get Organization Invitation
        • Delete Organiztion Invitation
      • Get Organization Team
    • Event Types
      • Get Event Type
      • List Event Types
      • List Event Type Hosts
      • Get Event Type Available Schedules
      • Account Integration
      • Update Event Type Host
      • Delete Event Type Host
      • Create Event Type Host
  1. Webhook Schema

object property

object#

object Type#

object (Details)

object Properties#

PropertyTypeRequiredNullableDefined by
uidstringRequiredcannot be nullobject
eventTypeUidstringRequiredcannot be nullobject
statusstringRequiredcannot be nullobject
timeZonestringRequiredcannot be nullobject
createdAtstringRequiredcannot be nullobject
updatedAtstringRequiredcannot be nullobject
startedAtstringRequiredcannot be nullobject
endedAtstringRequiredcannot be nullobject
cancelReasonstringRequiredcan be nullobject
cancelledAtstringRequiredcan be nullobject
cancelledBystringRequiredcan be nullobject
contactobjectRequiredcannot be nullcontact
answersarrayRequiredcannot be nullanswers
trackingobjectRequiredcannot be nulltracking

uid#

Event id(unique identifier)
uid
is required
Type: string
cannot be null
defined in: object

uid Type#

string

eventTypeUid#

Event type id(unique identifier)
eventTypeUid
is required
Type: string
cannot be null
defined in: object

eventTypeUid Type#

string

status#

Event status
status
is required
Type: string
cannot be null
defined in: object

status Type#

string

status Constraints#

enum: the value of this property must be equal to one of the following values:
ValueExplanation
"open"Event is open
"cancel"Event was canceled

timeZone#

Timezone which a guest selected
timeZone
is required
Type: string
cannot be null
defined in: object

timeZone Type#

string

timeZone Examples#

"Asia/Tokyo"

createdAt#

The time event was created
createdAt
is required
Type: string
cannot be null
defined in: object

createdAt Type#

string

createdAt Constraints#

date time: the string must be a date time string, according to RFC 3339, section 5.6

createdAt Examples#

"2019-08-24T10:01:01.000Z"

updatedAt#

The time event was last updated
updatedAt
is required
Type: string
cannot be null
defined in: object

updatedAt Type#

string

updatedAt Constraints#

date time: the string must be a date time string, according to RFC 3339, section 5.6

updatedAt Examples#

"2019-08-24T10:02:02.000Z"

startedAt#

The time event was started
startedAt
is required
Type: string
cannot be null
defined in: object

startedAt Type#

string

startedAt Constraints#

date time: the string must be a date time string, according to RFC 3339, section 5.6

startedAt Examples#

"2019-08-24T14:00:00.000Z"

endedAt#

The time event was ended
endedAt
is required
Type: string
cannot be null
defined in: object

endedAt Type#

string

endedAt Constraints#

date time: the string must be a date time string, according to RFC 3339, section 5.6

endedAt Examples#

"2019-08-24T15:00:00.000Z"

cancelReason#

The reason that the cancellation occurred
cancelReason
is required
Type: string
can be null
defined in: object

cancelReason Type#

string

cancelReason Examples#

"Another meeting scheduled"

cancelledAt#

The time event was cancellled
cancelledAt
is required
Type: string
can be null
defined in: object

cancelledAt Type#

string

cancelledAt Constraints#

date time: the string must be a date time string, according to RFC 3339, section 5.6

cancelledAt Examples#

"2019-08-294T14:01:01.000Z"

cancelledBy#

Status of Cancelled by guest or host
cancelledBy
is required
Type: string
can be null
defined in: object

cancelledBy Type#

string

cancelledBy Constraints#

enum: the value of this property must be equal to one of the following values:
ValueExplanation
"guest"Canceled by guest
"host"Canceled by host

cancelledBy Examples#

"host"

contact#

The guest data
contact
is required
Type: object (Details)
cannot be null
defined in: object

contact Type#

object (Details)

answers#

The collection of the guest's responses to questions
answers
is required
Type: object[] (Details)
cannot be null
defined in: answers

answers Type#

object[] (Details)

tracking#

The UTM tracking parameters associated with the guest
tracking
is required
Type: object (Details)
cannot be null
defined in: tracking

tracking Type#

object (Details)
Previous
createdAt property
Next
contact property
Built with