Вебхуки

Функция Webhook позволяет передать набор данных на указанный Endpoint после определенного события. Данный функционал можно использовать в интегрированной системе с REGOS для обновления данных и отправки уведомлений.

При срабатывании функции, на указанный URL отправляется json-запрос с данными.

Входные параметры

Название Тип данных Обязательность Описание параметра
action enum Обязательный Событие, в результате которого сработал WebHook
token string Обязательный Токен приложения, в котором произошло событие
data object Обязательный Объект с данными. Набор данных зависит от типа события для WebHook

Пример запроса

{
    "action":1,
    "token":"c30640e61836e932c3b4a2dadf164c04",
    "data":{}
}

Выходные параметры

Название Тип данных Обязательность Описание параметра
ok bool Обязательный Метка об успешном запросе WebHook

Пример ответа

{ 
    "ok": true
}


Action - события
Значение action Наименование Описание
1 DocOrderDeliveryStatusChanged Изменения статуса документа розничных заказов