Перейти к основному содержанию
POST
/
api
/
v1
/
external
/
webhook
Create a new webhook
curl --request POST \
  --url http://dev-backend-1.guestme.space/api/v1/external/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/webhook",
  "id": 123,
  "token": "<string>",
  "authorizationHeaderPrefix": "Bearer",
  "events": [
    "CREATE"
  ],
  "entities": [
    "RESTAURANT"
  ]
}
'
{
  "url": "https://example.com/webhook",
  "id": 123,
  "token": "<string>",
  "authorizationHeaderPrefix": "Bearer",
  "events": [
    "CREATE"
  ],
  "entities": [
    "RESTAURANT"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
url
string
required

Webhook request URL

Minimum string length: 1
Example:

"https://example.com/webhook"

​
id
integer<int64>

Webhook ID

​
token
string

Token for webhook request

​
authorizationHeaderPrefix
string

Authorization header prefix

Maximum string length: 20
Example:

"Bearer"

​
events
enum<string>[]

Set of event types to subscribe

Maximum array length: 20
Доступные опции:
CREATE,
UPDATE,
DELETE
​
entities
enum<string>[]

Set of entity types to subscribe

Maximum array length: 20
Доступные опции:
RESTAURANT,
BOOKING

Response

200 - */*

OK

​
url
string
required

Webhook request URL

Minimum string length: 1
Example:

"https://example.com/webhook"

​
id
integer<int64>

Webhook ID

​
token
string

Token for webhook request

​
authorizationHeaderPrefix
string

Authorization header prefix

Maximum string length: 20
Example:

"Bearer"

​
events
enum<string>[]

Set of event types to subscribe

Maximum array length: 20
Доступные опции:
CREATE,
UPDATE,
DELETE
​
entities
enum<string>[]

Set of entity types to subscribe

Maximum array length: 20
Доступные опции:
RESTAURANT,
BOOKING