Webhooks

Push delivery of change events to your endpoints.

List event types

get
https://api.konghotels.cloud/webhooks/event-types

Response

200 application/json

Subscribable event types.

dataarray[object]
Show Child Parameters
get/webhooks/event-types
 
200 application/json

List subscriptions

get
https://api.konghotels.cloud/webhooks

Response

200 application/json

Your subscriptions.

dataarray[object]
Show Child Parameters
get/webhooks
 
200 application/json

Create a subscription

Write. The signing secret is returned only in this response (and after rotation). Store it securely.

post
https://api.konghotels.cloud/webhooks

Headers

Idempotency-Keystring

Optional. Makes the request safe to retry for 24 hours.

<= 255 characters

Example:8e03978e-40d5-43e8-bc93-6894a57f9324

Body

application/json

WebhookCreate

urlstring(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

Response

application/json

Subscription created.

dataobject
Show Child Parameters
post/webhooks

Body

{ "url": "https://partner.example.com/webhooks/kong-hotels", "events": [ "reservation.created", "reservation.modified", "reservation.cancelled", "availability.changed" ], "property_codes": [ "KTNYC", "KBBRK" ], "description": "Production listener" }
 
application/json

Get a subscription

get
https://api.konghotels.cloud/webhooks/{webhookId}

Path Parameters

webhookIdstringrequired

Match pattern:^whk_

Response

application/json

The subscription.

dataobject
Show Child Parameters
get/webhooks/{webhookId}
 
application/json