Добавление вебхука
Перейдите в раздел Система → Вебхуки и нажмите кнопку Добавить
| Поле | Описание |
|---|---|
| Название | Название вебхука |
| Путь | Путь к обработчику вебхука |
| Токен | Авторизационный токен, будет отправлен в заголовке Authorization: Bearer {token} |
| Функция | Необязательное поле, название функции, которая будет формировать JSON-данные вебхука |
| Таймаут, с. | Таймаут, с которым будет отправлен запрос на указанный "Путь" |
| События | События, при которых будет срабатывать вебхук. Для каждой модели ORM в системе управления доступны события Create, Delete, MarkDeleted, Update. Например, OnShopOrderCreate, также могут быть добавлены дополнительные вебхуки, генерируемые модулем. |
| Активность | Активность вебхука |
| Заголовок авторизации | Авторизационный заголовок, который будет направляться при обращении к обработчику вебхука |
| Шаблон значения заголовка авторизации | Шаблон, по которому токен будет подставляться в заголовок авторизации |
Функция
Указывается название функции, которая будет формировать JSON-данные. Если функция не заполнена, для модели будет вызван стандартный метод getStdObject(), а JSON будет представлен в виде массива 'названиеСобытия' => object.
Пример функции, которая формирует простой JSON для объекта:
function myFunction($eventName, $object)
{
return array('name' => $object->name);
}
Проверка работы вебхука
На тестовый период использования вебхуков можно использовать сервис https://webhook.site, сервис создаст для вас уникальный URL, с помощью которого вы сможете видеть присылаемые запросы.
Не нашли ответ на свой вопрос в документации? Направьте обращение в службу поддержки или онлайн чат.
