Webhook (веб-хуки)

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

Webhook — это скрипт которому отправляется информация о событии.

Например, при создании новой заявки, наш сервер отправит вашему скрипту информацию о ней. Протокол POST. Код ответа должен быть 200 OK.

Это позволяет максимально быстро получать информацию и избавляет от необходимости отслеживать новые заявки/оплаты путём регулярных обращений к API.

Основные поля:

Поле	Описание
event	Тип события
site	Информация о сайте
data	Информация о событии (поля заявки)

Формат данных

1// print_r($_REQUEST);
2[event] => 'lead',
3[site] => Array (
4    [id] => 174911 // id аккаунта
5    [sub_id] => 180023 // id лендинга (группы страниц)
6    [domain] => yourdomain.ru
7    [name] => Лендинг
8)
9[data] => Array (
10    [id] => 1414
11    [num] => 414
12    [time] => 1444215670
13    [status] => Array
14        (
15            [code] => 0
16            [name] => Новая
17        )
18 
19    [client] => Array
20        (
21    // ... и т.д.
22)

Событие lead

Вызывается в момент создания заявки.

Веб-хуку в поле data передаётся информация о заявке.

Отправляемая информация о заявке:

Поле	Описание
id	Уникальный идентификатор
num	Номер заявки
time	timestamp времени создания заявки
status	Code — код статуса, name - название статуса
client	Массив с информацией о клиенте: name, phone, email
note	Заметки
form_name	Название формы заявки
form_data	Содержание полей из формы заявки
page	Страница, с которой отправлена заявка
utm	Содержание UTM меток, если они были.
pay	Информация о счёте/оплате

code — name:

0 — Новая
1 — В работе
2 — Выполнена
10 — Отменена
11 — Удалена

page

url — адрес
name — название

utm

utm_source — источник / рекламная система
utm_campaign — кампания
utm_medium — тип трафика
utm_term — ключевое слово
utm_content — тип объявления
url — полный адрес страницы

pay

id — уникальный индентификатор счёта
summ — сумма к оплате

status (code / name):

0 — Ожидает оплаты
1 — В процессе оплаты
2 — Оплачен
3 — Ошибка оплаты

time_create — timestamp создания счёта
time_done — timestamp оплаты счёта
desc — комментарий для покупателя
test — Флаг — тестовый платёж(через тестовый сервер робокассы)

Событие pay

Вызывается в момент сообщения об оплате или ошибки от эквайринга (Робокасса и т.д.)

Повторяются данные события lead (см. выше). Содержит обновлённые данные об оплате.

Помощь

По вопросам работы API пишите на dev@flexbe.com