Вебхуки

Вебхуки используются при интеграции с внешними сервисами. Вебхук позволяет настроить оповещение внешнего сервиса о событии VK Dev Platform.

Вебхук запускается, когда возникает событие в VK Dev Platform: VK Dev Platform отправляет во внешний сервис асинхронный POST-запрос с данными о произошедшем событии. Тип события задаётся в настройках вебхука. Тело POST-запроса формируется автоматически (формат JSON) в зависимости от типа события.

Возможные статусы вебхука:

• Включен — вебхук включён, POST-запросы отправляются во внешний сервис.
• Выключен — вебхук отключён, POST-запросы не отправляются во внешний сервис.

Возможные статусы запуска вебхука:

• Ready — внешний сервис получил вебхук.
• Failed — внешний сервис не получил вебхук, произошла ошибка.

1. Войдите в Портал управления разработкой.

2. Перейдите в раздел Вебхуки.

3. Нажмите кнопку Новый вебхук.

4. Задайте обязательные параметры:

   • Проект разработки — проект разработки.
   • Наименование — имя вебхука.
   • Тип события — тип события, по которому оповещается внешний сервис.
   • URL — URL-адрес внешнего сервиса.

5. Задайте необязательные параметры:

   • Принимать недоверенные сертификаты — опция, чтобы принимать недоверенные сертификаты.
   • Имя пользователя — имя пользователя для аутентификации во внешнем сервисе.
   • Пароль пользователя — пароль пользователя для аутентификации во внешнем сервисе.
   • HTTP-заголовки — заголовки для POST-запроса к внешнему сервису (header). Например, Content-Type: application/json.
   • Описание — описание вебхука.
   • Включить — опция, чтобы включить вебхук сразу после создания.

6. Нажмите кнопку Создать.

1. Войдите в Портал управления разработкой.
2. Перейдите в раздел Вебхуки.
3. Нажмите на имя вебхука.
4. На вкладке Параметры отредактируйте настройки вебхука. Изменение проекта разработки недоступно.
5. Нажмите кнопку Сохранить.

1. Войдите в Портал управления разработкой.

2. Перейдите в раздел Вебхуки.

3. Нажмите на имя вебхука.

4. Перейдите на вкладку Запуски.

5. Нажмите на статус запуска вебхука.

6. Чтобы посмотреть параметры POST-запроса, нажмите кнопку Request.

   Чтобы посмотреть ответ на POST-запрос, нажмите кнопку Response.

1. Войдите в Портал управления разработкой.

2. Перейдите в раздел Вебхуки.

3. Нажмите на имя вебхука.

4. Чтобы включить вебхук, на вкладке Параметры установите переключатель Включить в активное положение.

   Чтобы отключить вебхук, на вкладке Параметры установите переключатель Включить в неактивное положение.

1. Войдите в Портал управления разработкой.
2. Перейдите в раздел Вебхуки.
3. Нажмите на значок ••• справа от имени вебхука и выберите пункт Удалить.
4. Подтвердите удаление.