Содержание

Автоматическое оповещение сторонних скриптов и сервисов (вебхуки, webhooks)

АвтоВебОфис позволяет автоматически отправлять оповещения о счетах, заявках, контактах, подписках на указанные URL сторонних скриптов и сервисов.

Если API работает по системе запроса пользователя, т.е. инициатором выступаете Вы, то, когда Вы заполняете «URL оповещения», инициатором запроса уже выступаем мы, и как только наступает выбранное событие, например, счет оплачен, шлем POST-запрос, внутри которого содержится сериализованный массив с данными о счете по указанному URL на Вашу страницу со скриптом (который напишет Ваш тех специалист), который будет обрабатывать полученный массив данных.

Переменные можно передавать как GET-параметры. Например: test.ru/webhook.php?email={email}&name={name}

URL для оповещений указывается в разделе Настройки-Оповещение скриптов

Для настройки данного функционала:

  1. Войдите в раздел Настройки зарегистрированного в сервисе АвтоВебОфис аккаунта
  2. В левом боковом меню выберите пункт Настройки→ Вебхуки
  3. В поле «URL для отправки оповещений» нужного блока укажите адрес, на который должны будут отправляться оповещение
  4. Напротив указанной ссылки поставьте галочку



После этого, в случае наступления выбранного события, на указанный Вами «URL для отправки оповещений» будут отправлены методом $_POST следующие данные:

Контакты

По контактам есть 3 типа действий, по которым можно задать отправку уведомлений: создание контакта, изменения в карточке контакта, удаление контакта

ПараметрОписание
id_contactКод контакта
last_nameФамилия
nameИмя
middle_nameОтчество
emailЯщик
passwordПароль от личного кабинета
id_partnerКод партнера
not_to_writeСтоит галочка «Не писать»
spam_clickedСтоит галочка «Жалоба на СПАМ»
spam_clicked_dateДата жалобы на СПАМ
unsubscribe_dateДата отписки
email_not_existЯщик не существует
phone_numberНомер телефона
do_not_callСтоит галочка «Не звонить»
id_countryКод страны
zip_codeИндекс
areaОбласть
cityГород
delivery_addressАдрес доставки
skypeСкайп
banСтоит голчка «Бан»
ban_reasonПричина попадания в бан
sexПол
date_of_birthДата рождения
brief_descriptionОписание
date_registrationДата регистрации
id_employee_responsibleКод ответственного сотрудника
id_employee_createdКод сотрудника, зарегистрировавшего контакт
id_advertising_channel_pageAPI код канала рекламы
advertising_channel_keywordключевое слово
advertising_channel_locationместо размещения
advertising_channel_type_trafficтип трафика
deletedКарточка контакта была удалена
deleted_dateДата удаления контакта
vk_userИдентификатор вКонтакте
fb_userИдентификатор Facebook
datetime_notifyДата отправки уведомления
telegram_user_idid телеграм контакта
telegram_userИмя пользователя телеграм

Пример запроса на изменение контакта 

  Array

( 

  [0] => Array
      (
          [id_contact] => 20076
          [last_name] => 
          [name] => 
          [middle_name] => 
          [email] => alimera.70@mail.ru
          [password] => 455bfa3
          [id_partner] => 0
          [not_to_write] => 0
          [spam_clicked] => 0
          [spam_clicked_date] => 0000-00-00 00:00:00
          [unsubscribe_date] => 0000-00-00 00:00:00
          [email_not_exist] => 0
          [phone_number] => 
          [do_not_call] => 0
          [id_country] => 0
          [zip_code] => 
          [area] => 
          [city] => 
          [delivery_address] => 
          [skype] => 
          [ban] => 0
          [ban_reason] => 
          [sex] => 0
          [date_of_birth] => 0000-00-00
          [brief_description] => 
          [date_registration] => 2021-03-15 14:28:08
          [id_employee_responsible] => 0
          [id_employee_created] => 0
          [deleted] => 0
          [deleted_date] => 0000-00-00 00:00:00
          [vk_user] => 
          [fb_user] => 
          [analytics_cookies] => {"_ga":"GA1.2.1923020967.1571907459","_ym_uid":"1556297658664120224"}
          [roistat] => 
          [vk_user_id] => 
      )
  [1] => Array
      (
          [id_contact] => 20075
          [last_name] => 
          [name] => 
          [middle_name] => 
          [email] => fvioletta@mail.ru
          [password] => c30c926
          [id_partner] => 0
          [not_to_write] => 0
          [spam_clicked] => 0
          [spam_clicked_date] => 0000-00-00 00:00:00
          [unsubscribe_date] => 0000-00-00 00:00:00
          [email_not_exist] => 0
          [phone_number] => 
          [do_not_call] => 0
          [id_country] => 0
          [zip_code] => 
          [area] => 
          [city] => 
          [delivery_address] => 
          [skype] => 
          [ban] => 0
          [ban_reason] => 
          [sex] => 0
          [date_of_birth] => 0000-00-00
          [brief_description] => 
          [date_registration] => 2021-03-15 14:28:07
          [id_employee_responsible] => 0
          [id_employee_created] => 0
          [deleted] => 0
          [deleted_date] => 0000-00-00 00:00:00
          [vk_user] => 
          [fb_user] => 
          [analytics_cookies] => {"_ga":"GA1.2.1923020967.1571907459","_ym_uid":"1556297658664120224"}
          [roistat] => 
          [vk_user_id] => 
      )

)

Счета

По счетам есть 2 типа действий, по которым можно задать отправку уведомлений: создание счета, изменения в счете (например, смена статуса счета на оплачен)

ПараметрОписание
id_accountКод счета
account_numberНомер счета
account_sumОбщая сумма счета
id_account_statusкод статуса счета (1 - создан, 2 - отказ, 3 - в обработке, 4 - ошибка, 5 - оплачен)
close_accountпризнак закрытия счета
id_partnerКод партнера
id_payment_systemКод платежной системы
close_dateдата закрытия счета
date_of_orderдата создания счета
goods_returnпризнак возврата товара
date_of_paymentДата оплаты счета
goods_return_dateДата возврата товара
last_nameфамилия
nameимя
middle_nameотчество
emailящик
phone_numberтелефон
skypeскайп
account_commentкомментарий к счету
id_organizationкод организации
id_delivery_regionкод региона доставки
areaобласть
cityгород
delivery_addressадрес доставки
zip_codeпочтовый индекс
barcodeпочтовый идентификатор
id_delivery_region_methodкод способа доставки для региона
id_advertising_channel_pageAPI код канала рекламы
advertising_channel_keywordключевое слово
advertising_channel_locationместо размещения
advertising_channel_type_trafficтип трафика
deletedсчет удален
vk_userидентификатор вКонтакте
fb_userидентификатор Facebook
id_account_lineкод строки счета
id_goodsкод товара
goodsназвание товара на момент заказа
priceцена
quantityколичество
sum_priceсумма строки счета
vendor_codeкод поставщика
add_fieldsдополнительные поля к заказу
nameназвание дополнительного поля к товару
valueкомментарий, оставленный покупателем в дополнительном поле
link_for_payссылка на выбор способа оплаты
datetime_notifyдата отправки уведомления

Пример запроса о создании счета 

  Array
  (
  [id_account] => 370211
  [account_number] => 289
  [account_sum] => 500
  [id_account_status] => 1
  [close_account] => 0
  [id_partner] => 1
  [id_payment_system] => 0
  [close_date] => 0000-00-00 00:00:00
  [date_of_order] => 2019-02-21 15:29:46
  [goods_return] => 0
  [date_of_payment] => 0000-00-00 00:00:00
  [goods_return_date] => 0000-00-00 00:00:00
  [last_name] => 
  [name] => 
  [middle_name] => 
  [email] => a@gmail.com
  [phone_number] => 
  [skype] => 
  [account_comment] => 
  [id_organization] => 0
  [id_delivery_region] => 0
  [area] => 
  [city] => 
  [delivery_address] => 
  [zip_code] => 
  [barcode] => 
  [id_delivery_region_method] => 0
  [id_advertising_channel_page] => 0
  [advertising_channel_keyword] => 
  [advertising_channel_location] => 
  [advertising_channel_type_traffic] => 
  [id_contact] => 3
  [deleted] => 0
  [vk_user] => 
  [fb_user] => 
  [lines] => Array
      (
          [321] => Array
              (
                  [id_account_line] => 321
                  [id_goods] => 1
                  [goods] => Вязаная игрушка "Котейка"
                  [price] => 500.00
                  [quantity] => 1
                  [sum_price] => 500.00
                  [vendor_code] => 
                  [add_fields] => Array
                      (
                          [0] => Array
                              (
                                  [name] => пожелание
                                  [value] => хочу желтую котейку
                              )
                      )
              )
      )
  [link_for_pay] => https://mila.autoweboffice.ru/?r=ordering/cart/s2&id=370211&vc=1533628675&lg=ru
  [datetime_notify] => 2019-02-21 15:29:46
  )



Пример запроса, который приходит от АвтоВебОфис, при настройке вебхуков в товаре

Настроить можно в разделе «Продажи → Товары → в редактировании товара на вкладке Дополнительно»

Важно! Истории запросов при настройке в товаре система не хранит 

  (
  [id_account] => 113390
  [account_number] => 112216
  [date_of_order] => 2020-12-22 13:56:17
  [date_of_payment] => 2020-12-22 13:56:19
  [id_payment_system] => 0
  [id_account_status] => 5
  [id_contact] => 17103
  [email] => earthmanmail@ya.ru
  [phone_number] => 79035900000
  [last_name] => 
  [name] => Человек на земле
  [middle_name] => 
  [id_country] => 0
  [area] => 
  [city] => 
  [delivery_address] => 
  [skype] => 
  [zip_code] => 
  [id_account_line] => 170408
  [id_goods] => 52
  [goods] => Название товара
  [price] => 0.00
  [quantity] => 1
  [sum_price] => 0.00
  [vendor_code] => 
  [vk_user] => 
  [vk_user_id] => 
  [fb_user] => 
  [hash] => 68076b61409efa3f99b35f5cb7c931e7
  )

Заявки

По заявкам есть 3 типа действий, по которым можно задать отправку уведомлений: создание заявки, изменение заявки, удаление заявки

ПараметрОписание
id_callcenter_requestкод запроса
id_contactкод контакта
callcenter_request_commentкомментарий к запросу
id_callcenter_request_resultкод результата обработки запроса
id_callcenter_request_listsкод списка запросов
id_employeeкод ответственного сотрудника
processedпризнак «Обработан»
id_employee_processedкод обработавшего сотрудника
id_training_lessonsкод обучающего курса
date_next_callдата следующего звонка
creation_dateдата создания
id_accountкод счета
id_callcenter_purpose_callкод цели звонка
id_advertising_channel_pageAPI код канала рекламы
advertising_channel_keywordключевое слово
advertising_channel_locationместо размещения
advertising_channel_type_trafficтип трафика
deletedзаявка удалена
datetime_notifyдата отправки уведомления



Пример запроса о создании заявки 

  Array
  (
  [id_callcenter_request] => 22
  [id_contact] => 203
  [callcenter_request_comment] => 
  [id_callcenter_request_result] => 0
  [id_callcenter_request_lists] => 1
  [id_employee] => 0
  [processed] => 0
  [id_employee_processed] => 0
  [id_training_lessons] => 0
  [date_next_call] => 2019-02-27 12:24:28
  [creation_date] => 2019-02-27 12:24:28
  [id_account] => 0
  [id_callcenter_purpose_call] => 0
  [id_advertising_channel_page] => 0
  [advertising_channel_keyword] => 
  [advertising_channel_location] => 
  [advertising_channel_type_traffic] => 
  [deleted] => 0
  [datetime_notify] => 2019-02-27 12:24:28
  )



Подписка

По подписке есть 2 типа действий, по которым можно задать отправку уведомлений: создание подписки, подтверждение подписки

ПараметрОписание
id_contactкод контакта
id_newsletterкод группы подписчиков
subscribed_dateдата подписки
confirmed
unsubscribedотписался (0-нет, 1-да)
emailящик
newsletterназвание группы подписчиков
datetime_notifyдата отправки уведомления
field_1Дополнительное поле 1
field_2Дополнительное поле 2
field_3Дополнительное поле 3



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

 Array

( 

  [0] => Array
      (
          [id_contact] => 19927
          [email] => upucc@mail.ru
          [id_newsletter] => 15
          [newsletter] => Группа для тестирования импорта
          [id_partner] => 0
          [subscribed_date] => 2021-03-15 12:00:16
          [confirmed] => 1
          [confirmed_date] => 2021-03-15 12:00:16
          [unsubscribed] => 0
      )
  [1] => Array
      (
          [id_contact] => 19928
          [email] => n4talishu@yandex.ru
          [id_newsletter] => 15
          [newsletter] => Группа для тестирования импорта
          [id_partner] => 0
          [subscribed_date] => 2021-03-15 12:00:16
          [confirmed] => 1
          [confirmed_date] => 2021-03-15 12:00:16
          [unsubscribed] => 0
      )

)

Проверка запросов

Внизу на странице настройки оповещений сторонних скриптов раздел «Список последних запросов». Там Вы можете посмотреть все запросы, которые были отправлены на Ваш сервер.

Вы можете зайти в каждый запрос и посмотреть весь отправленный массив, статус отправки (успешно или ошибка) и приема его Вашим сервером и ответ от Вашего сервера

Автоматическое оповещение сторонних скриптов и сервисов (устаревшая версия)


Успехов Вам и до новых встреч!
Служба заботы о клиентах сервиса АвтоВебОфис