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

Path Parameters

id
integer
required

Webhook ID

Body

application/json
url
string
required

Webhook request URL

Minimum length: 1
Example:

"https://example.com/webhook"

id
integer

Webhook ID

token
string

Token for webhook request

authorizationHeaderPrefix
string

Authorization header prefix

Maximum length: 20
Example:

"Bearer"

events
enum<string>[]

Set of event types to subscribe

Maximum length: 20
entities
enum<string>[]

Set of entity types to subscribe

Maximum length: 20

Response

200 - */*

OK

url
string
required

Webhook request URL

Minimum length: 1
Example:

"https://example.com/webhook"

id
integer

Webhook ID

token
string

Token for webhook request

authorizationHeaderPrefix
string

Authorization header prefix

Maximum length: 20
Example:

"Bearer"

events
enum<string>[]

Set of event types to subscribe

Maximum length: 20
entities
enum<string>[]

Set of entity types to subscribe

Maximum length: 20
I