Skip to main content
PUT
Update Webhook
Update the URL or credentials for an existing webhook subscription.
string
required
Your API key
string
required
Must be application/json
string
required
Event name. Valid values: BOOKING_CREATED, BOOKING_UPDATED, GIFTCARDS_CREATED, GIFTCARDS_UPDATED, GIFTCARDS_CANCELLED, GIFTCARDS_REDEEMED
string
required
New endpoint URL
string
Updated auth key
string
Updated auth token
Example 200 Response

Authorizations

X-API-KEY
string
header
required

Headers

X-API-KEY
string
required

API Key authentication header

Path Parameters

event
enum<string>
required

The name of the event that the webhook subscription is being updated for.

Available options:
BOOKING_CREATED,
BOOKING_UPDATED,
GIFTCARDS_CREATED,
GIFTCARDS_UPDATED,
GIFTCARDS_CANCELLED,
GIFTCARDS_REDEEMED

Body

application/json
webhookUrl
string<uri>
required
Minimum string length: 1
securityKey
string | null
securityToken
string | null

Response

200 - application/json

Update Webhook Event

event
string | null
webhookUrl
string | null
locationId
string | null
errorMessage
string | null