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

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

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

Updated subscription.

dataobject
Show Child Parameters
patch/webhooks/{webhookId}

Body

{}
 
application/json

Delete a subscription

Write.

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

Path Parameters

webhookIdstringrequired

Match pattern:^whk_

Response

Deleted.

delete/webhooks/{webhookId}
 

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

Ping queued.

dataobject
Show Child Parameters
post/webhooks/{webhookId}/ping
 
application/json

Rotate the signing secret

Write. Issues a new secret; the old one stops working immediately.

post
https://api.konghotels.cloud/webhooks/{webhookId}/rotate-secret

Path Parameters

webhookIdstringrequired

Match pattern:^whk_

Response

application/json

Subscription with its new secret.

dataobject
Show Child Parameters
post/webhooks/{webhookId}/rotate-secret
 
application/json