Создание вебхуков

Вебхуки — это инструмент для получения и хранения данных об определённом событии. Они позволяют зарегистрировать URL-адрес https://, по которому можно сохранять данные о событии в форматах JSON или XML. Вебхуки обычно используются для следующих целей:

  • Размещение заказа
  • Изменение цены товара
  • Уведомление IM-клиента или пейджера, когда вы офлайн
  • Сбор данных для хранилища данных
  • Интеграция вашего бухгалтерского программного обеспечения
  • Фильтрация позиций заказа и информирование различных отправителей о заказе
  • Удаление данных клиента из вашей базы данных, когда он удаляет ваше приложение

Поддерживаемые события вебхуков

При создании вебхука вы можете выбрать любое из перечисленных событий. Например, если вы хотите создать вебхук, который будет отправляться каждый раз после оплаты заказа, выберите «Оплата заказа». Или, если вы хотите создать вебхук, который будет отправляться при каждом обновлении свойства магазина, выберите «Обновление магазина».

Таблица с перечнем поддерживаемых событий вебхуков, доступных в панели администратора Shopify.
КатегорияСобытия
Корзина
  • Создание корзины
  • Обновление корзины
Оформление заказа
  • Начало оформления заказа
  • Удаление оформления заказа
  • Обновление оформления заказа
Коллекция
  • Создание коллекции
  • Удаление коллекции
  • Обновление коллекции
Клиент
  • Обновление согласия клиента на СМС-маркетинг
  • Обновление настроек аккаунта клиента
  • Создание клиента
  • Удаление клиента
  • Отключение клиента
  • Обновление согласия клиента на рекламные рассылки
  • Включение клиента
  • Создание группы клиентов
  • Удаление группы клиентов
  • Обновление группы клиентов
  • Добавлены теги клиента
  • Удалены теги клиента
  • Обновление данных клиента
Скидка
  • Создание скидки
  • Удаление скидки
  • Обновление скидки
Черновик заказа
  • Создание черновика заказа
  • Удаление черновика заказа
  • Обновление черновика заказа
Выполнение заказа
  • Создание фулфилмента
  • Служба выполнения заказов не может обработать задание на выполнение
  • Позиции задания на выполнение подготовлены к самовывозу
  • Задание на выполнение перемещено
  • Задание на выполнение приостановлено
  • Задание на выполнение перенесено
  • Наступил срок для запланированного задания на выполнение
  • Завершена маршрутизация для задания на выполнение
  • Задания на выполнение отменены
  • Запрос на отмену заданий на выполнение принят
  • Запрос на отмену заданий на выполнение отклонён
  • Отправлен запрос на отмену заданий на выполнение
  • Запрос на обработку заданий на выполнение принят
  • Запрос на обработку заданий на выполнение отклонён
  • Отправлен запрос на обработку заданий на выполнение
  • Приостановка заданий на выполнение снята
  • Позиции заданий на выполнение подготовлены для местной доставки
  • Задания на выполнение объединены
  • Задания на выполнение разделены
  • Обновление фулфилмента
Товарные запасы
  • Создание позиции товарных запасов
  • Удаление позиции товарных запасов
  • Обновление позиции товарных запасов
  • Подключение уровня запасов
  • Отключение уровня запасов
  • Обновление уровня запасов
Местоположение
  • Активация места расположения
  • Создание места расположения
  • Деактивация места расположения
  • Удаление места расположения
  • Обновление позиции в месте расположения
Рынок
  • Создание рынка
  • Удаление рынка
  • Обновление рынка
Заказ
  • Отмена заказа
  • Создание заказа
  • Удаление заказа
  • Редактирование заказа
  • Выполнение заказа
  • Оплата заказа
  • Изменение оценки риска для заказа
  • Обновление заказа
Товар
  • Создание товара
  • Удаление товара
  • Обновление товара
Возврат платежа
  • Создание возврата платежа
Магазин
  • Обновление магазина
Платёжное средство
  • Создание транзакции с указанием платёжного средства
Тема
  • Создание темы
  • Удаление темы
  • Публикация темы
  • Обновление темы
Транзакция
  • Создание транзакции

Создание вебхуков

Вы можете создать вебхук в любое время. Ваши вебхуки подписываются с помощью ИД, состоящего из уникальной для вашего магазина комбинации букв и цифр.

Шаги:

Рабочий стол
  1. В панели администратора Shopify перейдите в раздел «Настройки» > «Уведомления».

  2. Нажмите «Вебхуки».

  3. Нажмите ⊕ «Создать вебхук».

  4. В выпадающем меню «Событие» выберите любое из поддерживаемых событий вебхуков, которое вы хотите использовать в качестве события для вашего вебхука. После создания вебхука событие изменить нельзя.

  5. В выпадающем меню «Формат» выберите формат, в котором Shopify будет отправлять вам эту информацию. Доступны два варианта: JSON или XML.

  6. В поле URL введите URL-адрес, на который будут отправляться данные. Вебхуки не могут отправляться на следующие URL-адреса:

    • Localhost
    • Любой URL-адрес, заканчивающийся на слово «internal» (например, example.com/internal)
    • Любой URL-адрес с любого пользовательского домена, привязанного к магазину
    • «Поддельные» домены (например, www.example.com)
    • Домены Shopify (например, shopify.com и myshopify.com)
  7. В разделе «Версия API вебхука» выберите предпочтительную версию вебхука.

  8. Нажмите «Сохранить».

Мобильные устройства
  1. В приложении Shopify нажмите Меню, а затем нажмите Настройки Настройки.

  2. В разделе «Настройки магазина» коснитесь «Уведомления».

  3. Коснитесь «Вебхуки».

  4. Коснитесь ⊕ «Создать вебхук».

  5. В выпадающем меню «Событие» выберите любое из поддерживаемых событий вебхуков, которое вы хотите использовать в качестве события для вашего вебхука. После создания вебхука событие изменить нельзя.

  6. В выпадающем меню «Формат» выберите формат, в котором Shopify будет отправлять вам эту информацию. Доступны два варианта: JSON или XML.

  7. В поле URL введите URL-адрес, на который будут отправляться данные. Вебхуки не могут отправляться на следующие URL-адреса:

    • Localhost
    • Любой URL-адрес, заканчивающийся на слово «internal» (например, example.com/internal)
    • Любой URL-адрес с любого пользовательского домена, привязанного к магазину
    • «Поддельные» домены (например, www.example.com)
    • Домены Shopify (например, shopify.com и myshopify.com)
  8. В разделе «Версия API вебхука» выберите предпочтительную версию вебхука.

  9. Коснитесь «Сохранить» или .

После сохранения новый вебхук появится на странице «Вебхуки».

Редактирование вебхуков

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

Шаги:

Рабочий стол
  1. В панели администратора Shopify перейдите в раздел «Настройки» > «Уведомления».

  2. Нажмите «Вебхуки».

  3. В строке с вебхуком, который вы хотите отредактировать, нажмите ... > «Редактировать».

  4. В диалоговом окне «Редактировать вебхук» внесите необходимые изменения.

  5. Нажмите «Сохранить».

Мобильные устройства
  1. В приложении Shopify нажмите Меню, а затем нажмите Настройки Настройки.

  2. В разделе «Настройки магазина» коснитесь «Уведомления».

  3. Коснитесь «Вебхуки».

  4. В строке с вебхуком, который вы хотите отредактировать, коснитесь ... > «Редактировать».

  5. В диалоговом окне «Редактировать вебхук» внесите необходимые изменения.

  6. Коснитесь «Сохранить» или .

Тестирование вебхуков

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

Шаги:

Рабочий стол
  1. В панели администратора Shopify перейдите в раздел «Настройки» > «Уведомления».

  2. Нажмите «Вебхуки».

  3. В строке с вебхуком, который вы хотите протестировать, нажмите ... > «Отправить тест».

  4. Проверьте указанный для вебхука URL-адрес, чтобы убедиться, что уведомление работает.

Мобильные устройства
  1. В приложении Shopify нажмите Меню, а затем нажмите Настройки Настройки.

  2. В разделе «Настройки магазина» коснитесь «Уведомления».

  3. Коснитесь «Вебхуки».

  4. В строке с вебхуком, который вы хотите протестировать, коснитесь ... > «Отправить тест».

  5. Проверьте указанный для вебхука URL-адрес, чтобы убедиться, что уведомление работает.

Удаление вебхуков

Вы можете удалить вебхук в панели администратора Shopify. Это действие необратимо.

Шаги:

Рабочий стол
  1. В панели администратора Shopify перейдите в раздел «Настройки» > «Уведомления».

  2. Нажмите «Вебхуки».

  3. В строке с вебхуком, который вы хотите удалить, нажмите ... > «Удалить».

Мобильные устройства
  1. В приложении Shopify нажмите Меню, а затем нажмите Настройки Настройки.

  2. В разделе «Настройки магазина» коснитесь «Уведомления».

  3. Коснитесь «Вебхуки».

  4. В строке с вебхуком, который вы хотите удалить, коснитесь ... > «Удалить».