Получатели вебхуков


Во время выполнения некоторых действий Zenky API может выполнять отправку вебхуков дял уведомления ваших приложений о том или ином событии. Например, мы можем сообщить об отправке нового заказа, получении запроса обратной связи и некоторых других вещах.

Для того, чтобы получать от нас вебхуки, вам необходимо создать на своём сайте обработчик вебхуков и зарегистрировать получателя.

Используемые структуры

Данные вебхуков приходят в одном и том же формате, но в зависимости от типа вебхука, его полезная нагрузка (payload) будет отличаться.

Типы вебхуков

В таблице ниже отображены возможные идентификаторы типов вебхуков, а так же их описания.

Получатель вебхуков

Вебхук

В зависимости от значения поля type структура поля payload будет иметь следующий вид:

order.*

Все вебхуки, относящиеся к заказам, содержат информацию о заказе в поле payload:

callback.submitted

feedback.submitted

Запросы

Создание получателя

При создании получателя вебхуков необходимо передать URL, на который будут отправляться вебхуки, и список типов вебхуков, которые должны будут отправляться. Для того, чтобы подписаться на все вебхуки (существующие сейчас и те, которые могут быть добавлены в будущем), передайте значение *.

POST https://api.zenky.io/v2/store/webhook-receivers

{
  "url": "https://example.org/webhooks",
  "webhook_types": ["order.submitted", "order.confirmed"]
}

POST https://api.zenky.io/v2/store/webhook-receivers

{
  "url": "https://example.org/webhooks",
  "webhook_types": ["*"]
}

Обновление получателя

Если во время обновления получателя вебхуков вы передаете параметр webhook_types, то все установленные ранее типы будут перезаписаны на новые переданные.

PUT https://api.zenky.io/v2/store/webhook-receivers/0e8a2422-dcdb-4141-bed3-9e0261cc334c

{
  "webhook_types": ["*"]
}

PUT https://api.zenky.io/v2/store/webhook-receivers/0e8a2422-dcdb-4141-bed3-9e0261cc334c

{
  "url": "https://example.org/zenky/webhooks"
}

Методы

Список получателей

Возвращает список получателей вебхуков.

Создание получателя

Создаёт нового получателя вебхуков.

Просмотр получателя

Возвращает информацию о получателе вебхуков.

Обновление получателя

Обновляет информацию о получателе вебхуков.

Удаление получателя

Удаляет получателя вебхуков.