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
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
Response
application/json
Subscription created.
dataobject
Show Child Parameters
post/webhooks
Authentication
Headers
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
Response
application/json
The subscription.
dataobject
Show Child Parameters
get/webhooks/{webhookId}
Authentication
Path Parameters
application/json
Update a subscription
Write. Change the URL, events or property filter, or pause delivery with is_active: false.
patch
https://api.konghotels.cloud/webhooks/{webhookId}
Path Parameters
webhookIdstringrequired
Match pattern:^whk_
Body
application/json
Body
application/json
WebhookUpdate
urlstring(uri)
eventsarray[string]
Allowed values:reservation.createdreservation.modifiedreservation.cancelledreservation.add_ons_changedavailability.changedrates.changedproperty.updatedpromotion.publishedreview.publishedgroup_request.createdgroup_request.updatedwebhook.ping
property_codesarray | null[string]
descriptionstring | null
is_activeboolean
Response
application/json
Response
application/json
Updated subscription.
dataobject
Show Child Parameters
patch/webhooks/{webhookId}
Authentication
Path Parameters
Body
{}
application/json
Delete a subscription
Write.
delete
https://api.konghotels.cloud/webhooks/{webhookId}
Path Parameters
webhookIdstringrequired
Match pattern:^whk_
Response
Response
Deleted.
delete/webhooks/{webhookId}
Authentication
Path Parameters
Send a test event
Write. Queues a signed webhook.ping delivery to the endpoint.
post
https://api.konghotels.cloud/webhooks/{webhookId}/ping
Path Parameters
webhookIdstringrequired
Match pattern:^whk_
Response
application/json
Response
application/json
Ping queued.
dataobject
Show Child Parameters
post/webhooks/{webhookId}/ping
Authentication
Path Parameters
application/json