GroupRequestFields
objectevent_typestring
Allowed values:corporateconferenceweddingsports_teamtour_groupother
group_namestring
contactobject
Show Child Parameters
check_instring(date)
check_outstring(date)
At most 30 nights after check_in.
rooms_requestedinteger
>= 10<= 500
attendeesinteger | null
room_preferencesarray[object]
Show Child Parameters
needs_meeting_spaceboolean
Default:false
budget_per_nightnumber | null
Per room
notesstring | null
Example
GroupRequest
referencestring
Example:GRP-8K2M4Q
statusstring
Allowed values:receivedunder_reviewproposal_sentaccepteddeclinedcancelled
property_codestring
currencystring
cancelled_atstring | null(date-time)
created_atstring(date-time)
updated_atstring(date-time)
event_typestring
Allowed values:corporateconferenceweddingsports_teamtour_groupother
group_namestring
contactobject
Show Child Parameters
check_instring(date)
check_outstring(date)
At most 30 nights after check_in.
rooms_requestedinteger
>= 10<= 500
attendeesinteger | null
room_preferencesarray[object]
Show Child Parameters
needs_meeting_spaceboolean
Default:false
budget_per_nightnumber | null
Per room
notesstring | null
Example
ChangeEvent
objectExample:{"id":"evt_01jbx5a1b2c3d4e5f6g7h8j9k0","sequence":4182,"type":"availability.changed","occurred_at":"2026-10-24T05:54:42Z","property_code":"KTNYC","subject":{"type":"room_type","id":"KTNYC:TWRK"},"data":{"room_type_code":"TWRK","start_date":"2026-12-04","end_date":"2026-12-06"}}
idstring
Example:evt_01jbx5a1b2c3d4e5f6g7h8j9k0
sequenceinteger
Monotonic position in the feed; use as the since cursor.
typestring
Allowed values:reservation.createdreservation.modifiedreservation.cancelledreservation.add_ons_changedavailability.changedrates.changedproperty.updatedpromotion.publishedreview.publishedgroup_request.createdgroup_request.updatedwebhook.ping
occurred_atstring(date-time)
property_codestring | null
subjectobject
Show Child Parameters
dataobject
Payload by event type:
| Type | data fields |
|---|---|
availability.changed |
room_type_code, start_date, end_date (inclusive stay nights). Refetch availability for that range. |
rates.changed |
room_type_code, start_date, end_date, rate_plan_codes, lowest_rate (current lowest nightly base rate in the range), currency |
property.updated |
changed_sections (any of description, amenities, photos, policies), summary |
promotion.published |
code, name, bookable_until, property_codes (null = all) |
review.published |
review_id, overall_rating |
reservation.created / .modified / .cancelled / .add_ons_changed |
confirmation_number, partner_reference, status, check_in, check_out, total, currency, plus changed_fields (modified), cancellation_fee (cancelled) or add_ons (add-ons changed). Status changes made at the property, such as check-in and check-out, arrive as reservation.modified. |
group_request.created / .updated |
reference, status, rooms_requested |
webhook.ping |
message |
* Additional properties are allowed.
Example
EventTypeInfo
objecttypestring
Allowed values:reservation.createdreservation.modifiedreservation.cancelledreservation.add_ons_changedavailability.changedrates.changedproperty.updatedpromotion.publishedreview.publishedgroup_request.createdgroup_request.updatedwebhook.ping
descriptionstring
scopestring
Allowed values:publicpartner
Example
WebhookCreate
objecturlstring(uri)required
Must be HTTPS in production.
eventsarray[string]required
Allowed values:reservation.createdreservation.modifiedreservation.cancelledreservation.add_ons_changedavailability.changedrates.changedproperty.updatedpromotion.publishedreview.publishedgroup_request.createdgroup_request.updatedwebhook.ping
>= 1 items
property_codesarray | null[string]
Only events for these properties; null for all.
descriptionstring | null
is_activeboolean
Default:true
Example