Skip to main content
PATCH
Update a webhook endpoint

Authorizations

Authorization
string
header
default:your_token_here
required

Restaurant-scoped partner API token passed as Authorization: Bearer <token>.

Path Parameters

id
string
required

Webhook endpoint identifier.

Minimum string length: 1

Body

application/json
url
string<uri>

HTTPS URL that receives the events.

Maximum string length: 2048
events
enum<string>[]
Minimum array length: 1

reservation.* events need RESERVATIONS_READ on the key, customer.* events CUSTOMERS_READ.

Available options:
reservation.created,
reservation.updated,
reservation.deleted,
customer.created,
customer.updated,
customer.merged,
customer.deleted
description
string
Required string length: 1 - 100
enabled
boolean

Response

Updated endpoint

data
object
required