Skip to main content
PUT
/
Webhooks
/
{event}
PUT /Webhooks/{event}
curl --request PUT \
  --url https://{base_url}/Webhooks/{event} \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "webhookUrl": "<string>",
  "securityKey": "<string>",
  "securityToken": "<string>"
}
'
Update the URL or credentials for an existing webhook subscription.
X-API-KEY
string
required
Your API key
Content-Type
string
required
Must be application/json
event
string
required
Event name. Valid values: BOOKING_CREATED, BOOKING_UPDATED, GIFTCARDS_CREATED, GIFTCARDS_UPDATED, GIFTCARDS_CANCELLED, GIFTCARDS_REDEEMED
webhookUrl
string
required
New endpoint URL
securityKey
string
Updated auth key
securityToken
string
Updated auth token
curl --location --request PUT '[BASE_URL]/Webhooks/BOOKING_CREATED' \
--header 'X-API-KEY: your_api_key_here' \
--header 'Content-Type: application/json' \
--data '{ "webhookUrl": "https://your-system.com/webhooks/nbi/v2/booking-created" }'
Example 200 Response
{
  "event": "BOOKING_CREATED",
  "webhookUrl": "https://your-system.com/webhooks/nbi/v2/booking-created",
  "locationId": "loc-9",
  "errorMessage": null
}
StatusDescription
200Subscription updated
400loggedInAppId
400No Venue Subscribed to your App.
400Giftcard Webhook Request Failed Verification.
401X-API-KEY missing or invalid
404Webhook Subscription for event '{event}' was not found