Валидация вебхука

Запускает процедуру валидации вебхука. Система отправит POST-запрос на URL вебхука с "event": "WEBHOOK_VALIDATE".

Если передан параметр activate=true и ваш сервер вернет HTTP 2xx с телом {"message": "validated_store_{store_id}"}, вебхук будет автоматически переведен в статус ACTIVE. Идентификатор магазина (store_id) доступен через GET /v1/store.

Request

POST

https://api.kit.yandex.net/v1/webhooks/{webhook_id}/validate

Query parameters

Name

Description

activate

Type: boolean

Активировать ли вебхук после успешной валидации. Если true и сервер вернул корректный ответ({"message": "validated_store_{store_id}"}), вебхук переводится в статус ACTIVE.

Default: false

Responses

204 No Content

Начата валидация вебхука.

400 Bad Request

Некорректный запрос.

Body

application/json
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name

Description

code

Type: string

Example: VALIDATION_ERROR

message

Type: string

Example: Invalid input

trace_id

Type: string

Уникальный идентификатор запроса для отладки.

Example: 00000000000000000000000000000000

401 Unauthorized

Не авторизован.

Body

application/json
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name

Description

code

Type: string

Example: VALIDATION_ERROR

message

Type: string

Example: Invalid input

trace_id

Type: string

Уникальный идентификатор запроса для отладки.

Example: 00000000000000000000000000000000

404 Not Found

Ресурс не найден.

Body

application/json
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name

Description

code

Type: string

Example: VALIDATION_ERROR

message

Type: string

Example: Invalid input

trace_id

Type: string

Уникальный идентификатор запроса для отладки.

Example: 00000000000000000000000000000000

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name

Description

code

Type: string

Example: VALIDATION_ERROR

message

Type: string

Example: Invalid input

trace_id

Type: string

Уникальный идентификатор запроса для отладки.

Example: 00000000000000000000000000000000