Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
default:your_token_here
required

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

Body

application/json
url
string<uri>
required

HTTPS URL that receives the events.

Maximum string length: 2048
events
enum<string>[]
required
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

Shown to the restaurant in its webhook settings.

Required string length: 1 - 100
enabled
boolean

Defaults to true.

Response

Created endpoint, with its secret

data
object
required